TTF_DeleteTextString - Man Page

Delete UTF-8 text from a text object.

Header File

Defined in SDL3_ttf/SDL_ttf.h

Synopsis

#include "SDL3_ttf/SDL_ttf.h"

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

Description

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.

See Also

·(3), TTF_AppendTextString(3), ·(3), TTF_InsertTextString(3), ·(3), TTF_SetTextString(3)

Referenced By

TTF_AppendTextString(3), TTF_InsertTextString(3), TTF_SetTextString(3).

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS