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

Pixel stream that reads from a raw byte resource. More...

#include <raster.h>

Inheritance diagram for roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >:
[legend]
Collaboration diagram for roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >:
[legend]

Public Member Functions

 RasterPixelStream (StreamType< Resource > stream, const ColorMode &color_mode)
 
void Read (Color *buf, uint16_t size) override
 Read up to size pixels into buf.
 
void Skip (uint32_t count) override
 Skip count pixels.
 
Color next ()
 
void skip (uint32_t count)
 
TransparencyMode transparency () const
 
const ColorMode & color_mode () const
 
- Public Member Functions inherited from roo_display::PixelStream
virtual ~PixelStream ()
 

Detailed Description

template<typename Resource, typename ColorMode, ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
class roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >

Pixel stream that reads from a raw byte resource.

Default implementation for color modes with multiple pixels per byte. The resource is interpreted as a non-compressed stream of consecutive pixels. Line/column semantics are handled by the caller.

Definition at line 77 of file raster.h.

Constructor & Destructor Documentation

◆ RasterPixelStream()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::RasterPixelStream ( StreamType< Resource >  stream,
const ColorMode &  color_mode 
)
inline

Definition at line 79 of file raster.h.

Member Function Documentation

◆ color_mode()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
const ColorMode & roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::color_mode ( ) const
inline

Definition at line 122 of file raster.h.

◆ next()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
Color roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::next ( )
inline

Definition at line 93 of file raster.h.

Referenced by roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::Read(), and roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, 1 >::Read().

◆ Read()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
void roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::Read ( Color *  buf,
uint16_t  size 
)
inlineoverridevirtual

Read up to size pixels into buf.

Implements roo_display::PixelStream.

Definition at line 84 of file raster.h.

References roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::next().

◆ skip()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
void roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::skip ( uint32_t  count)
inline

Definition at line 101 of file raster.h.

Referenced by roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::Skip(), and roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, 1 >::Skip().

◆ Skip()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
void roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::Skip ( uint32_t  count)
inlineoverridevirtual

Skip count pixels.

Reimplemented from roo_display::PixelStream.

Definition at line 90 of file raster.h.

References roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::skip().

◆ transparency()

template<typename Resource , typename ColorMode , ColorPixelOrder pixel_order, ByteOrder byte_order, int pixels_per_byte = ColorTraits<ColorMode>::pixels_per_byte>
TransparencyMode roo_display::RasterPixelStream< Resource, ColorMode, pixel_order, byte_order, pixels_per_byte >::transparency ( ) const
inline

Definition at line 120 of file raster.h.

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