TTF_DeleteTextString(3)

TTF_DeleteTextString3

Delete utf-8 text from a text object.

Usage

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_DeleteTextString(TTF_Text *text, int offset, int length);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

This function may cause the internal text representation to be rebuilt.

Function parameters

text

the TTF_Text
to modify.

offset

the offset, in bytes, from the beginning of the string if >= 0, the offset from the end of the string if < 0. Note that this does not do UTF-8 validation, so you should only delete at UTF-8 sequence boundaries.

length

the length of text to delete, in bytes, or -1 for the remainder of the string.

Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should be called on the thread that created the text.

Availability

This function is available since SDL_ttf 3.0.0.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.