TouchGFX Documentation

https://support.touchgfx.com/docs
Admin
Official documentation for TouchGFX, a C++ framework for creating embedded graphical user interfaces...
Tokens:355,009
Snippets:4,757
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example .extSettings for STM32H747I-DISCO

Source: https://support.touchgfx.com/docs/development/scenarios/adding-files-to-stm32cubemx-projet

Configuration example for a multi-core project, specifying settings for the Cortex-M7 core.

```text
[CortexM7:ProjectFiles]  
HeaderPath=../Drivers/BSP/Components/Common;../Drivers/BSP/STM32H747I-Discovery  
[CortexM7:Groups]  
Application/User/CM7/TouchGFX/target=../CM7/TouchGFX/target/STM32H7Instrumentation.cpp  
Drivers/BSP/Components=../Drivers/BSP/Components/otm8009a/otm8009a.c;../Drivers/BSP/Components/otm8009a/otm8009a_reg.c;../Drivers/BSP/Components/ft6x06/ft6x06.c;../Drivers/BSP/Components/ft6x06/ft6x06_reg.c;../Drivers/BSP/Components/mt25tl01g/mt25tl01g.c;../Drivers/BSP/Components/is42s32800j/is42s32800j.c  
Drivers/BSP/STM32H747I-Discovery=../Drivers/BSP/STM32H747I-Discovery/stm32h747i_discovery_bus.c;../Drivers/BSP/STM32H747I-Discovery/stm32h747i_discovery_qspi.c;../Drivers/BSP/STM32H747I-Discovery/stm32h747i_discovery_sdram.c;../Drivers/BSP/STM32H747I-Discovery/stm32h747i_discovery_ts.c;  
[CortexM7:Others]  
Define=USE_STM32H747I_DISCO  
HALModule=I2C  
```

--------------------------------

### Example .extSettings for STM32H735G-DK

Source: https://support.touchgfx.com/docs/development/scenarios/adding-files-to-stm32cubemx-projet

Configuration example for a single-core project including BSP drivers and TouchGFX target files.

```text
[ProjectFiles]  
HeaderPath=../Drivers/BSP/Components/Common;../Drivers/BSP/STM32H735G-DK  
[Groups]  
Drivers/BSP/STM32H735G-DK=../Drivers/BSP/STM32H735G-DK/stm32h735g_discovery_ospi.c;../Drivers/BSP/STM32H735G-DK/stm32h735g_discovery_ts.c;../Drivers/BSP/STM32H735G-DK/stm32h735g_discovery_bus.c  
Drivers/BSP/Components=../Drivers/BSP/Components/s70kl1281/s70kl1281.c;../Drivers/BSP/Components/mx25lm51245g/mx25lm51245g.c;../Drivers/BSP/Components/ft5336/ft5336.c;../Drivers/BSP/Components/ft5336/ft5336_reg.c  
Application/User/TouchGFX/target=../TouchGFX/target/CortexMMCUInstrumentation.cpp  
[Others]  
Define=USE_STM32H735G_DK  
HALModule=I2C  
```

--------------------------------

### Install Build Tools

Source: https://support.touchgfx.com/docs/introduction/prerequisites

Install make and g++ to enable C++ compilation on Linux.

```bash
sudo  apt install make g++  
```

--------------------------------

### Install SDL2 Libraries

Source: https://support.touchgfx.com/docs/introduction/prerequisites

Install the necessary SDL2 development libraries and headers.

```bash
sudo apt install libsdl2-dev libsdl2-image-dev  
```

--------------------------------

### Initialize and Start RTOS Tasks

Source: https://support.touchgfx.com/docs/basic-concepts/operating-system

Demonstrates starting multiple tasks with different priorities from the main function and initiating the scheduler.

```cpp
int main() {  
  ...  
  os_start_task(gui_task,      medium_priority);  
  os_start_task(music_task,    low_priority);  
  os_start_task(bt_comm_task,  high_priority);  
  os_start_task(bt_appl_task,  low_priority);  
  os_start_scheduler();  
}  
```

--------------------------------

### ViewBox Usage Examples

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/svg

Examples demonstrating the behavior of the unsupported viewBox attribute and how to apply scaling transformations as an alternative.

```xml
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200">  
   ...  
</svg>
```

```xml
<svg xmlns="http://www.w3.org/2000/svg" width="200" height="200" viewBox="0 0 1000 1000">  
  <path d="M10 10L990,990" stroke="blue" stroke-width="10" stroke-linecap="round"/>  
</svg>
```

```xml
<svg xmlns="http://www.w3.org/2000/svg" width="200" height="200">  
  <g transform="scale(0.2)">  
    <path d="M10 10L990,990" stroke="blue" stroke-width="10" stroke-linecap="round"/>  
  </g>  
</svg>
```

--------------------------------

### Cache Bitmaps in Screen Setup

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/caching-bitmaps

Example of caching specific bitmaps during screen initialization and clearing the cache upon teardown.

```cpp
void Screen1View::setupScreen()  
{  
    //ensure background is cached  
    Bitmap::cache(BITMAP_SCREEN2_ID);  
    //cache some icons  
    Bitmap::cache(BITMAP_ICON10_ID);  
    Bitmap::cache(BITMAP_ICON11_ID);  
    Bitmap::cache(BITMAP_ICON12_ID);  
}  
  
void Screen1View::tearDownScreen()  
{  
    //Remove all bitmaps from the cache  
    Bitmap::clearCache();  
}
```

