PainterRGB888

touchgfx/widgets/canvas/PainterRGB888.hpp

The PainterRGB888 class allows a shape to be filled with a given color value. This allows anti-aliased elements to be drawn.

See: AbstractPainter

Inherits from: AbstractPainterRGB888, AbstractPainterColor, AbstractPainter

Public Functions

virtual HAL::RenderingMethod	getRenderingMethod() const
	Return the applicable rendering method of the painter.
virtual void	paint(uint8_t * destination, int16_t offset, int16_t widgetX, int16_t widgetY, int16_t count, uint8_t alpha) const
	Paints a streak of pixels (all with the same alpha) in the framebuffer.
	PainterRGB888(colortype color =0)
	Initializes a new instance of the PainterRGB888 class.
virtual void	setColor(colortype color)
	Sets color to use when drawing the CanvasWidget.
virtual void	tearDown() const
	This function is called after all paint operation have finished.

Protected Attributes

uint8_t	painterBlue
	The blue part of the color.
uint8_t	painterGreen
	The green part of the color.
uint8_t	painterRed
	The red part of the color.

Additional inherited members

Public Functions inherited from AbstractPainterRGB888

	AbstractPainterRGB888()

Public Functions inherited from AbstractPainterColor

	AbstractPainterColor(colortype color =0)
	Constructor.
colortype	getColor() const
	Gets the current color.
virtual	~AbstractPainterColor()
	Destructor.

Protected Attributes inherited from AbstractPainterColor

colortype	painterColor
	The color.

Public Functions inherited from AbstractPainter

	AbstractPainter()
	Initializes a new instance of the AbstractPainter class.
void	framebufferToDisplay(int16_t & widgetX, int16_t & widgetY) const
	Convert Framebuffer widget coordinates to display widget coordinates.
virtual bool	setup(const Rect & widgetRect) const
	This function is called before any actual paint operation is started.
virtual	~AbstractPainter()
	Finalizes an instance of the AbstractPainter class.

Protected Functions inherited from AbstractPainter

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	widgetWidth
	The width of the widget on screen, used by framebufferToDisplay()

Public Functions Documentation

getRenderingMethod

virtual HAL::RenderingMethod getRenderingMethod	(			)	const

Return the applicable rendering method of the painter.

HARDWARE if the painter uses hardware based drawing, SOFTWARE otherwise. Relevant on platforms using DCACHE.

Returns:

HARDWARE if painter uses hardware based drawing, SOFTWARE otherwise.

Reimplements: touchgfx::AbstractPainter::getRenderingMethod

paint

virtual void paint	(	uint8_t *	destination ,		const
		int16_t	offset ,		const
		int16_t	widgetX ,		const
		int16_t	widgetY ,		const
		int16_t	count ,		const
		uint8_t	alpha		const
		)	const

Paints a streak of pixels (all with the same alpha) in the framebuffer.

The first pixel to paint is at 'offset' relative to 'destination' (to be able to support 1bpp, 2bpp and 4bpp). The first pixel to paint is at the given 'widgetX', 'widgetY' coordinate. The number of pixels to paint is 'count' and the alpha to apply is 'alpha'.

Note that the widgetX, widgetY is relative to the widget in the framebuffer, not the display. To convert the coordinate to display widget coordinates, use framebufferToDisplay().

Parameters:

destination	If non-null, the pointer.
offset	The offset to add to the destination.
widgetX	The widget x coordinate.
widgetY	The widget y coordinate.
count	Number of pixels.
alpha	The alpha of the pixels.

See also:

AbstractPainter::setup, AbstractPainter::tearDown, AbstractPainter::framebufferToDisplay

Reimplements: touchgfx::AbstractPainter::paint

PainterRGB888

PainterRGB888	(	colortype	color =0	)

Initializes a new instance of the PainterRGB888 class.

Parameters:

color	(Optional) the color, default is black.

setColor

virtual void setColor	(	colortype	color	)

Sets color to use when drawing the CanvasWidget.

Parameters:

color	The color.

Reimplements: touchgfx::AbstractPainterColor::setColor

tearDown

virtual void tearDown	(			)	const

This function is called after all paint operation have finished.

This allows the painter to close down dma queues etc. This happens after the last scan line segment has been drawn.

See also:

AbstractPainter::paint, AbstractPainter::setup

Reimplements: touchgfx::AbstractPainter::tearDown

Protected Attributes Documentation

painterBlue

uint8_t painterBlue

The blue part of the color.

painterGreen

uint8_t painterGreen

The green part of the color.

painterRed

uint8_t painterRed

The red part of the color.