#include <Canvas.h>

Inheritance diagram for DRAM_Canvas:

Public Member Functions
	DRAM_Canvas (const Canvas &srcCanvas)
	Constructor that makes a full copy of `srcCanvas`.

	DRAM_Canvas (const Canvas &srcCanvas, const Block_Image imgBlock)
	Constructor that copies a subset of `srcCanvas`.

	~DRAM_Canvas (void)=default
	Default destructor.

void	loadImage (void) const override
	Loads the image from Flash ROM onto this Canvas.

Public Member Functions inherited from Canvas
	Canvas (void)
	Default constructor sets canvass to the full size of the display.

	Canvas (bool temporary)
	Constructor sets canvass to the full size of the display.

	Canvas (uint16_t width, uint16_t height, bool temporary=false)
	Constructor.

	~Canvas (void)=default
	Default destructor.

void	setActive (void) const
	Sets this canvas as both the active canvas and active window.

void	setMainWindow (void) const
	Sets this canvas as the Main Window, displaying it in the TFT.

uint16_t	width (void) const
	Accessor method providing the canvas width.

uint16_t	height (void) const
	Accessor method providing the canvas height.

uint32_t	address (void) const
	Accessor method providing the canvas' starting address in DRAM.

void	BTE_CopyFrom (const Canvas &source) const
	Uses BTE engine to copy entire image from `source` canvas to this one.

void	BTE_CopyFrom (const Canvas &source, uint16_t DT_x0, uint16_t DT_y0) const
	Uses BTE engine to copy imagery from `source` canvas to this one.

void	BTE_ROP (const Canvas &S0, uint16_t S0_x0, uint16_t S0_y0, const Canvas &S1, uint16_t S1_x0, uint16_t S1_y0, uint16_t DT_x0, uint16_t DT_y0, uint16_t DT_width, uint16_t DT_height, uint8_t ROP, bool S1_OpacityOn=false) const
	Gneralized ROP operation. This assumes that object calling this method is the destimation DT canvas.

void	BTE_CopyFrom (const Canvas &source, uint16_t Src_x0, uint16_t Src_y0, uint16_t DT_x0, uint16_t DT_y0, uint16_t width, uint16_t height) const
	Uses BTE engine to copy imagery from `source` canvas to this one.

void	BTE_AddImageFrom (const Canvas &source, uint16_t Src_x0, uint16_t Src_y0, uint16_t DT_x0, uint16_t DT_y0, uint16_t width, uint16_t height) const
	Adds an opacity encoded image from `source` to the image on this canvas.

void	BTE_AddTransparantImageFrom (const Canvas &source, uint16_t Src_x0, uint16_t Src_y0, uint16_t DT_x0, uint16_t DT_y0, uint16_t width, uint16_t height) const
	Adds an opacity encoded image from `source` to the image on this canvas.

void	clear (void)
	Erases the canvas, setting all pixels to Black.

void	clear (uint16_t color)
	Erases the canvas, setting all pixels to the specified color.

void	solidFill (uint16_t x0, uint16_t y0, uint16_t width, uint16_t height, uint16_t color) const
	Draws a filled square onto the canvas.

void	text (uint16_t x0, uint16_t y0, uint16_t fColor, uint16_t bColor, const char *text, bool small=false) const
	Draws text onto the canvas.

void	drawSquare (unsigned short x0, unsigned short y0, unsigned short x1, unsigned short y1, unsigned short color) const
	Draws an unfilled square.

Additional Inherited Members
Static Public Member Functions inherited from Canvas
static void	BL_ON (void)
	Turns the TFT backlight on.

static void	BL_OFF (void)
	Turns the TFT backlight off.

static uint32_t	nextAddress (void)
	Location in DRAM whether the next image Canvas will be placed.

static void	drawLine (uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint16_t color)
	Draws a line onto the display.

Protected Member Functions inherited from Canvas
void	_validate (void) const
	Protected method used to validate that the images used to create this canvas are appropriately size.

void	BTE_SetAsS0 (uint16_t x0, uint16_t y0) const
	Sets the location of the S0 source image for the BTE engine.

void	BTE_SetAsS1 (uint16_t x0, uint16_t y0) const
	Sets the location of the S1 source image for the BTE engine.

void	BTE_SetAsDT (uint16_t x0, uint16_t y0) const
	Sets the location of the destination (DT) image for the BTE engine.

Constructor & Destructor Documentation

◆ DRAM_Canvas() [1/2]

DRAM_Canvas::DRAM_Canvas ( const Canvas & srcCanvas )

Constructor that makes a full copy of srcCanvas.

Parameters

[in] srcCanvas The source canvas

◆ DRAM_Canvas() [2/2]

DRAM_Canvas::DRAM_Canvas	(	const Canvas &	srcCanvas,
		const Block_Image	imgBlock )

Constructor that copies a subset of srcCanvas.

Parameters

[in]	srcCanvas	The source canvas
[in]	imgBlock	Image Block within `srcCanvas` to be copied

◆ ~DRAM_Canvas()

DRAM_Canvas::~DRAM_Canvas ( void )

default

Default destructor.

Parameters: None.

Member Function Documentation

◆ loadImage()

void DRAM_Canvas::loadImage ( void ) const

overridevirtual

Loads the image from Flash ROM onto this Canvas.

Parameters: None.

Reimplemented from Canvas.

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

C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Canvas.h
C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Canvas.cpp