--------------------------------

### Install SDL2 Libraries on Ubuntu

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Command to install required SDL2 development libraries for the TouchGFX simulator on Linux.

```bash
sudo apt install libsdl2-dev libsdl2-image-dev
```

--------------------------------

### X-CUBE-TOUCHGFX installation path

Source: https://support.touchgfx.com/docs/introduction/installation

The default directory where the X-CUBE-TOUCHGFX package is extracted after installation.

```text
C:\Users\<user>\STM32Cube\Repository\Packs\STMicroelectronics\X-CUBE-TOUCHGFX\4.13.0
```

--------------------------------

### setup(const Rect & widgetRect)

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_painter_a_b_g_r2222_bitmap

Prepares the painter for a paint operation.

```APIDOC
## setup(const Rect & widgetRect)

### Description
This function is called before any actual paint operation is started to prepare the painter state.
```

--------------------------------

### setup

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_slide_menu

Configures the SlideMenu layout with automatic positioning.

```APIDOC
## void setup(ExpandDirection newExpandDirection, const Bitmap & backgroundBMP, const Bitmap & stateChangeButtonBMP, const Bitmap & stateChangeButtonPressedBMP)

### Description
Setup the SlideMenu by positioning the stateChangeButton next to the background image relative to the expand direction, and center it in the other dimension.

### Parameters
- **newExpandDirection** (ExpandDirection) - Required - The new expand direction.
- **backgroundBMP** (const Bitmap &) - Required - The background bitmap.
- **stateChangeButtonBMP** (const Bitmap &) - Required - The state change button bitmap.
- **stateChangeButtonPressedBMP** (const Bitmap &) - Required - The state change button pressed bitmap.
```

--------------------------------

### Install Ruby on Ubuntu

Source: https://support.touchgfx.com/docs/introduction/prerequisites

Install Ruby version 2.7 using the apt package manager.

```bash
sudo apt install ruby  
```

--------------------------------

### startZoomAnimation

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_zoom_animation_image

Sets up and starts a zoom animation for the image.

```APIDOC
void startZoomAnimation(int16_t endWidth, int16_t endHeight, uint16_t duration, ZoomMode zoomMode = FIXED_LEFT_AND_TOP, EasingEquation widthProgressionEquation = &EasingEquations::linearEaseNone, EasingEquation heightProgressionEquation = &EasingEquations::linearEaseNone)
```

--------------------------------

### Update VectorRenderer setup in SVGImage

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Demonstrates the transition from passing a Widget pointer to passing an absolute rectangle in the VectorRenderer setup method.

```cpp
void SVGImage::draw(const Rect& invalidatedArea) const  
{  
  ...  
  VectorRenderer* renderer = VectorRenderer::getInstance();  
  renderer->setup(*this, invalidatedArea);  
  ...  
```

```cpp
void SVGImage::draw(const Rect& invalidatedArea) const  
{  
  ...  
  VectorRenderer* renderer = VectorRenderer::getInstance();  
  renderer->setup(getAbsoluteRect(), invalidatedArea);  
  ...  
}  
```

--------------------------------

### setup

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_abstract_painter

Initializes the painter before drawing operations begin. This method is called before the first scan line segment is drawn and allows for variable initialization or DMA queue setup.

```APIDOC
## virtual bool setup(const Rect &widgetRect)

### Description
Initializes the painter before any actual paint operation is started. If the painter is unable to draw, it should return false.

### Parameters
- **widgetRect** (const Rect &) - The widget rectangle.

### Returns
- **bool** - True if the painter is ready to paint, false otherwise.
```

--------------------------------

### setup

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_vector_renderer

Initializes a new drawing operation within a specified canvas area.

```APIDOC
## virtual void setup(const Rect &canvasAreaAbs, const Rect &invalidatedAreaRel)

### Description
Start a new drawing (invalidated area) within the given canvas area. The canvas area typically corresponds to the area of a Widget and is given in absolute coordinates, whereas the invalidated area is given in relative coordinates.

### Parameters
- **canvasAreaAbs** (const Rect &) - Required - The canvas dimensions in absolute coordinates.
- **invalidatedAreaRel** (const Rect &) - Required - The area which should be updated in relative coordinates to the canvas area.
```

--------------------------------

### changeToStartScreen

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_application

Resets the application to the start screen.

```APIDOC
### virtual void changeToStartScreen()

Sends the application back to the start screen. This is typically called by the simulator when F5 is pressed.
```

--------------------------------

### Generated View Base Class Setup

Source: https://support.touchgfx.com/docs/development/ui-development/ui-components/shapes/shape

Example of how TouchGFX Designer initializes a Shape widget within the generated View base class.

```cpp
#include <gui_generated/screen1_screen/Screen1ViewBase.hpp>  
#include "BitmapDatabase.hpp"  
#include <touchgfx/Color.hpp>  
  
Screen1ViewBase::Screen1ViewBase()  
{  
    touchgfx::CanvasWidgetRenderer::setupBuffer(canvasBuffer, CANVAS_BUFFER_SIZE);  
  
    shape.setPosition(140, 36, 200, 200);  
    shape.setOrigin(100.000f, 100.000f);  
    shape.setScale(1.000f, 1.000f);  
    shape.setAngle(0.000f);  
    shapePainter.setColor(touchgfx::Color::getColorFromRGB(60, 180, 230));  
    shape.setPainter(shapePainter);  
    const touchgfx::AbstractShape::ShapePoint<float> shapePoints[4] = { { 0.000f, -100.000f }, { 100.000f, 0.000f }, { 0.000f, 100.000f }, { -100.000f, 0.000f } };  
    shape.setShape(shapePoints);  
  
    add(shape);  
}  
  
void Screen1ViewBase::setupScreen()  
{  
  
}  
```

