Globals

The global touchgfx namespace.
All TouchGFX framework enums, Type definitions, global functions and global variables are placed in this namespace.

Enums

BlitOperations

enum BlitOperations

The Blit Operations.

BLIT_OP_COPY	Copy the source to the destination.
BLIT_OP_FILL	Fill the destination with color.
BLIT_OP_COPY_WITH_ALPHA	Copy the source to the destination using the given alpha.
BLIT_OP_FILL_WITH_ALPHA	Fill the destination with color using the given alpha.
BLIT_OP_COPY_WITH_TRANSPARENT_PIXELS	Deprecated, ignored. (Copy the source to the destination, but not the transparent pixels)
BLIT_OP_COPY_ARGB8888	Copy the source to the destination, performing per-pixel alpha blending.
BLIT_OP_COPY_ARGB8888_WITH_ALPHA	Copy the source to the destination, performing per-pixel alpha blending and blending the result with an image-wide alpha.
BLIT_OP_COPY_L8	Copy the L8 source to the destination using the given alpha.
BLIT_OP_COPY_A4	Copy 4-bit source text to destination, performing per-pixel alpha blending.
BLIT_OP_COPY_A8	Copy 8-bit source text to destination, performing per-pixel alpha blending.
BLIT_OP_COPY_16BIT	Copy 16-bit regardless of frame buffer format.
BLIT_OP_FILL_16BIT	Fill 16-bit regardless of frame buffer format.

Location: touchgfx/hal/BlitOp.hpp

Direction

enum Direction

Values that represent directions.

NORTH	An enum constant representing the north option.
SOUTH	An enum constant representing the south option.
EAST	An enum constant representing the east option.
WEST	An enum constant representing the west option.

Location: touchgfx/hal/Types.hpp

DisplayOrientation

enum DisplayOrientation

Values that represent display orientations.

ORIENTATION_LANDSCAPE	The display has more pixels from left to right than from top to bottom.
ORIENTATION_PORTRAIT	The display has more pixels from top to bottom than from right to left.

Location: touchgfx/hal/Types.hpp

DisplayRotation

enum DisplayRotation

Values that represent display rotations.

rotate0	The display is oriented like the framebuffer.
rotate90	The display is rotated 90 degrees compared to the framebuffer layout.

Location: touchgfx/hal/Types.hpp

DMAType

enum DMAType

Values that represent dma types.

DMA_TYPE_GENERIC	Generic DMA Implementation.
DMA_TYPE_CHROMART	ChromART hardware DMA Implementation.

Location: touchgfx/hal/Types.hpp

FrameBuffer

enum FrameBuffer

Values that represent frame buffers.

FB_PRIMARY	First framebuffer.
FB_SECONDARY	Second framebuffer.
FB_TERTIARY	Third framebuffer.

Location: touchgfx/hal/Types.hpp

GlyphFlags

enum GlyphFlags

Glyph flag definitions.

GLYPH_DATA_KERNINGTABLEPOS_BIT8_10	The 8th, 9th and 10th bit of the kerningTablePos.
GLYPH_DATA_WIDTH_BIT8	The 9th bit of "width".
GLYPH_DATA_HEIGHT_BIT8	The 9th bit of "height".
GLYPH_DATA_TOP_BIT8	The 9th bit of "top".
GLYPH_DATA_TOP_BIT9	The sign bit of "top".
GLYPH_DATA_ADVANCE_BIT8	The 9th bit of "advance".

Location: touchgfx/Font.hpp

Gradient

enum Gradient

Values that represent gradients.

GRADIENT_HORIZONTAL	Horizontal gradient.
GRADIENT_VERTICAL	Vertical gradient.

Location: touchgfx/hal/Types.hpp

TextRotation

enum TextRotation

Values that represent text rotations.

TEXT_ROTATE_0	Text is written from left to right.
TEXT_ROTATE_90	Text is written from top to bottom.
TEXT_ROTATE_180	Text is written from right to left (upside down)
TEXT_ROTATE_270	Text is written bottom to top.

