Filtering device that applies a clip mask. More...

#include <clip_mask.h>

Inheritance diagram for roo_display::ClipMaskFilter:

Collaboration diagram for roo_display::ClipMaskFilter:

Public Member Functions
	ClipMaskFilter (DisplayOutput &output, const ClipMask *clip_mask, int16_t dx=0, int16_t dy=0)

virtual	~ClipMaskFilter ()

void	setAddress (uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, BlendingMode mode) override
	Set a rectangular window filled by subsequent calls to `write()`.

void	write (Color *color, uint32_t pixel_count) override
	Write pixels into the current address window.

void	fill (Color color, uint32_t pixel_count) override
	Write `pixel_count` copies of the same color into the current address window.

void	writeRects (BlendingMode mode, Color color, int16_t x0, int16_t y0, int16_t x1, int16_t *y1, uint16_t count) override
	Draw the specified rectangles (per-rectangle colors). Invalidates the address window.

void	fillRects (BlendingMode mode, Color color, int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t count) override
	Draw the specified rectangles using the same color. Invalidates the address window.

void	writePixels (BlendingMode mode, Color color, int16_t x, int16_t *y, uint16_t pixel_count) override
	Draw the specified pixels (per-pixel colors). Invalidates the address window.

void	fillPixels (BlendingMode mode, Color color, int16_t x, int16_t y, uint16_t pixel_count) override
	Draw the specified pixels using the same color. Invalidates the address window.

const ColorFormat &	getColorFormat () const override
	Return the native color format used by this device for direct drawing.

void	drawDirectRect (const roo::byte *data, size_t row_width_bytes, int16_t src_x0, int16_t src_y0, int16_t src_x1, int16_t src_y1, int16_t dst_x0, int16_t dst_y0) override
	Draw a rectangle represented in the device's native color format.

Public Member Functions inherited from roo_display::DisplayOutput
virtual	~DisplayOutput ()

virtual void	begin ()
	Enter a write transaction.

virtual void	end ()
	Finalize the previously entered write transaction, flushing any pending writes.

virtual void	flush ()
	Wait until pending asynchronous drawing operations complete.

void	setAddress (const Box &bounds, BlendingMode blending_mode)
	Convenience overload for `setAddress()` using a `Box`.

void	fillRect (BlendingMode blending_mode, const Box &rect, Color color)
	Fill a single rectangle. Invalidates the address window.

void	fillRect (BlendingMode blending_mode, int16_t x0, int16_t y0, int16_t x1, int16_t y1, Color color)
	Fill a single rectangle. Invalidates the address window.

void	fillRect (int16_t x0, int16_t y0, int16_t x1, int16_t y1, Color color)
	Fill a single rectangle using `BlendingMode::kSource`.

virtual void	drawDirectRectAsync (const roo::byte *data, size_t row_width_bytes, int16_t src_x0, int16_t src_y0, int16_t src_x1, int16_t src_y1, int16_t dst_x0, int16_t dst_y0)
	Asynchronous variant of drawDirectRect().

Detailed Description

Filtering device that applies a clip mask.

Definition at line 103 of file clip_mask.h.

Constructor & Destructor Documentation

◆ ClipMaskFilter()

roo_display::ClipMaskFilter::ClipMaskFilter	(	DisplayOutput &	output,
		const ClipMask *	clip_mask,
		int16_t	dx = `0`,
		int16_t	dy = `0`
	)

inline

Definition at line 105 of file clip_mask.h.

◆ ~ClipMaskFilter()

virtual roo_display::ClipMaskFilter::~ClipMaskFilter ( )

inlinevirtual

Definition at line 114 of file clip_mask.h.

Member Function Documentation

◆ drawDirectRect()

void roo_display::ClipMaskFilter::drawDirectRect	(	const roo::byte *	data,
		size_t	row_width_bytes,
		int16_t	src_x0,
		int16_t	src_y0,
		int16_t	src_x1,
		int16_t	src_y1,
		int16_t	dst_x0,
		int16_t	dst_y0
	)

inlineoverridevirtual

Draw a rectangle represented in the device's native color format.

Source data pointer correspond to the (0, 0) point in the source coordinate system, with stride of row_width_bytes. The source rectangle at (src_x0, src_y0, src_x1, src_y1) relative to the data pointer, gets copied to the destination rectangle with top-left corner at (dst_x0, dst_y0). The caller must ensure that the destination rectangle fits within the device's bounds.

The default implementation processes the rectangle by small tiles, converting the data to an array of regular colors, and calling regular window functions to draw them. Specific devices can override this method to provide a more efficient implementation that draws directly from the source data.

Reimplemented from roo_display::DisplayOutput.

Definition at line 209 of file clip_mask.h.

References roo_display::DisplayOutput::drawDirectRect().

◆ fill()

void roo_display::ClipMaskFilter::fill	(	Color	color,
		uint32_t	pixel_count
	)

inlineoverridevirtual

Write pixel_count copies of the same color into the current address window.

The same preconditions as write() apply: the address must be set via setAddress() and not invalidated by any of the write* / fill* methods. Otherwise, the behavior is undefined.

Default implementation falls back to chunked write(). Drivers and filters can override this for a more efficient single-color path.

Reimplemented from roo_display::DisplayOutput.

Definition at line 140 of file clip_mask.h.