--------------------------------

### start

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_d_m_a___interface

Signals that DMA transfers can start.

```APIDOC
## void start()

### Description
Signals that DMA transfers can start. If any elements are in the queue, start it.
```

--------------------------------

### Declaring and setting up a Canvas Widget

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/canvas-widgets

Example of declaring the widget and painter in a header, and configuring them in setupScreen.

```cpp
Diamond10x10 box;  
PainterRGB565 myPainter; // For 16bpp displays  
```

```cpp
myPainter.setColor(Color::getColorFromRGB(0xFF, 0x0, 0x0));  
box.setPosition(100,100,10,10);  
box.setPainter(myPainter);  
add(box);  
```

--------------------------------

### Configure .touchgfx project file for STM32CubeMX2

Source: https://support.touchgfx.com/docs/development/scenarios/touchgfx-with-mx2

Example configuration for a .touchgfx file, demonstrating the use of CMakeLists.txt as the project file and custom build/flash command overrides.

```json
...  
"Resolution": {  
    "Width": 240,  
    "Height": 240  
},  
"SelectedColorDepth": 16,  
"AvailableColorDepths": [  
    16  
],  
"AvailableLCDs": {  
    "16": "LCD16bppSerialFlash"  
},  
"AvailableResolutions": [  
    {  
    "Width": 240,  
    "Height": 240  
    }  
],  
"FrameworkFeatures": {  
    "LCD16bppSerialFlash": {  
    "Id": "LCD16bppSerialFlash",  
    "IsEnabled": true  
    }  
},  
"GenerateAssetsCommand": "make -f simulator/gcc/Makefile assets -j8",  
"PostGenerateCommand": "touchgfx update_project --project-file=simulator/msvs/Application.vcxproj",  
"PostGenerateTargetCommand": "touchgfx update_project",  
"CompileSimulatorCommand": "make -f simulator/gcc/Makefile -j8",  
"RunSimulatorCommand": "build\\bin\\simulator.exe",  
"CompileTargetCommandOverride": "cmake ../MyTGFXApp_cmake --preset debug_GCC_STM32C5A3ZGT6 & cmake --build ../MyTGFXApp_cmake/build/debug_GCC_STM32C5A3ZGT6",  
"FlashTargetCommandOverride": "\"C:/Program Files/STMicroelectronics/STM32Cube/STM32CubeProgrammer/bin/STM32_Programmer_CLI.exe\" -c port=SWD -d ../MyTGFXApp_cmake/build/debug_GCC_STM32C5A3ZGT6/MyTGFXApp.elf -el ../MX25L6433F_STM32C5A3ZG-NUCLEO.stldr -hardRst",  
"Family": "STM32C5",  
"SubFamily": "STM32C5A3",  
"Platform": "m33",  
"ProjectFile": "../MyTGFXApp_cmake/CMakeLists.txt",  
"OptionalComponentsRoot": "lib/touchgfx_components",  
...  
```

--------------------------------

### Install Roo Gem

Source: https://support.touchgfx.com/docs/introduction/prerequisites

Install the roo gem required for TouchGFX tools on Linux.

```bash
sudo gem install roo  
```

--------------------------------

### init

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_slide_transition

Initializes the transition process.

```APIDOC
## virtual void init()

### Description
Initializes the transition. This method prepares the necessary widgets and state for the slide animation to begin.
```

--------------------------------

### startAnimation

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_animated_image

Starts the animation with parameters for direction, reset behavior, and looping.

```APIDOC
## startAnimation

### Description
Starts the animation with the given parameters for animation direction, normal or reverse, whether to restart the animation and finally if the animation should loop automatically upon completion.

### Parameters
- **rev** (bool) - Defines if the animation should be performed in reverse order.
- **reset** (bool) - (Optional) Defines if the animation should reset and start from the first (or last if reverse order) bitmap.
- **loop** (bool) - (Optional) Defines if the animation should loop or do a single animation.
```

--------------------------------

### hw_init

Source: https://support.touchgfx.com/docs/api/namespacetouchgfx

Performs generic hardware initialization.

```APIDOC
## void hw_init()

### Description
Function to perform generic hardware initialization of the board. This function prototype is only provided as a convention.
```

--------------------------------

### Unsupported SVG Element Example

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/svg

Example containing the <text> element, which is not supported by the TouchGFX Image Converter.

```xml
<?xml version="1.0" encoding="iso-8859-1"?>  
<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">  
  <circle cx="50" cy="50" r="40" fill="green" />  
  <polygon points="50,10 78,78 22,78" fill="gold" />  
  <text x="38" y="78">ABC</text>  
</svg>
```

--------------------------------

### Initialize TouchController in TouchGFXConfiguration

Source: https://support.touchgfx.com/docs/development/touchgfx-hal-development/touchgfx-architecture