Location: touchgfx/hal/Types.hpp

VectorPrimitives

enum VectorPrimitives

A list of the vector graphics primitives.

VECTOR_PRIM_CLOSE	Close the path.
VECTOR_PRIM_MOVE	Move to a point.
VECTOR_PRIM_LINE	Line to a point from current position.
VECTOR_PRIM_HLINE	Horizontal line to a point from current position.
VECTOR_PRIM_VLINE	Vertical line to a point from current position.
VECTOR_PRIM_BEZIER_QUAD	Quadratic Bezier (1 control point) curve to a point from the current position.
VECTOR_PRIM_BEZIER_CUBIC	Cubic Bezier (2 control points) curve to a point from the current position.

Location: touchgfx/hal/Types.hpp

VGColorMode

enum VGColorMode

A list of coloring modes.

VG_NONE	No coloring.
VG_FIXED_COLOR	Color with a fixed color in the whole shape.
VG_LINEAR_GRADIENT	Color using a linear gradient.

Location: touchgfx/hal/VGData.hpp

VGFillMode

enum VGFillMode

A list of vector graphics polygon filling modes.

VG_FILL_EVEN_ODD	Fill the paths using the even-odd filling rule.
VG_FILL_NON_ZERO	Fill the paths using the non-zero filling rule.

Location: touchgfx/hal/VGData.hpp

VGStrokeLineCap

enum VGStrokeLineCap

Values that represent the different ways stroke lines can end.

VG_STROKE_LINECAP_BUTT
VG_STROKE_LINECAP_ROUND
VG_STROKE_LINECAP_SQUARE

Location: touchgfx/hal/VGData.hpp

VGStrokeLineJoin

enum VGStrokeLineJoin

Values that represent the different ways strokes lines can be joined.

VG_STROKE_LINEJOIN_BEVEL
VG_STROKE_LINEJOIN_MITER
VG_STROKE_LINEJOIN_ROUND

Location: touchgfx/hal/VGData.hpp

WideTextAction

enum WideTextAction

Values that represent wide text actions.

WIDE_TEXT_NONE	Do nothing, simply cut the text in the middle of any character that extends beyond the width of the TextArea.
WIDE_TEXT_WORDWRAP	Wrap between words, no ellipsis, keep wrapping lines.
WIDE_TEXT_WORDWRAP_ELLIPSIS	Wrap between words, ellipsis anywhere "Very long t...".
WIDE_TEXT_WORDWRAP_ELLIPSIS_AFTER_SPACE	Wrap between words, ellipsis only after space "Very long ...".
WIDE_TEXT_CHARWRAP	Wrap between any two characters, no ellipsis, keep wrapping lines.
WIDE_TEXT_CHARWRAP_ELLIPSIS	Wrap between any two characters, ellipsis anywhere, as used in Chinese.
WIDE_TEXT_CHARWRAP_DOUBLE_ELLIPSIS	Wrap between any two characters, double ellipsis anywhere, as used in Chinese.

Location: touchgfx/hal/Types.hpp

Type Definitions

Alignment

typedef uint8_t Alignment

Defines an alignment type.

Location: touchgfx/hal/Types.hpp

AnimatedImageClickButton

typedef AnimatedImageButtonStyle< ClickButtonTrigger > AnimatedImageClickButton

Defines an alias representing the animated image click button.

Location: touchgfx/containers/buttons/Buttons.hpp

AnimatedImageRepeatButton

typedef AnimatedImageButtonStyle< RepeatButtonTrigger > AnimatedImageRepeatButton

Defines an alias representing the animated image repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

AnimatedImageToggleButton

typedef AnimatedImageButtonStyle< ToggleButtonTrigger > AnimatedImageToggleButton

Defines an alias representing the animated image toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

AnimatedImageTouchButton

typedef AnimatedImageButtonStyle< TouchButtonTrigger > AnimatedImageTouchButton