References color, roo_display::ClipMask::isMasked(), roo_display::Box::xMax(), and roo_display::Box::xMin().

Referenced by roo_display::FrontToBackWriter::fill().

◆ fillPixels()

void roo_display::ClipMaskFilter::fillPixels	(	BlendingMode	blending_mode,
		Color	color,
		int16_t *	x,
		int16_t *	y,
		uint16_t	pixel_count
	)

inlineoverridevirtual

Draw the specified pixels using the same color. Invalidates the address window.

Parameters

blending_mode	Blending mode used for drawing.
color	The color to use for all pixels.
x	Pointer to x-coordinates for each pixel.
y	Pointer to y-coordinates for each pixel.
pixel_count	Number of pixels.

Implements roo_display::DisplayOutput.

Definition at line 188 of file clip_mask.h.

References color, roo_display::DisplayOutput::fillPixels(), and roo_display::ClipMask::isMasked().

Referenced by roo_display::FrontToBackWriter::fillPixels(), and roo_display::FrontToBackWriter::writePixels().

◆ fillRects()

void roo_display::ClipMaskFilter::fillRects	(	BlendingMode	blending_mode,
		Color	color,
		int16_t *	x0,
		int16_t *	y0,
		int16_t *	x1,
		int16_t *	y1,
		uint16_t	count
	)

inlineoverridevirtual

Draw the specified rectangles using the same color. Invalidates the address window.

Parameters

blending_mode	Blending mode used for drawing.
color	The color to use for all rectangles.
x0	Pointer to left coordinates for each rectangle.
y0	Pointer to top coordinates for each rectangle.
x1	Pointer to right coordinates for each rectangle.
y1	Pointer to bottom coordinates for each rectangle.
count	Number of rectangles.

Implements roo_display::DisplayOutput.

Definition at line 162 of file clip_mask.h.

References color.

◆ getColorFormat()

const ColorFormat & roo_display::ClipMaskFilter::getColorFormat ( ) const

inlineoverridevirtual

Return the native color format used by this device for direct drawing.

Implements roo_display::DisplayOutput.

Definition at line 205 of file clip_mask.h.

References roo_display::DisplayOutput::getColorFormat().

◆ setAddress()

void roo_display::ClipMaskFilter::setAddress	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	x1,
		uint16_t	y1,
		BlendingMode	blending_mode
	)

inlineoverridevirtual

Set a rectangular window filled by subsequent calls to write().

Parameters

x0	Left coordinate (inclusive).
y0	Top coordinate (inclusive).
x1	Right coordinate (inclusive).
y1	Bottom coordinate (inclusive).
blending_mode	Blending mode for subsequent writes.

Implements roo_display::DisplayOutput.

Definition at line 116 of file clip_mask.h.

Referenced by roo_display::FrontToBackWriter::setAddress().

◆ write()

void roo_display::ClipMaskFilter::write	(	Color *	color,
		uint32_t	pixel_count
	)

inlineoverridevirtual

Write pixels into the current address window.

The address must be set via setAddress() and not invalidated by any of the write* / fill* methods. Otherwise, the behavior is undefined.

Parameters

color	Pointer to source pixels.
pixel_count	Number of pixels to write.

Implements roo_display::DisplayOutput.

Definition at line 124 of file clip_mask.h.

References color, roo_display::ClipMask::isMasked(), writer, roo_display::Box::xMax(), and roo_display::Box::xMin().

Referenced by roo_display::FrontToBackWriter::write().

◆ writePixels()

void roo_display::ClipMaskFilter::writePixels	(	BlendingMode	blending_mode,
		Color *	color,
		int16_t *	x,
		int16_t *	y,
		uint16_t	pixel_count
	)

inlineoverridevirtual

Draw the specified pixels (per-pixel colors). Invalidates the address window.

Parameters

blending_mode	Blending mode used for drawing.
color	Pointer to colors for each pixel.
x	Pointer to x-coordinates for each pixel.
y	Pointer to y-coordinates for each pixel.
pixel_count	Number of pixels.

Implements roo_display::DisplayOutput.

Definition at line 169 of file clip_mask.h.

References color, roo_display::ClipMask::isMasked(), and roo_display::DisplayOutput::writePixels().

◆ writeRects()

void roo_display::ClipMaskFilter::writeRects	(	BlendingMode	blending_mode,
		Color *	color,
		int16_t *	x0,
		int16_t *	y0,
		int16_t *	x1,
		int16_t *	y1,
		uint16_t	count
	)

inlineoverridevirtual

Draw the specified rectangles (per-rectangle colors). Invalidates the address window.

Parameters

blending_mode	Blending mode used for drawing.
color	Pointer to colors for each rectangle.
x0	Pointer to left coordinates for each rectangle.
y0	Pointer to top coordinates for each rectangle.
x1	Pointer to right coordinates for each rectangle.
y1	Pointer to bottom coordinates for each rectangle.
count	Number of rectangles.

Implements roo_display::DisplayOutput.

Definition at line 155 of file clip_mask.h.

References color.

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

temp_repos/roo_display/src/roo_display/filter/clip_mask.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ClipMaskFilter()

◆ ~ClipMaskFilter()

Member Function Documentation

◆ drawDirectRect()

◆ fill()

◆ fillPixels()

◆ fillRects()

◆ getColorFormat()

◆ setAddress()

◆ write()

◆ writePixels()

◆ writeRects()