Shows the instantiation of the touch controller and the HAL configuration.

```cpp
static STM32TouchController tc;  
...  
static TouchGFXHAL hal(dma, display, tc, 390, 390);  
```

--------------------------------

### init()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_block_transition

Initializes the transition state.

```APIDOC
### init()

Initializes the transition.
```

--------------------------------

### init()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_buttons

Performs the necessary configuration of IO pins for button hardware.

```APIDOC
## static void init()

### Description
Performs configuration of IO pins required for button operation.
```

--------------------------------

### init()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_i2_c_touch_controller

Initializes the touch controller hardware.

```APIDOC
## void init()

### Description
Initializes the touch controller hardware. This method must be implemented by subclasses.
```

--------------------------------

### Initialize TouchGFX and ThreadX in main.c

Source: https://support.touchgfx.com/docs/development/touchgfx-hal-development/scenarios/scenarios-configure-rtos

The main function must call the TouchGFX pre-initialization before starting the ThreadX kernel.

```c
int main(void)  
{  
...  
  /* Call PreOsInit function */  
  MX_TouchGFX_PreOSInit();  
...  
  MX_ThreadX_Init();  
...  
}  
```

--------------------------------

### TextProvider::initialize

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_text_provider

Initializes the TextProvider with a string format and optional wildcard arguments.

```APIDOC
## void initialize(const Unicode::UnicodeChar * stringFormat, const uint16_t * gsubTable = 0, const FontContextualFormsTable * formsTable = 0, ...)

### Description
Initializes the TextProvider instance with the provided string format and optional tables for glyph substitution and contextual forms.

### Parameters
- **stringFormat** (const Unicode::UnicodeChar *) - The format string to be processed.
- **gsubTable** (const uint16_t *) - Optional glyph substitution table.
- **formsTable** (const FontContextualFormsTable *) - Optional table for contextual forms.
```

--------------------------------

### play

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_video_widget

Starts the video playback.

```APIDOC
## void play()

### Description
Starts playing the video.
```

--------------------------------

### GPIO::init

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_g_p_i_o

Initializes and configures the GPIO pins for use.

```APIDOC
### static void init()

Performs configuration of IO pins.
```

--------------------------------

### getOvershootPercentage

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_scroll_base

Gets the overshoot percentage.

```APIDOC
## uint8_t getOvershootPercentage() const

### Description
Gets overshoot percentage, as previously set using setOvershootPercentage.

### Returns
- **uint8_t**: The overshoot percentage.
```

--------------------------------

### Linker error output for 24bpp

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Example of linker errors encountered when failing to regenerate code after upgrading to TouchGFX 4.20.

```text
Linking TouchGFX/build/bin/target.elf  
        Middlewares/ST/touchgfx/lib/core/cortex_m7/gcc\libtouchgfx.a(PainterRGB888.o): In function `touchgfx::PainterRGB888::paint(unsigned char*, short, short, short, short, unsigned char) const':  
        (.text._ZNK8touchgfx13PainterRGB8885paintEPhssssh+0x18): undefined reference to `touchgfx::paint::rgb888::lineFromColor(unsigned char*, unsigned int, unsigned long, unsigned char)'  
        Middlewares/ST/touchgfx/lib/core/cortex_m7/gcc\libtouchgfx.a(PainterRGB888.o): In function `touchgfx::PainterRGB888::tearDown() const':  
        (.text._ZNK8touchgfx13PainterRGB8888tearDownEv+0x0): undefined reference to `touchgfx::paint::rgb888::tearDown()'  
        collect2.exe: error: ld returned 1 exit status  
```

--------------------------------

### getHeight()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_drawable

Gets the height of this Drawable.

```APIDOC
### int16_t getHeight() const

Gets the height of this Drawable.

#### Returns
- **int16_t** - The height of this Drawable.
```

--------------------------------

### Linker error output for 16bpp

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Example of linker errors encountered when failing to regenerate code after upgrading to TouchGFX 4.20.

```text
Linking TouchGFX/build/bin/target.elf  
Middlewares/ST/touchgfx/lib/core/cortex_m7/gcc\libtouchgfx.a(PainterRGB565.o): In function `touchgfx::PainterRGB565::paint(unsigned char*, short, short, short, short, unsigned char) const':  
(.text._ZNK8touchgfx13PainterRGB5655paintEPhssssh+0x1a): undefined reference to `touchgfx::paint::rgb565::lineFromColor(unsigned short*, unsigned int, unsigned long, unsigned char, unsigned long)'  
Middlewares/ST/touchgfx/lib/core/cortex_m7/gcc\libtouchgfx.a(PainterRGB565.o): In function `touchgfx::PainterRGB565::tearDown() const':  
(.text._ZNK8touchgfx13PainterRGB5658tearDownEv+0x0): undefined reference to `touchgfx::paint::rgb565::tearDown()'  
collect2.exe: error: ld returned 1 exit status  
```

--------------------------------

### setMoveAnimationDelay

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_move_animator

Sets a delay before the animation starts.

```APIDOC
## setMoveAnimationDelay(uint16_t delay)

### Description
Sets a delay in ticks before the animation begins.

### Parameters
- **delay** (uint16_t) - The delay in ticks.
```

--------------------------------

### IAR Linking Error Output

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Example of the duplicate definition errors encountered in IAR when upgrading projects to TouchGFX 4.21.