Defines an alias representing the animated image touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

BitmapId

typedef uint16_t BitmapId

This type shall be used by the application to define unique IDs for all bitmaps in the system.

Location: touchgfx/Bitmap.hpp

BoxClickButton

typedef BoxWithBorderButtonStyle< ClickButtonTrigger > BoxClickButton

Defines an alias representing the box click button.

Location: touchgfx/containers/buttons/Buttons.hpp

BoxRepeatButton

typedef BoxWithBorderButtonStyle< RepeatButtonTrigger > BoxRepeatButton

Defines an alias representing the box repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

BoxToggleButton

typedef BoxWithBorderButtonStyle< ToggleButtonTrigger > BoxToggleButton

Defines an alias representing the box toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

BoxTouchButton

typedef BoxWithBorderButtonStyle< TouchButtonTrigger > BoxTouchButton

Defines an alias representing the box touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

EasingEquation

typedef int16_t(* EasingEquation) (uint16_t, int16_t, int16_t, uint16_t)

This function pointer typedef matches the signature for all easing equations.

Location: touchgfx/EasingEquations.hpp

fixed16_16

typedef int32_t fixed16_16

A fixed point value using 16 bits for the decimal part and 16 bits for the integral part.

Location: touchgfx/hal/Types.hpp

fixed28_4

typedef int32_t fixed28_4

A fixed point value using 4 bits for the decimal part and 28 bits for the integral part.

Location: touchgfx/hal/Types.hpp

FontId

typedef uint16_t FontId

Defines an alias representing a Font ID.

Location: touchgfx/Font.hpp

IconClickButton

typedef IconButtonStyle< ClickButtonTrigger > IconClickButton

Defines an alias representing the icon click button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconImageClickButton

typedef ImageButtonStyle< IconButtonStyle< ClickButtonTrigger > > IconImageClickButton

Defines an alias representing the icon image click button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconImageRepeatButton

typedef ImageButtonStyle< IconButtonStyle< RepeatButtonTrigger > > IconImageRepeatButton

Defines an alias representing the icon image repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconImageToggleButton

typedef ImageButtonStyle< IconButtonStyle< ToggleButtonTrigger > > IconImageToggleButton

Defines an alias representing the icon image toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconImageTouchButton

typedef ImageButtonStyle< IconButtonStyle< TouchButtonTrigger > > IconImageTouchButton

Defines an alias representing the icon image touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconRepeatButton

typedef IconButtonStyle< RepeatButtonTrigger > IconRepeatButton

Defines an alias representing the icon repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconToggleButton

typedef IconButtonStyle< ToggleButtonTrigger > IconToggleButton

Defines an alias representing the icon toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

IconTouchButton

typedef IconButtonStyle< TouchButtonTrigger > IconTouchButton

Defines an alias representing the icon touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

ImageClickButton

typedef ImageButtonStyle< ClickButtonTrigger > ImageClickButton

Defines an alias representing the image click button.

Location: touchgfx/containers/buttons/Buttons.hpp

ImageRepeatButton

typedef ImageButtonStyle< RepeatButtonTrigger > ImageRepeatButton

Defines an alias representing the image repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

ImageToggleButton

typedef ImageButtonStyle< ToggleButtonTrigger > ImageToggleButton

Defines an alias representing the image toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

ImageTouchButton

typedef ImageButtonStyle< TouchButtonTrigger > ImageTouchButton

Defines an alias representing the image touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

LanguageId

typedef uint16_t LanguageId

Language IDs generated by the text converter are uint16_t typedef'ed.

Location: touchgfx/Texts.hpp

RenderingVariant

typedef uint16_t RenderingVariant

Describes a combination of rendering algorithm, image format, and alpha information.

Location: touchgfx/hal/Types.hpp

TextClickButton

typedef TextButtonStyle< ClickButtonTrigger > TextClickButton

Defines an alias representing the text click button.

Location: touchgfx/containers/buttons/Buttons.hpp

TextDirection

typedef uint8_t TextDirection

Defines a the direction to write text.

Location: touchgfx/hal/Types.hpp

TextRepeatButton

typedef TextButtonStyle< RepeatButtonTrigger > TextRepeatButton

Defines an alias representing the text repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

TextToggleButton

typedef TextButtonStyle< ToggleButtonTrigger > TextToggleButton

Defines an alias representing the text toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

TextTouchButton

typedef TextButtonStyle< TouchButtonTrigger > TextTouchButton

Defines an alias representing the text touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

TiledImageClickButton

typedef TiledImageButtonStyle< ClickButtonTrigger > TiledImageClickButton

Defines an alias representing the tiled image click button.

Location: touchgfx/containers/buttons/Buttons.hpp

TiledImageRepeatButton

typedef TiledImageButtonStyle< RepeatButtonTrigger > TiledImageRepeatButton

Defines an alias representing the tiled image repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

TiledImageToggleButton

typedef TiledImageButtonStyle< ToggleButtonTrigger > TiledImageToggleButton

Defines an alias representing the tiled image toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

TiledImageTouchButton

typedef TiledImageButtonStyle< TouchButtonTrigger > TiledImageTouchButton

Defines an alias representing the tiled image touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

TwoWildcardTextClickButton

typedef TwoWildcardTextButtonStyle< ClickButtonTrigger > TwoWildcardTextClickButton

Defines an alias representing the wildcard text click button.

Location: touchgfx/containers/buttons/Buttons.hpp

TwoWildcardTextRepeatButton

typedef TwoWildcardTextButtonStyle< RepeatButtonTrigger > TwoWildcardTextRepeatButton

Defines an alias representing the wildcard text repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

TwoWildcardTextToggleButton

typedef TwoWildcardTextButtonStyle< ToggleButtonTrigger > TwoWildcardTextToggleButton

Defines an alias representing the wildcard text toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

TwoWildcardTextTouchButton

typedef TwoWildcardTextButtonStyle< TouchButtonTrigger > TwoWildcardTextTouchButton

Defines an alias representing the wildcard text touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

TypedTextId

typedef uint16_t TypedTextId

Text IDs as generated by the text converter are simple uint16_t typedefs.

Location: touchgfx/hal/Types.hpp

WildcardTextClickButton

typedef WildcardTextButtonStyle< ClickButtonTrigger > WildcardTextClickButton

Defines an alias representing the wildcard text click button.

Location: touchgfx/containers/buttons/Buttons.hpp

WildcardTextRepeatButton

typedef WildcardTextButtonStyle< RepeatButtonTrigger > WildcardTextRepeatButton

Defines an alias representing the wildcard text repeat button.

Location: touchgfx/containers/buttons/Buttons.hpp

WildcardTextToggleButton

typedef WildcardTextButtonStyle< ToggleButtonTrigger > WildcardTextToggleButton

Defines an alias representing the wildcard text toggle button.

Location: touchgfx/containers/buttons/Buttons.hpp

WildcardTextTouchButton

typedef WildcardTextButtonStyle< TouchButtonTrigger > WildcardTextTouchButton

Defines an alias representing the wildcard text touch button.

Location: touchgfx/containers/buttons/Buttons.hpp

Functions

abs

T abs	(	T	d	)

Simple implementation of the standard abs function.

Template Parameters:

T	The type on which to perform the abs.

Parameters:

d	The entity on which to perform the abs.

Returns:

The absolute (non-negative) value of d.

Location: touchgfx/Utils.hpp

ceil28_4

FORCE_INLINE_FUNCTION int32_t ceil28_4	(	fixed28_4	value	)

Round up a fixed28_4 value.

Parameters:

value	The fixed28_4 value.

Returns:

The ceil result.

Location: touchgfx/TextureMapTypes.hpp

clz

int32_t clz	(	int32_t	x	)

