roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
roo_display::StreamableStack::Input Class Reference

An input layer in the stack. More...

#include <streamable_stack.h>

Public Member Functions

 Input (const Streamable *obj, Box extents)
 Create an input layer using the source extents.
 
 Input (const Streamable *obj, Box extents, uint16_t dx, uint16_t dy)
 Create an input layer with an offset.
 
const Boxextents () const
 Return extents in stack coordinates.
 
int16_t dx () const
 X offset applied to the input.
 
int16_t dy () const
 Y offset applied to the input.
 
std::unique_ptr< PixelStreamcreateStream (const Box &extents) const
 Create a stream for the given extents in stack coordinates.
 
InputwithMode (BlendingMode mode)
 Set blending mode for this input.
 
BlendingMode blending_mode () const
 Return blending mode for this input.
 

Detailed Description

An input layer in the stack.

Definition at line 15 of file streamable_stack.h.

Constructor & Destructor Documentation

◆ Input() [1/2]

roo_display::StreamableStack::Input::Input ( const Streamable obj,
Box  extents 
)
inline

Create an input layer using the source extents.

Definition at line 18 of file streamable_stack.h.

◆ Input() [2/2]

roo_display::StreamableStack::Input::Input ( const Streamable obj,
Box  extents,
uint16_t  dx,
uint16_t  dy 
)
inline

Create an input layer with an offset.

Definition at line 26 of file streamable_stack.h.

Member Function Documentation

◆ blending_mode()

BlendingMode roo_display::StreamableStack::Input::blending_mode ( ) const
inline

Return blending mode for this input.

Definition at line 53 of file streamable_stack.h.

◆ createStream()

std::unique_ptr< PixelStream > roo_display::StreamableStack::Input::createStream ( const Box extents) const
inline

Create a stream for the given extents in stack coordinates.

Definition at line 42 of file streamable_stack.h.

References roo_display::Streamable::createStream(), extents(), and roo_display::Box::translate().

◆ dx()

int16_t roo_display::StreamableStack::Input::dx ( ) const
inline

X offset applied to the input.

Definition at line 37 of file streamable_stack.h.

◆ dy()

int16_t roo_display::StreamableStack::Input::dy ( ) const
inline

Y offset applied to the input.

Definition at line 39 of file streamable_stack.h.

◆ extents()

const Box & roo_display::StreamableStack::Input::extents ( ) const
inline

Return extents in stack coordinates.

Definition at line 34 of file streamable_stack.h.

Referenced by createStream().

◆ withMode()

Input & roo_display::StreamableStack::Input::withMode ( BlendingMode  mode)
inline

Set blending mode for this input.

Definition at line 47 of file streamable_stack.h.


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