AbstractPainterBW
The AbstractPainterBW class is an abstract class for creating a painter to draw on a BW display using CanvasWidgetRenderer. Pixels are either set or removed.
See: AbstractPainter
Inherits from: AbstractPainter
Inherited by: PainterBW, PainterBWBitmap
Public Functions
AbstractPainterBW() | |
virtual void | render(uint8_t ptr, int x, int xAdjust, int y, unsigned count, const uint8_t covers) |
Paint a designated part of the RenderingBuffer with respect to the amount of coverage of each pixel given by the parameter covers. | |
Protected Functions
virtual bool | renderInit() |
Initialize rendering of a single scan line of pixels for the render. | |
virtual bool | renderNext(uint8_t & color) =0 |
Get the color of the next pixel in the scan line to blend into the framebuffer. | |
Protected Attributes
uint16_t | currentX |
Current x coordinate relative to the widget. | |
uint16_t | currentY |
Current y coordinate relative to the widget. | |
Additional inherited members
Public Functions inherited from AbstractPainter
AbstractPainter() | |
Initializes a new instance of the AbstractPainter class. | |
void | setOffset(uint16_t offsetX, uint16_t offsetY) |
Sets the offset of the area being drawn. | |
virtual | ~AbstractPainter() |
Finalizes an instance of the AbstractPainter class. | |
Protected Functions inherited from AbstractPainter
void | setWidgetAlpha(const uint8_t alpha) |
Sets the widget alpha to allow an entire canvas widget to easily be faded without changing the painter of the widget. | |
FORCE_INLINE_FUNCTION bool | compatibleFramebuffer(Bitmap::BitmapFormat format) |
Helper function to check if the provided bitmap format matches the current framebuffer format. | |
Protected Attributes inherited from AbstractPainter
int16_t | areaOffsetX |
The offset x coordinate of the area being drawn. | |
int16_t | areaOffsetY |
The offset y coordinate of the area being drawn. | |
uint8_t | widgetAlpha |
The alpha of the widget using the painter. | |
Public Functions Documentation
AbstractPainterBW
render
virtual void render | ( | uint8_t * | ptr , | ||
int | x , | ||||
int | xAdjust , | ||||
int | y , | ||||
unsigned | count , | ||||
const uint8_t * | covers | ||||
) |
Paint a designated part of the RenderingBuffer with respect to the amount of coverage of each pixel given by the parameter covers.
The cover is the alpha for each pixel, which is what makes it possible to have smooth anti-aliased edges on the shapes drawn with CanvasWidgetRenderer.
ptr | Pointer to the row in the RenderingBuffer. |
x | The x coordinate. |
xAdjust | The minor adjustment of x (used when a pixel is smaller than a byte to specify that the ptr should have been advanced "xAdjust" pixels futher into the byte). |
y | The y coordinate. |
count | Number of pixels to fill. |
covers | The coverage in of each pixel. |
Note
The implementation of render() in the AbstractPainter classes is a generic (i.e. slow) implementation that should be completely implemented in subclasses of AbstractPainter for better performance.
Reimplements: touchgfx::AbstractPainter::render
Reimplemented by: touchgfx::PainterBW::render, touchgfx::PainterBWBitmap::render
Protected Functions Documentation
renderInit
virtual bool renderInit | ( | ) |
Initialize rendering of a single scan line of pixels for the render.
If renderInit returns false, the scanline will not be rendered.
true if it succeeds, false if it fails.
Reimplemented by: touchgfx::PainterBWBitmap::renderInit
renderNext
virtual bool renderNext | ( | uint8_t & | color | ) | |
Get the color of the next pixel in the scan line to blend into the framebuffer.
color | The color (0 or 1). |
true if the pixel should be painted, false otherwise.
Reimplemented by: touchgfx::PainterBW::renderNext, touchgfx::PainterBWBitmap::renderNext
Protected Attributes Documentation
currentX
uint16_t currentX
Current x coordinate relative to the widget.
currentY
uint16_t currentY
Current y coordinate relative to the widget.