Count leading zeros in the binary representation of absolute value of the given int32_t.

Parameters:

x	The value to count the number of leading zeros in.

Returns:

The number of leading zeros (from 0 to 31).

See also:

clzu

Location: touchgfx/Utils.hpp

clzu

int32_t clzu	(	uint32_t	x	)

Count leading zeros in the binary representation of absolute value of the given uint32_t.

Parameters:

x	The value to count the number of leading zeros in.

Returns:

The number of leading zeros (from 0 to 32).

See also:

clz

Location: touchgfx/Utils.hpp

finalizeTransition

static FORCE_INLINE_FUNCTION void finalizeTransition	(	Screen *	newScreen ,
		Presenter *	newPresenter ,
		Transition *	newTransition
		)

Finalize screen transition.

Private helper function for makeTransition. Do not use.

Parameters:

newScreen	If non-null, the new screen.
newPresenter	If non-null, the new presenter.
newTransition	If non-null, the new transition.

Location: mvp/MVPApplication.hpp

fixed28_4Mul

FORCE_INLINE_FUNCTION fixed28_4 fixed28_4Mul	(	fixed28_4	a ,
		fixed28_4	b
		)

Multiply two fixed28_4 numbers.

Parameters:

a	The fixed28_4 to process.
b	The fixed28_4 to process.

Returns:

the result.

Location: touchgfx/TextureMapTypes.hpp

fixed28_4ToFloat

FORCE_INLINE_FUNCTION float fixed28_4ToFloat	(	fixed28_4	value	)

Convert fixed28_4 to float.

Parameters:

value	The fixed28_4 value.

Returns:

The value as float.

Location: touchgfx/TextureMapTypes.hpp

floatToFixed16_16

FORCE_INLINE_FUNCTION fixed16_16 floatToFixed16_16	(	float	value	)

Convert float to fixed16_16.

Parameters:

value	The float value.

Returns:

The value as fixed16_16.

Location: touchgfx/TextureMapTypes.hpp

floatToFixed28_4

FORCE_INLINE_FUNCTION fixed28_4 floatToFixed28_4	(	float	value	)

Convert float to fixed28_4.

Parameters:

value	The float value.

Returns:

The value as fixed28_4.

Location: touchgfx/TextureMapTypes.hpp

floorDivMod

FORCE_INLINE_FUNCTION void floorDivMod	(	int32_t	numerator ,
		int32_t	denominator ,
		int32_t &	floor ,
		int32_t &	mod
		)

Divides two fixed28_4 numbers and returns the result as well as the remainder.

Parameters:

numerator	The numerator.
denominator	The denominator.
floor	numerator/denominator.
mod	numerator%denominator.

Location: touchgfx/TextureMapTypes.hpp

FrameBufferAllocatorSignalBlockDrawn

void FrameBufferAllocatorSignalBlockDrawn	(			)

Called by FrameBufferAllocator when a block is drawn and therefore ready for transfer.

The LCD driver should use this method to start a transfer.

Location: touchgfx/hal/FrameBufferAllocator.hpp

FrameBufferAllocatorWaitOnTransfer

void FrameBufferAllocatorWaitOnTransfer	(			)

Called by FrameBufferAllocator to wait for a LCD Transfer, when the allocator has no free blocks.

The LCD driver can use this function to synchronize the UI thread with the transfer logic.

Location: touchgfx/hal/FrameBufferAllocator.hpp

gcd

T gcd	(	T	a ,
		T	b
		)

Find greatest common divisor of two given numbers.

Template Parameters:

T	Generic type parameter.

Parameters:

a	The first number.
b	The second number.

Returns:

The greatest common divisor.

Location: touchgfx/Utils.hpp

hw_init

void hw_init	(			)

Function to perform generic hardware initialization of the board.

This function prototype is only provided as a convention.

Location: touchgfx/hal/BoardConfiguration.hpp

lookupBilinearRenderVariant

