roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
Public Member Functions
roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order > Class Template Reference

#include <raster.h>

Inheritance diagram for roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >:
[legend]
Collaboration diagram for roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >:
[legend]

Public Member Functions

 ProgMemRaster (int16_t width, int16_t height, const uint8_t *PROGMEM ptr, const ColorMode &color_mode=ColorMode())
 
 ProgMemRaster (int16_t width, int16_t height, Box extents, const uint8_t *PROGMEM ptr, const ColorMode &color_mode=ColorMode())
 
 ProgMemRaster (Box extents, const uint8_t *PROGMEM ptr, const ColorMode &color_mode=ColorMode())
 
 ProgMemRaster (Box extents, Box anchor_extents, const uint8_t *PROGMEM ptr, const ColorMode &color_mode=ColorMode())
 
- Public Member Functions inherited from roo_display::Raster< PtrTypeT, ColorModeT, pixel_order, byte_order >
 Raster (int16_t width, int16_t height, PtrTypeT ptr, const ColorMode &color_mode=ColorMode())
 Construct a raster for a width/height buffer.
 
 Raster (int16_t width, int16_t height, Box extents, PtrTypeT ptr, const ColorMode &color_mode=ColorMode())
 Construct a raster with custom extents and buffer dimensions.
 
 Raster (Box extents, PtrTypeT ptr, const ColorMode &color_mode=ColorMode())
 Construct a raster with extents and a buffer pointer.
 
 Raster (Box extents, Box anchor_extents, PtrTypeT ptr, const ColorMode &color_mode=ColorMode())
 Construct a raster with extents and anchor extents.
 
Box extents () const override
 Return the bounding box encompassing all pixels that need to be drawn.
 
Box anchorExtents () const override
 Return the bounds used for alignment.
 
ColorMode & color_mode ()
 
const ColorMode & color_mode () const
 
std::unique_ptr< StreamType > createRawStream () const
 
std::unique_ptr< PixelStream > createStream () const override
 Create a stream covering the full extents().
 
std::unique_ptr< PixelStream > createStream (const Box &bounds) const override
 Create a stream for the given clipped bounds.
 
void readColors (const int16_t *x, const int16_t *y, uint32_t count, Color *result) const override
 Read colors for the given points.
 
bool readColorRect (int16_t xMin, int16_t yMin, int16_t xMax, int16_t yMax, Color *result) const override
 Read colors for a rectangle.
 
TransparencyMode getTransparencyMode () const override
 Return the transparency mode for pixels in this stream.
 
TransparencyMode transparency () const
 
Color get (int16_t x, int16_t y) const
 
const PtrType buffer () const
 
- Public Member Functions inherited from roo_display::Rasterizable
void readColorsMaybeOutOfBounds (const int16_t *x, const int16_t *y, uint32_t count, Color *result, Color out_of_bounds_color=color::Transparent) const
 Read colors for points that may be out of bounds.
 
std::unique_ptr< PixelStream > createStream () const override
 Default createStream() using readColors().
 
std::unique_ptr< PixelStream > createStream (const Box &bounds) const override
 Default createStream() for a clipped box using readColors().
 
- Public Member Functions inherited from roo_display::Drawable
virtual ~Drawable ()
 

Additional Inherited Members

- Public Types inherited from roo_display::Raster< PtrTypeT, ColorModeT, pixel_order, byte_order >
using ColorMode = ColorModeT
 
using PtrType = typename internal::PtrTypeResolver< PtrTypeT >::PtrType
 
using StreamType = RasterPixelStream< roo_io::UnsafeGenericMemoryIterable< PtrType >, ColorMode, pixel_order, byte_order >
 
using Reader = internal::Reader< ColorMode, pixel_order, byte_order >
 
- Static Public Member Functions inherited from roo_display::Drawable
static const Drawable * Empty ()
 A singleton representing a no-op drawable with no bounding box.
 
- Protected Member Functions inherited from roo_display::Rasterizable
void drawTo (const Surface &s) const override
 Default drawTo() using readColors().
 

Detailed Description

template<typename ColorMode, ColorPixelOrder pixel_order = ColorPixelOrder::kMsbFirst, ByteOrder byte_order = roo_io::kBigEndian>
class roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >

Definition at line 475 of file raster.h.

Constructor & Destructor Documentation

◆ ProgMemRaster() [1/4]

template<typename ColorMode , ColorPixelOrder pixel_order = ColorPixelOrder::kMsbFirst, ByteOrder byte_order = roo_io::kBigEndian>
roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >::ProgMemRaster ( int16_t  width,
int16_t  height,
const uint8_t *PROGMEM  ptr,
const ColorMode &  color_mode = ColorMode() 
)
inline

Definition at line 481 of file raster.h.

◆ ProgMemRaster() [2/4]

template<typename ColorMode , ColorPixelOrder pixel_order = ColorPixelOrder::kMsbFirst, ByteOrder byte_order = roo_io::kBigEndian>
roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >::ProgMemRaster ( int16_t  width,
int16_t  height,
Box  extents,
const uint8_t *PROGMEM  ptr,
const ColorMode &  color_mode = ColorMode() 
)
inline

Definition at line 486 of file raster.h.

◆ ProgMemRaster() [3/4]

template<typename ColorMode , ColorPixelOrder pixel_order = ColorPixelOrder::kMsbFirst, ByteOrder byte_order = roo_io::kBigEndian>
roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >::ProgMemRaster ( Box  extents,
const uint8_t *PROGMEM  ptr,
const ColorMode &  color_mode = ColorMode() 
)
inline

Definition at line 493 of file raster.h.

◆ ProgMemRaster() [4/4]

template<typename ColorMode , ColorPixelOrder pixel_order = ColorPixelOrder::kMsbFirst, ByteOrder byte_order = roo_io::kBigEndian>
roo_display::ProgMemRaster< ColorMode, pixel_order, byte_order >::ProgMemRaster ( Box  extents,
Box  anchor_extents,
const uint8_t *PROGMEM  ptr,
const ColorMode &  color_mode = ColorMode() 
)
inline

Definition at line 498 of file raster.h.

The documentation for this class was generated from the following file: