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

Infinite transparent area. More...

#include <roo_display.h>

Inheritance diagram for roo_display::Clear:
[legend]
Collaboration diagram for roo_display::Clear:
[legend]

Public Member Functions

 Clear ()
 Constructs a clear fill.
 
Box extents () const override
 Return the bounding box encompassing all pixels that need to be drawn.
 
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.
 
- 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< PixelStreamcreateStream () const override
 Default createStream() using readColors().
 
std::unique_ptr< PixelStreamcreateStream (const Box &bounds) const override
 Default createStream() for a clipped box using readColors().
 
- Public Member Functions inherited from roo_display::Streamable
virtual TransparencyMode getTransparencyMode () const
 Return the transparency mode for pixels in this stream.
 
- Public Member Functions inherited from roo_display::Drawable
virtual ~Drawable ()
 
virtual Box anchorExtents () const
 Return the bounds used for alignment.
 

Additional Inherited Members

- Static Public Member Functions inherited from roo_display::Drawable
static const DrawableEmpty ()
 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

Infinite transparent area.

When drawn, it fills the entire clip box with the color implied by the background settings.

Definition at line 467 of file roo_display.h.

Constructor & Destructor Documentation

◆ Clear()

roo_display::Clear::Clear ( )
inline

Constructs a clear fill.

Definition at line 470 of file roo_display.h.

Member Function Documentation

◆ extents()

Box roo_display::Clear::extents ( ) const
inlineoverridevirtual

Return the bounding box encompassing all pixels that need to be drawn.

This method is called during a transaction and must not block or perform I/O.

Implements roo_display::Drawable.

Definition at line 472 of file roo_display.h.

References roo_display::Box::MaximumBox().

◆ readColorRect()

bool roo_display::Clear::readColorRect ( int16_t  xMin,
int16_t  yMin,
int16_t  xMax,
int16_t  yMax,
Color result 
) const
overridevirtual

Read colors for a rectangle.

Returns true if all colors are identical (then only result[0] is valid). The caller must ensure the rectangle is within bounds.

Reimplemented from roo_display::Rasterizable.

Definition at line 283 of file roo_display.cpp.

◆ readColors()

void roo_display::Clear::readColors ( const int16_t x,
const int16_t y,
uint32_t  count,
Color result 
) const
overridevirtual

Read colors for the given points.

The caller must ensure all points are within bounds.

Implements roo_display::Rasterizable.

Definition at line 278 of file roo_display.cpp.

References roo_display::FillColor().


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