RenderingVariant lookupBilinearRenderVariant	(	const Bitmap &	bitmap	)

Returns the associated bilinear render variant based on the bitmap format.

This is used for quick determination of the type of bitmap during TextureMapper drawing.

Parameters:

bitmap	The bitmap.

Returns:

A RenderingVariant based on the bitmap format.

Location: touchgfx/Utils.hpp

lookupNearestNeighborRenderVariant

RenderingVariant lookupNearestNeighborRenderVariant	(	const Bitmap &	bitmap	)

Returns the associated nearest neighbor render variant based on the bitmap format.

This is used for quick determination of the type of bitmap during TextureMapper drawing.

Parameters:

bitmap	The bitmap.

Returns:

A RenderingVariant based on the bitmap format.

Location: touchgfx/Utils.hpp

makeTransition

PresenterType * makeTransition	(	Screen **	currentScreen ,
		Presenter **	currentPresenter ,
		MVPHeap &	heap ,
		Transition **	currentTrans ,
		ModelType *	model
		)

Function for effectuating a screen transition (i.e.

makes the requested new presenter/view pair active). Once this function has returned, the new screen has been transitioned to. Due to the memory allocation strategy of using the same memory area for all screens, the old view/presenter will no longer exist when this function returns.

Will properly clean up old screen (tearDownScreen, Presenter::deactivate) and call setupScreen/activate on new view/presenter pair. Will also make sure the view, presenter and model are correctly bound to each other.

Template Parameters:

ScreenType	Class type for the View.
PresenterType	Class type for the Presenter.
TransType	Class type for the Transition.
ModelType	Class type for the Model.

Parameters:

currentScreen	Pointer to pointer to the current view.
currentPresenter	Pointer to pointer to the current presenter.
heap	Reference to the heap containing the memory storage in which to allocate.
currentTrans	Pointer to pointer to the current transition.
model	Pointer to model.

Returns:

Pointer to the new Presenter of the requested type. Incidentally it will be the same value as the old presenter due to memory reuse.

Location: mvp/MVPApplication.hpp

memset

void memset	(	void *	data ,
		uint8_t	c ,
		uint32_t	size
		)

Simple implementation of the standard memset function.

Will write the value of 'c' in 'size' consecutive bytes starting from 'data'.

Parameters:

data	Address of data to set.
c	Value to set.
size	Number of bytes to set.

Location: touchgfx/Utils.hpp

muldiv

int32_t muldiv	(	int32_t	factor1 ,
		int32_t	factor2 ,
		int32_t	divisor
		)

Multiply and divide without causing overflow.

Multiplying two large values and subsequently dividing the result with another large value might cause an overflow in the intermediate result. The function muldiv() will multiply factor1 and factor2 and divide the result by divisor without causing overflow (unless the final result would overflow). The remainder is used to round the result up or down.

Parameters:

factor1	The first factor.
factor2	The second factor.
divisor	The divisor.

Returns:

(factor1 * factor2) / divisor rounded.

See also:

muldiv(int32_t,int32_t,int32_t,int32_t&)

Location: touchgfx/Utils.hpp

muldiv

int32_t muldiv	(	int32_t	factor1 ,
		int32_t	factor2 ,
		int32_t	divisor ,
		int32_t &	remainder
		)

Multiply and divide without causing overflow.

Multiplying two large values and subsequently dividing the result with another large value might cause an overflow in the intermediate result. The function muldiv() will multiply factor1 and factor2 and divide the result by divisor without causing overflow (unless the final result would overflow). The remainder from the division is returned.

Parameters:

factor1	The first factor.
factor2	The second factor.
divisor	The divisor.
remainder	The remainder.

Returns:

(factor1 * factor2) / divisor.

Note

For large numbers close to the limit of int32_t, the calculation may not be correct.

See also:

muldivu

Location: touchgfx/Utils.hpp

muldivu

uint32_t muldivu	(	uint32_t	factor1 ,
		uint32_t	factor2 ,
		uint32_t	divisor ,
		uint32_t &	remainder
		)