```text
Error[Li006]: duplicate definitions for "HAL_CPU2D_CommandListCpltCallback"; in "...\Obj\nema_hal.o", and "...\Obj\nema_hal_threadx.o"  
Error[Li006]: duplicate definitions for "nema_buffer_create"; in "...\Obj\nema_hal.o", and "...\Obj\nema_hal_threadx.o"  
...  
```

--------------------------------

### Generated Typography Font Indices

Source: https://support.touchgfx.com/docs/miscellaneous/known-issues

Example of how the Text Converter generates font IDs for default and language-specific settings in ApplicationFontProvider.hpp.

```cpp
struct TypographyFontIndex  
{  
    static const touchgfx::FontId HEADLINE = 0;  
    static const touchgfx::FontId HEADLINE_AUTO_GENERATED_FOR_JPN = 1;  
};
```

--------------------------------

### initialize(const Unicode::UnicodeChar *stringFormat, const uint16_t *gsubTable, const FontContextualFormsTable *formsTable, ...)

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_text_provider

Initializes the TextProvider with a format string and optional substitution tables using variable arguments.

```APIDOC
## void initialize(const Unicode::UnicodeChar *stringFormat, const uint16_t *gsubTable = 0, const FontContextualFormsTable *formsTable = 0, ...)

### Description
Initializes the TextProvider. Each '\2' character in the format is replaced by one UnicodeChar* argument.

### Parameters
- **stringFormat** (const Unicode::UnicodeChar *) - The string to format.
- **gsubTable** (const uint16_t *) - Optional pointer to GSUB table with Unicode substitution rules.
- **formsTable** (const FontContextualFormsTable *) - Optional pointer to contextual forms table with Unicode substitution rules (for arabic).
- **...** (Variable arguments) - Additional information for formatting.
```

--------------------------------

### setFadeAnimationDelay

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_fade_animator

Sets a delay before the animation starts.

```APIDOC
## void setFadeAnimationDelay(uint16_t delay)

### Description
Sets a delay in ticks before the actual animation starts.
```

--------------------------------

### setup

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_slide_menu

Initializes the SlideMenu with a background bitmap and expand direction. The menu dimensions are automatically set based on the provided background bitmap.

```APIDOC
## void setup(ExpandDirection newExpandDirection, const Bitmap &backgroundBMP, int16_t backgroundX, int16_t backgroundY)

### Description
Configures the SlideMenu with a background image and defines the direction in which the menu expands. The background position is relative to the SlideMenu container.

### Parameters
- **newExpandDirection** (ExpandDirection) - The direction in which the menu expands.
- **backgroundBMP** (const Bitmap &) - The bitmap used as the menu background.
- **backgroundX** (int16_t) - The X coordinate of the background relative to the menu.
- **backgroundY** (int16_t) - The Y coordinate of the background relative to the menu.
```

--------------------------------

### getRenderingAlgorithm

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_texture_mapper

Gets the algorithm used when rendering.

```APIDOC
## getRenderingAlgorithm

### Description
Gets the algorithm used when rendering (NEAREST_NEIGHBOR or BILINEAR_INTERPOLATION).

### Returns
- **RenderingAlgorithm** - The algorithm used.
```

--------------------------------

### Integrate TouchGFX in main.c

Source: https://support.touchgfx.com/docs/development/scenarios/touchgfx-with-mx2

Initialize and process TouchGFX within a bare-metal main loop.

```c
#include "main.h"  
#include "app_touchgfx.h"  
  
int main(void)  
{  
  if (mx_system_init() != SYSTEM_OK)  
  {  
    return (-1);  
  }  
  else  
  {  
    MX_TouchGFX_Init();  
  
    while (1)  
    {  
      MX_TouchGFX_Process();  
    }  
  }  
}  
```

--------------------------------

### Set Click Action in setupScreen

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/mixins

Assigns the callback to the widget during the setupScreen phase.

```cpp
void Screen1View::setupScreen()  
{  
    // Add the callback to box  
    box.setClickAction(boxClickedCallback);  
}  
```

--------------------------------

### getSwipeAcceleration

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_scroll_base

Gets the swipe acceleration value.

```APIDOC
## uint16_t getSwipeAcceleration() const

### Description
Gets swipe acceleration (times 10). The value is multiplied by 10 to avoid floating point arithmetic.

### Returns
- **uint16_t**: The swipe acceleration.
```

--------------------------------

### Implement RTOS-based sampleTouch

Source: https://support.touchgfx.com/docs/development/touchgfx-hal-development/touchgfx-architecture

Example implementation of sampleTouch using an RTOS message queue to retrieve touch data.

```cpp
bool STM32TouchController::sampleTouch(int32_t& x, int32_t& y)  
{  
    if (osMessageQueueGet(mid_MsgQueue, &msg, NULL, 0U) == osOK)  
    {  
        x = msg.x;  
        y = msg.y;  
        return true;  
    }  
    return false;  
}  
```

--------------------------------

### getNumberOfItems

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_scroll_base

Gets the number of items in the DrawableList.

```APIDOC
## virtual int16_t getNumberOfItems() const

### Description
Gets the number of items in the DrawableList, as previously set using setNumberOfItems().

### Returns
- **int16_t**: The number of items.
```

--------------------------------

### getSelectedItemMarginBefore

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_scroll_wheel_with_selection_style

