Hint

Refer to QMK’s documentation for details on how to use community modules

scrolling_text

API to draw scrolling text on QP screens.

struct scrolling_text_config_t

Configuration for how to draw a scrolling text.

painter_device_t device

Screen where to draw.

uint16_t x

X coordinate where to draw.

uint16_t y

Y coordinate where to draw.

painter_font_handle_t font

Font to draw with.

size_t n_chars

Amount of chars being drawn each time.

uint32_t delay

Time between drawing steps.

size_t spaces

Spaces drawn before repetitions of the text.

hsv_t fg

Foreground color.

hsv_t bg

Background color.

const allocator_t *allocator

Allocator to be used.

deferred_token scrolling_text_start(const scrolling_text_config_t *config, const char *str)

Start a scrolling text.

Return: Token of the deferred executor taking care of drawing

void scrolling_text_stop(deferred_token scrolling_token)

Stop a scrolling text.

Parameters:

• scrolling_token – Deferred token returned by the function that started this drawing.