Multiply and divide without causing overflow.

Multiplying two large values and subsequently dividing the result with another large value might cause an overflow in the intermediate result. The function muldiv() will multiply factor1 and factor2 and divide the result by divisor without causing overflow (unless the final result would overflow). The remainder from the division is returned.

Parameters:

factor1	The first factor.
factor2	The second factor.
divisor	The divisor.
remainder	The remainder.

Returns:

(factor1 * factor2) / divisor.

Note

For large numbers close to the limit of uint32_t, the calculation may not be correct.

See also:

muldiv

Location: touchgfx/Utils.hpp

operator*

Matrix4x4 operator*	(	const Matrix4x4 &	multiplicand ,
		const Matrix4x4 &	multiplier
		)

Multiplication operator.

Parameters:

multiplicand	The first value to multiply.
multiplier	The second value to multiply.

Returns:

The result of the operation.

Location: touchgfx/Math3D.hpp

operator*

Point4 operator*	(	const Matrix4x4 &	multiplicand ,
		const Point4 &	multiplier
		)

Multiplication operator.

Parameters:

multiplicand	The first value to multiply.
multiplier	The second value to multiply.

Returns:

The result of the operation.

Location: touchgfx/Math3D.hpp

prepareTransition

static FORCE_INLINE_FUNCTION void prepareTransition	(	Screen **	currentScreen ,
		Presenter **	currentPresenter ,
		Transition **	currentTrans
		)

Prepare screen transition.

Private helper function for makeTransition. Do not use.

Parameters:

currentScreen	If non-null, the current screen.
currentPresenter	If non-null, the current presenter.
currentTrans	If non-null, the current transaction.

Location: mvp/MVPApplication.hpp

shouldTransferBlock

int shouldTransferBlock	(	uint16_t	bottom	)

Check if a Frame Buffer Block ending at bottom may be sent.

Parameters:

bottom	The bottom coordinate of the block to transfer.

Returns:

Non zero if possible.

Location: touchgfx/hal/PartialFrameBufferManager.hpp

sign

T sign	(	T	d	)

Simple implementation of the standard sign function.

Template Parameters:

T	The type on which to perform the sign.

Parameters:

d	The entity on which to perform the sign.

Returns:

-1, +1 or 0 depending on the sign of the given value of d.

Location: touchgfx/Utils.hpp

simulator_enable_stdio

void simulator_enable_stdio	(			)

Simulator enable stdio.

Location: platform/hal/simulator/sdl2/HALSDL2.hpp

simulator_printf

void simulator_printf	(	const char *	format ,
		va_list	pArg
		)

Simulator printf.

Parameters:

format	Describes the format to use.
pArg	The argument list.

Location: platform/hal/simulator/sdl2/HALSDL2.hpp

touchgfx_generic_init

HAL & touchgfx_generic_init	(	DMA_Interface &	dma ,
		LCD &	display ,
		TouchController &	tc ,
		int16_t	width ,
		int16_t	height ,
		uint16_t *	bitmapCache ,
		uint32_t	bitmapCacheSize ,
		uint32_t	numberOfDynamicBitmaps =0
		)

TouchGFX generic initialize.

Template Parameters:

HALType	The class type of the HAL subclass used for this port.

Parameters:

dma	Reference to the DMA implementation object to use. Can be of type NoDMA to disable the use of DMA for rendering.
display	Reference to the LCD renderer implementation (subclass of LCD). Could be either LCD16bpp for RGB565 UIs, or LCD1bpp for monochrome UIs or LCD24bpp for 24bit displays using RGB888 UIs.
tc	Reference to the touch controller driver (or NoTouchController to disable touch input).
width	The native display width of the actual display, in pixels. This value is irrespective of whether the concrete UI should be portrait or landscape mode. It must match what the display itself is configured as.
height	The native display height of the actual display, in pixels. This value is irrespective of whether the concrete UI should be portrait or landscape mode. It must match what the display itself is configured as.
bitmapCache	Optional pointer to starting address of a memory region in which to place the bitmap cache. Usually in external RAM. Pass 0 if bitmap caching is not used.
bitmapCacheSize	Size of bitmap cache in bytes. Pass 0 if bitmap cache is not used.
numberOfDynamicBitmaps	(Optional) Number of dynamic bitmaps.