Gets the margin before the selected item.

```APIDOC
virtual int16_t getSelectedItemMarginBefore() const

Returns the margin applied before the selected item.
```

--------------------------------

### getSelectedItemMarginAfter

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_scroll_wheel_with_selection_style

Gets the margin after the selected item.

```APIDOC
virtual int16_t getSelectedItemMarginAfter() const

Returns the margin applied after the selected item.
```

--------------------------------

### Initialize List Layout in ViewBase

Source: https://support.touchgfx.com/docs/development/ui-development/ui-components/containers/list-layout

Shows the generated setup for a List Layout within a Screen1ViewBase constructor, including direction and child addition.

```cpp
#include <gui_generated/screen1_screen/Screen1ViewBase.hpp>  
#include <touchgfx/Color.hpp>  
  
Screen1ViewBase::Screen1ViewBase()  
{  
    listLayout1.setDirection(touchgfx::SOUTH);  
    listLayout1.setXY(90, 111);  
  
    box1.setWidth(50);  
    box1.setHeight(50);  
    box1.setColor(touchgfx::Color::getColorFromRGB(255, 255, 255));  
    listLayout1.add(box1);  
  
    add(listLayout1);  
}  
```

--------------------------------

### getDirection()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_list_layout

Gets the current direction of the ListLayout.

```APIDOC
### getDirection()

Gets the direction of the ListLayout.
```

--------------------------------

### initialize(const Unicode::UnicodeChar *stringFormat, va_list pArg, const uint16_t *gsubTable, const FontContextualFormsTable *formsTable)

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_text_provider

Initializes the TextProvider with a format string and a va_list of arguments.

```APIDOC
## void initialize(const Unicode::UnicodeChar *stringFormat, va_list pArg, const uint16_t *gsubTable = 0, const FontContextualFormsTable *formsTable = 0)

### Description
Initializes the TextProvider. Each '\2' character in the format is replaced by one UnicodeChar* argument from pArg.

### Parameters
- **stringFormat** (const Unicode::UnicodeChar *) - The string to format.
- **pArg** (va_list) - Format arguments in the form of a va_list.
- **gsubTable** (const uint16_t *) - Optional pointer to GSUB table with Unicode substitution rules.
- **formsTable** (const FontContextualFormsTable *) - Optional pointer to contextual forms table with Unicode substitution rules (for arabic).
```

--------------------------------

### HAL::getDisplayHeight

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_h_a_l_s_d_l2

Gets the display height.

```APIDOC
### Method
`uint16_t getDisplayHeight() const`

### Description
Gets display height.
```

--------------------------------

### init()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_i2_c

Initializes the I2C driver.

```APIDOC
### init()

Initializes the I2C driver.
```

--------------------------------

### HAL::getDisplayWidth

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_h_a_l_s_d_l2

Gets the display width.

```APIDOC
### Method
`uint16_t getDisplayWidth() const`

### Description
Gets display width.
```

--------------------------------

### sample()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_buttons

Samples the current state of the physical buttons.

```APIDOC
## static unsigned int sample()

### Description
Sample button states.

### Returns
- **unsigned int** - The sampled state of the buttons.
```

--------------------------------

### Define file groups in .extSettings

Source: https://support.touchgfx.com/docs/development/scenarios/adding-files-to-stm32cubemx-projet

Create project groups and assign files to them using the Groups section syntax.

```text
<Group name> = <file pathname1>;< file pathname2>  
```

--------------------------------

### getRect

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_drawable

Gets the rectangle covered by the drawable.

```APIDOC
## getRect()

### Description
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
```

--------------------------------

### getBlitCaps

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_d_m_a___interface

Gets the blit capabilities of this DMA.

```APIDOC
## BlitOperations getBlitCaps()

### Description
Gets the blit capabilities of this DMA.

### Returns
- **BlitOperations** - The blit operations supported by this DMA implementation.
```

--------------------------------

### setupSecondHand(BitmapId secondHandBitmapId, int16_t rotationCenterX, int16_t rotationCenterY)

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_analog_clock

Configures the second hand bitmap and its rotation center.

```APIDOC
## setupSecondHand(BitmapId secondHandBitmapId, int16_t rotationCenterX, int16_t rotationCenterY)

### Description
Sets up the second hand. The specified rotation center is the point of the hand that is to be placed on top of the clock rotation center. If no second hand is setup it will just be omitted.

### Parameters
- **secondHandBitmapId** (BitmapId) - Identifier for the second hand bitmap.
- **rotationCenterX** (int16_t) - The hand rotation center x coordinate.
- **rotationCenterY** (int16_t) - The hand rotation center y coordinate.
```

--------------------------------

### Load BMP Data in setupScreen

Source: https://support.touchgfx.com/docs/development/ui-development/scenarios/loading-images-at-runtime

Use the BMPFileLoader to read dimensions, create a dynamic bitmap, and assign it to the Image widget.

```cpp
void TemplateView::setupScreen()  
{  
    FILE* f = fopen("image.jpg", "rb");  
    uint16_t width, height;  
  
    //Get the image dimensions from the BMP file  
    BMPFileLoader::getBMP24Dimensions(f, width, height);  
    BitmapId bmpId;  
  
    //Create (16bit) dynamic bitmap of same dimension  
    bmpId = Bitmap::dynamicBitmapCreate(width, height, Bitmap::RGB565);  
  
    //Load pixels from BMP file to dynamic bitmap  
    BMPFileLoader::readBMP24File(Bitmap(bmpId), f);  
  
    //Make Image show the loaded bitmap  
    image.setBitmap(Bitmap(bmpId));  
  
    //Position image and add to View  
    image.setXY(20, 20);  
    add(image);  
    ...  
}  
```

