Skip to main content
Version: 4.16

PainterRGBA2222Bitmap

PainterRGBA2222Bitmap will take the color for a given point in the shape from a bitmap. Please be aware, the the bitmap is used by the CanvasWidgetRenderer (not Shape), so any rotation you might specify for a CanvasWidget (e.g. Shape) is not applied to the bitmap as CWR is not aware of this rotation.

See: AbstractPainter

Inherits from: AbstractPainterRGBA2222, AbstractPainter

Public Functions#

PainterRGBA2222Bitmap(const Bitmap & bmp =Bitmap(BITMAP_INVALID), uint8_t alpha =255)
Initializes a new instance of the PainterRGBA2222Bitmap class.
virtual voidrender(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.
voidsetBitmap(const Bitmap & bmp)
Sets a bitmap to be used when drawing the CanvasWidget.

Protected Functions#

virtual boolrenderInit()
Initialize rendering of a single scan line of pixels for the render.
virtual boolrenderNext(uint8_t & red, uint8_t & green, uint8_t & blue, uint8_t & alpha)
Get the color of the next pixel in the scan line to blend into the framebuffer.

Protected Attributes#

Bitmapbitmap
The bitmap to be used when painting.
RectbitmapRectToFrameBuffer
Bitmap rectangle translated to framebuffer coordinates.
const uint8_t *bitmapRGBA2222Pointer
Pointer to the bitmap (RGBA2222)

Additional inherited members#

Public Functions inherited from AbstractPainterRGBA2222#

AbstractPainterRGBA2222()
FORCE_INLINE_FUNCTION uint8_tmixColors(uint8_t newpix, uint8_t bufpix, uint8_t alpha)
Mix colors from a new pixel and a buffer pixel with the given alpha applied to the new pixel, and the inverse alpha applied to the buffer pixel.
FORCE_INLINE_FUNCTION uint8_tmixColors(uint8_t R, uint8_t G, uint8_t B, uint8_t bufpix, uint8_t alpha)
Mix colors from a new pixel and a buffer pixel with the given alpha applied to the new pixel, and the inverse alpha applied to the buffer pixel.

Protected Functions inherited from AbstractPainterRGBA2222#

virtual voidrenderPixel(uint8_t * p, uint8_t red, uint8_t green, uint8_t blue)
Renders (writes) the specified color into the framebuffer.

Protected Attributes inherited from AbstractPainterRGBA2222#

intcurrentX
Current x coordinate relative to the widget.
intcurrentY
Current y coordinate relative to the widget.

Public Functions inherited from AbstractPainter#

AbstractPainter()
Initializes a new instance of the AbstractPainter class.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
voidsetOffset(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#

voidsetWidgetAlpha(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 boolcompatibleFramebuffer(Bitmap::BitmapFormat format)
Helper function to check if the provided bitmap format matches the current framebuffer format.

Protected Attributes inherited from AbstractPainter#

int16_tareaOffsetX
The offset x coordinate of the area being drawn.
int16_tareaOffsetY
The offset y coordinate of the area being drawn.
uint8_tpainterAlpha
The alpha value for the painter.
uint8_twidgetAlpha
The alpha of the widget using the painter.

Public Functions Documentation#

PainterRGBA2222Bitmap#

PainterRGBA2222Bitmap(const Bitmap &bmp =Bitmap(BITMAP_INVALID),
uint8_talpha =255
)

Initializes a new instance of the PainterRGBA2222Bitmap class.

Parameters:
bmp(Optional) The bitmap, default is BITMAP_INVALID.
alpha(Optional) the alpha, default is 255 i.e. solid.

render#

virtual void render(uint8_t *ptr ,
intx ,
intxAdjust ,
inty ,
unsignedcount ,
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.

Parameters:
ptrPointer to the row in the RenderingBuffer.
xThe x coordinate.
xAdjustThe 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).
yThe y coordinate.
countNumber of pixels to fill.
coversThe 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::AbstractPainterRGBA2222::render

setBitmap#

void setBitmap(const Bitmap &bmp)

Sets a bitmap to be used when drawing the CanvasWidget.

Parameters:
bmpThe bitmap.

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.

Returns:

true if it succeeds, false if it fails.

Reimplements: touchgfx::AbstractPainterRGBA2222::renderInit

renderNext#

virtual bool renderNext(uint8_t &red ,
uint8_t &green ,
uint8_t &blue ,
uint8_t &alpha
)

Get the color of the next pixel in the scan line to blend into the framebuffer.

Parameters:
redThe red.
greenThe green.
blueThe blue.
alphaThe alpha.
Returns:

true if the pixel should be painted, false otherwise.

Reimplements: touchgfx::AbstractPainterRGBA2222::renderNext

Protected Attributes Documentation#

bitmap#

Bitmap bitmap

The bitmap to be used when painting.

bitmapRectToFrameBuffer#

Rect bitmapRectToFrameBuffer

Bitmap rectangle translated to framebuffer coordinates.

bitmapRGBA2222Pointer#

const uint8_t * bitmapRGBA2222Pointer

Pointer to the bitmap (RGBA2222)