Returns:

A reference to the allocated (and initialized) HAL object.

Location: common/TouchGFXInit.hpp

touchgfx_init

void touchgfx_init	(			)

Function to perform touchgfx initialization.

This function prototype is only provided as a convention.

Location: touchgfx/hal/BoardConfiguration.hpp

transmitActive

int transmitActive	(			)

Check if a Frame Buffer Block is being transmitted.

Returns:

Non zero if possible.

Location: touchgfx/hal/PartialFrameBufferManager.hpp

transmitBlock

void transmitBlock	(	const uint8_t *	pixels ,
		uint16_t	x ,
		uint16_t	y ,
		uint16_t	w ,
		uint16_t	h
		)

Transmit a Frame Buffer Block.

Parameters:

pixels	Pointer to the pixel data.
x	X coordinate of the block.
y	Y coordinate of the block.
w	Width of the block.
h	Height of the block.

Location: touchgfx/hal/PartialFrameBufferManager.hpp

Variables

BITMAP_ANIMATION_STORAGE

const BitmapId BITMAP_ANIMATION_STORAGE = 0xFFFEU

A virtual id representing animation storage.

Location: touchgfx/Bitmap.hpp

BITMAP_INVALID

const BitmapId BITMAP_INVALID = 0xFFFFU

Define the bitmapId of an invalid bitmap.

Location: touchgfx/Bitmap.hpp

CENTER

const Alignment CENTER = 1

Text is centered horizontally.

Location: touchgfx/hal/Types.hpp

LEFT

const Alignment LEFT = 0

Text is left aligned.

Location: touchgfx/hal/Types.hpp

PI

const float PI = 3.14159265358979323846f

PI.

Location: touchgfx/hal/Types.hpp

RenderingVariant_Alpha

const uint16_t RenderingVariant_Alpha = 2

The rendering variant alpha bit value.

Location: touchgfx/hal/Types.hpp

RenderingVariant_Bilinear

const uint16_t RenderingVariant_Bilinear = 1

The rendering variant bilinear bit value.

Location: touchgfx/hal/Types.hpp

RenderingVariant_FormatShift

const uint16_t RenderingVariant_FormatShift = 2

The rendering variant format shift.

Location: touchgfx/hal/Types.hpp

RenderingVariant_NearestNeighbor

const uint16_t RenderingVariant_NearestNeighbor = 0

The rendering variant nearest neighbor bit value.

Location: touchgfx/hal/Types.hpp

RenderingVariant_NoAlpha

const uint16_t RenderingVariant_NoAlpha = 0

The rendering variant no alpha bit value.

Location: touchgfx/hal/Types.hpp

RIGHT

const Alignment RIGHT = 2

Text is right aligned.

Location: touchgfx/hal/Types.hpp

SVG_INVALID

const uint16_t SVG_INVALID = 0xFFFFU

Define the svgId of an invalid SVG.

Location: touchgfx/widgets/SVGImage.hpp

TEXT_DIRECTION_LTR

const TextDirection TEXT_DIRECTION_LTR = 0

Text is written Left-To-Right, e.g. English.

Location: touchgfx/hal/Types.hpp

TEXT_DIRECTION_RTL

const TextDirection TEXT_DIRECTION_RTL = 1

Text is written Right-To-Left, e.g. Hebrew.

Location: touchgfx/hal/Types.hpp

TYPED_TEXT_INVALID

const TypedTextId TYPED_TEXT_INVALID = 0xFFFFU

The ID of an invalid text.

Location: touchgfx/TypedText.hpp