--------------------------------

### isVisible

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_cacheable_container

Gets whether this Drawable is visible.

```APIDOC
## bool isVisible()

### Description
Gets whether this Drawable is visible.
```

--------------------------------

### Installing a Binary Translation

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/using-binary-translations

Load a binary translation file from a filesystem and register it with the TouchGFX Text engine.

```cpp
//read the translation into this global array  
uint8_t translation[10000];  
...  
  
//read the translation from a file, or change array to a pointer that points  
//to the translation data in internal or addressable external flash  
FILE* file = fopen("generated/texts/binary/LanguageGb.bin", "rb");  
if (file)  
{  
    //read data from file  
    fread(translation, 1, 10000, file);  
    fclose(file);  
  
    //replace empty translation with the binary data  
    Texts::setTranslation(GB, translation);  
  
    //always change language to get TouchGFX changed from the  
    //empty translation compiled in to the binary translation  
    Texts::setLanguage(GB);  
}  
```

--------------------------------

### setFadeAnimationDelay

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_fade_animator

Sets a delay before the actual animation starts.

```APIDOC
virtual void setFadeAnimationDelay(uint16_t delay)

Sets a delay in ticks before the animation starts.
```

--------------------------------

### Compile and Run Simulator via Command Line

Source: https://support.touchgfx.com/docs/development/ui-development/working-with-touchgfx/simulator

Commands to build and execute the simulator application within the TouchGFX environment.

```bash
make -f simulator/gcc/Makefile -j6
```

```bash
./build/bin/simulator.exe
```

--------------------------------

### sample(uint8_t & key)

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_button_controller

Samples external key events.

```APIDOC
## virtual bool sample(uint8_t & key)

### Description
Sample external key events.

### Parameters
- **key** (uint8_t &) - Required - Output parameter that will be set to the key value if a keypress was detected.

### Returns
- **bool** - True if a keypress was detected and the "key" parameter is set to a value.
```

--------------------------------

### getBoundingRect

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_texture_mapper

Gets the bounding rectangle of the transformed bitmap.

```APIDOC
## getBoundingRect

### Description
Gets the smallest possible rectangle which covers the image of the bitmap after applying scale and rotation.

### Returns
- **Rect** - The bounding rectangle.
```

--------------------------------

### init()

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_button_controller

Initializes the button controller.

```APIDOC
## virtual void init()

### Description
Initializes the button controller.
```

--------------------------------

### Configure TouchGFX main loop in main.c

Source: https://support.touchgfx.com/docs/development/touchgfx-hal-development/scenarios/scenarios-configure-rtos

Shows the placement of the TouchGFX process call within the infinite loop for non-OS configurations.

```c
/* Infinite loop */  
/* USER CODE BEGIN WHILE */  
while (1)  
{  
  /* USER CODE END WHILE */  
  MX_TouchGFX_Process();  
  /* USER CODE BEGIN 3 */  
}  
```

--------------------------------

### getNumberOfPages

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_swipe_container

Gets the total number of pages in the container.

```APIDOC
### uint8_t getNumberOfPages()

Gets number of pages.

#### Returns
- **uint8_t** - The number of pages.
```

--------------------------------

### init

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_s_d_l_touch_controller

Initializes the touch controller for the simulator.

```APIDOC
## void init()

### Description
Initializes the touch controller. This method prepares the controller for processing touch input events within the simulator.
```

--------------------------------

### getAnimationDuration

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_swipe_container

Gets the animation duration for swiping with a button.

```APIDOC
### uint8_t getAnimationDuration()

Gets the animation duration for swiping with button.

#### Returns
- **uint8_t** - The animation's duration.
```

--------------------------------

### touchgfx_generic_init

Source: https://support.touchgfx.com/docs/api/namespacetouchgfx

Initializes the TouchGFX HAL with specific hardware interfaces.

```APIDOC
## 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)

### Description
Performs generic initialization of the TouchGFX HAL, setting up DMA, display, and touch controller interfaces.

### Parameters
- **dma** (DMA_Interface &) - Required - Reference to the DMA implementation object.
- **display** (LCD &) - Required - Reference to the LCD renderer implementation.
- **tc** (TouchController &) - Required - Reference to the touch controller driver.
- **width** (int16_t) - Required - Native display width in pixels.
- **height** (int16_t) - Required - Native display height in pixels.
- **bitmapCache** (uint16_t *) - Optional - Pointer to memory region for bitmap cache.
- **bitmapCacheSize** (uint32_t) - Optional - Size of bitmap cache in bytes.
- **numberOfDynamicBitmaps** (uint32_t) - Optional - Number of dynamic bitmaps.

### Returns
- **HAL &** - A reference to the allocated and initialized HAL object.
```

--------------------------------

### getMCULoadPct

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_h_a_l

Gets the current MCU load percentage.

```APIDOC
## uint8_t getMCULoadPct()

### Description
Gets the current MCU load.

### Returns
- **uint8_t** - The MCU Load in %.
```

