roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
Public Member Functions
roo_display::SimpleStreamable< Iterable, ColorMode, StreamType > Class Template Reference

Convenience wrapper for images backed by a byte stream. More...

#include <streamable.h>

Inheritance diagram for roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >:
[legend]
Collaboration diagram for roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >:
[legend]

Public Member Functions

 SimpleStreamable (int16_t width, int16_t height, Iterable resource, const ColorMode &color_mode=ColorMode())
 Construct from width/height and a resource.
 
 SimpleStreamable (Box extents, Iterable resource, const ColorMode &color_mode=ColorMode())
 Construct from extents and a resource.
 
 SimpleStreamable (Box extents, Box anchor_extents, Iterable resource, const ColorMode &color_mode=ColorMode())
 Construct from extents, anchor extents, and a resource.
 
void setColorMode (const ColorMode &color_mode)
 Set the color mode.
 
Box extents () const override
 Return extents of the image.
 
Box anchorExtents () const override
 Return anchor extents used for alignment.
 
const Iterable & resource () const
 Access underlying resource.
 
const ColorMode & color_mode () const
 Access color mode (const).
 
ColorMode & color_mode ()
 Access color mode (mutable).
 
std::unique_ptr< PixelStream > createStream () const override
 Create a pixel stream for the full extents.
 
std::unique_ptr< PixelStream > createStream (const Box &bounds) const override
 Create a pixel stream for a clipped box.
 
std::unique_ptr< StreamType > createRawStream () const
 Create the raw stream type.
 
TransparencyMode getTransparencyMode () const override
 Return transparency mode derived from color mode.
 
- Public Member Functions inherited from roo_display::Drawable
virtual ~Drawable ()
 

Additional Inherited Members

- Static Public Member Functions inherited from roo_display::Drawable
static const Drawable * Empty ()
 A singleton representing a no-op drawable with no bounding box.
 

Detailed Description

template<typename Iterable, typename ColorMode, typename StreamType>
class roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >

Convenience wrapper for images backed by a byte stream.

Definition at line 464 of file streamable.h.

Constructor & Destructor Documentation

◆ SimpleStreamable() [1/3]

template<typename Iterable , typename ColorMode , typename StreamType >
roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::SimpleStreamable ( int16_t  width,
int16_t  height,
Iterable  resource,
const ColorMode &  color_mode = ColorMode() 
)
inline

Construct from width/height and a resource.

Definition at line 467 of file streamable.h.

◆ SimpleStreamable() [2/3]

template<typename Iterable , typename ColorMode , typename StreamType >
roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::SimpleStreamable ( Box  extents,
Iterable  resource,
const ColorMode &  color_mode = ColorMode() 
)
inline

Construct from extents and a resource.

Definition at line 473 of file streamable.h.

◆ SimpleStreamable() [3/3]

template<typename Iterable , typename ColorMode , typename StreamType >
roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::SimpleStreamable ( Box  extents,
Box  anchor_extents,
Iterable  resource,
const ColorMode &  color_mode = ColorMode() 
)
inline

Construct from extents, anchor extents, and a resource.

Definition at line 478 of file streamable.h.

Member Function Documentation

◆ anchorExtents()

template<typename Iterable , typename ColorMode , typename StreamType >
Box roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::anchorExtents ( ) const
inlineoverridevirtual

Return anchor extents used for alignment.

Reimplemented from roo_display::Drawable.

Definition at line 492 of file streamable.h.

◆ color_mode() [1/2]

template<typename Iterable , typename ColorMode , typename StreamType >
ColorMode & roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::color_mode ( )
inline

Access color mode (mutable).

Definition at line 499 of file streamable.h.

◆ color_mode() [2/2]

template<typename Iterable , typename ColorMode , typename StreamType >
const ColorMode & roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::color_mode ( ) const
inline

Access color mode (const).

Definition at line 497 of file streamable.h.

Referenced by roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::setColorMode().

◆ createRawStream()

template<typename Iterable , typename ColorMode , typename StreamType >
std::unique_ptr< StreamType > roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::createRawStream ( ) const
inline

Create the raw stream type.

Definition at line 514 of file streamable.h.

◆ createStream() [1/2]

template<typename Iterable , typename ColorMode , typename StreamType >
std::unique_ptr< PixelStream > roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::createStream ( ) const
inlineoverridevirtual

Create a pixel stream for the full extents.

Implements roo_display::Streamable.

Definition at line 502 of file streamable.h.

◆ createStream() [2/2]

template<typename Iterable , typename ColorMode , typename StreamType >
std::unique_ptr< PixelStream > roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::createStream ( const Box &  bounds) const
inlineoverridevirtual

Create a pixel stream for a clipped box.

Implements roo_display::Streamable.

Definition at line 508 of file streamable.h.

References roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::extents(), and roo_display::SubRectangle().

◆ extents()

template<typename Iterable , typename ColorMode , typename StreamType >
Box roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::extents ( ) const
inlineoverridevirtual

Return extents of the image.

Implements roo_display::Drawable.

Definition at line 489 of file streamable.h.

Referenced by roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::createStream().

◆ getTransparencyMode()

template<typename Iterable , typename ColorMode , typename StreamType >
TransparencyMode roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::getTransparencyMode ( ) const
inlineoverridevirtual

Return transparency mode derived from color mode.

Reimplemented from roo_display::Streamable.

Definition at line 520 of file streamable.h.

◆ resource()

template<typename Iterable , typename ColorMode , typename StreamType >
const Iterable & roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::resource ( ) const
inline

Access underlying resource.

Definition at line 495 of file streamable.h.

◆ setColorMode()

template<typename Iterable , typename ColorMode , typename StreamType >
void roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::setColorMode ( const ColorMode &  color_mode)
inline

Set the color mode.

Definition at line 486 of file streamable.h.

References roo_display::SimpleStreamable< Iterable, ColorMode, StreamType >::color_mode().

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