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

Angular gradient based on angle around center. More...

#include <gradient.h>

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

Public Member Functions

 AngularGradient (FpPoint center, ColorGradient gradient, Box extents=Box::MaximumBox())
 Create an angular gradient.
 
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.
 
- 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.
 
virtual bool readColorRect (int16_t xMin, int16_t yMin, int16_t xMax, int16_t yMax, Color *result) const
 Read colors for a rectangle.
 
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

Angular gradient based on angle around center.

Definition at line 163 of file gradient.h.

Constructor & Destructor Documentation

◆ AngularGradient()

roo_display::AngularGradient::AngularGradient ( FpPoint  center,
ColorGradient  gradient,
Box  extents = Box::MaximumBox() 
)

Create an angular gradient.

Gradient values are interpreted from $-\pi$ (South) through $0$ (North) to $\pi$ (South). For other angle conventions, use a periodic gradient.

Definition at line 223 of file gradient.cpp.

Member Function Documentation

◆ extents()

Box roo_display::AngularGradient::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 173 of file gradient.h.

◆ readColors()

void roo_display::AngularGradient::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 230 of file gradient.cpp.

References roo_display::ColorGradient::getColor().


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