--------------------------------

### Initialize Video Widget in Generated Code

Source: https://support.touchgfx.com/docs/development/ui-development/ui-components/miscellaneous/video

Shows the setup of a video widget within the View base class, including position, repeat settings, and data source assignment.

```cpp
#include <gui_generated/main_screen/mainViewBase.hpp>  
#include <videos/VideoDatabase.hpp>  
  
mainViewBase::mainViewBase()  
{  
    video.setPosition(0, 0, 480, 272);  
    video.setRepeat(true);  
    video.setVideoData(video_SampleVideo1_480x272_bin_start, video_SampleVideo1_480x272_bin_length);  
    video.play();  
  
    add(video);  
}  
```

--------------------------------

### HAL::getMCULoadPct

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_h_a_l_s_d_l2

Gets the current MCU load.

```APIDOC
### Method
`uint8_t getMCULoadPct() const`

### Description
Gets the current MCU load.
```

--------------------------------

### getTitleRotation

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_graph_title

Gets the current rotation of the graph title.

```APIDOC
### TextRotation getTitleRotation() const

Returns the current TextRotation applied to the title.
```

--------------------------------

### getStringWidth

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_font

Gets the width in pixels of the specified string.

```APIDOC
## uint16_t getStringWidth(const Unicode::UnicodeChar * text, ...)

### Description
Gets the width in pixels of the specified string. If the string contains multiple lines, the width of the widest line is found.

### Parameters
- **text** (const Unicode::UnicodeChar *) - A null-terminated Unicode string.
- **...** (Variable arguments) - Additional information.

### Returns
- **uint16_t** - The width in pixels of the longest line.
```

--------------------------------

### setup

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_c_w_r_vector_renderer

Initializes a new drawing session within a specified canvas area and invalidated area.

```APIDOC
## void setup(const Rect &canvasAreaAbs, const Rect &invalidatedAreaRel)

### Description
Starts a new drawing (invalidated area) within the given canvas area. The canvas area typically corresponds to the area of a Widget and is given in absolute coordinates, whereas the invalidated area is given in relative coordinates.

### Parameters
- **canvasAreaAbs** (const Rect &) - The canvas dimensions in absolute coordinates.
- **invalidatedAreaRel** (const Rect &) - The area which should be updated in relative coordinates.
```

--------------------------------

### getRed

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_color

Gets the red color part of a color.

```APIDOC
## getRed

### Description
Gets the red color part of a color.

### Parameters
- **color** (colortype) - The color value.

### Returns
- **uint8_t** - The red part of the color (0 to 255).
```

--------------------------------

### Animated Image Generated Setup

Source: https://support.touchgfx.com/docs/development/ui-development/ui-components/images/animated-image

Shows how TouchGFX Designer initializes an Animated Image within the generated View base class.

```cpp
#include <gui_generated/main_screen/mainViewBase.hpp>  
#include "BitmapDatabase.hpp"  
  
mainViewBase::mainViewBase()  
{  
  
    image.setXY(0, 0);  
    image.setBitmap(touchgfx::Bitmap(BITMAP_BLUE_BACKGROUNDS_MAIN_BG_TEXTURE_480X272PX_ID));  
  
    animatedImage.setXY(0, -104);  
    animatedImage.setBitmaps(BITMAP_BUTTERFLY_01_ID, BITMAP_BUTTERFLY_72_ID);  
    animatedImage.setUpdateTicksInterval(2);  
    animatedImage.startAnimation(false, true, true);  
  
    add(image);  
    add(animatedImage);  
}  
  
void mainViewBase::setupScreen()  
{  
  
}  
```

--------------------------------

### getGreen

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_color

Gets the green color part of a color.

```APIDOC
## static uint8_t getGreen(colortype color)

### Description
Gets the green color part of a color.

### Parameters
- **color** (colortype) - The color value.

### Returns
- **uint8_t** - The green part of the color (0 to 255).
```

--------------------------------

### Setting Callback Action

Source: https://support.touchgfx.com/docs/development/ui-development/touchgfx-engine-features/mixins

Registers the callback with the widget in the setupScreen method.

```cpp
void Screen1View::setupScreen()  
{  
  // Add the callback to box  
  box.setFadeAnimationEndedAction(boxFadeAnimationEndedCallback);  
}  
```

--------------------------------

### getBlue

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_color

Gets the blue color part of a color.

```APIDOC
## static uint8_t getBlue(colortype color)

### Description
Gets the blue color part of a color.

### Parameters
- **color** (colortype) - The color value.

### Returns
- **uint8_t** - The blue part of the color (0 to 255).
```

--------------------------------

### getKerning

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_const_font

Gets the kerning distance between two characters.

```APIDOC
## virtual int8_t getKerning(Unicode::UnicodeChar prevChar, const GlyphNode * glyph) const = 0

### Description
Gets the kerning distance between two characters.
```

--------------------------------

### sdl_init

Source: https://support.touchgfx.com/docs/api/classes/classtouchgfx_1_1_h_a_l_s_d_l2

Initializes the SDL environment for the simulator.

```APIDOC
### bool sdl_init(int argcount, char **args)
Initializes SDL.

#### Parameters
- **argcount** (int) - Number of arguments.
- **args** (char **) - Arguments.

#### Returns
- **bool** - True if init went well, false otherwise.
```
Tokens:
Raw