NAME¶

SDL_StepBackUTF8 - Decode a UTF-8 string in reverse, one Unicode codepoint at a time.

HEADER FILE¶

Defined in SDL3/SDL_stdinc.h

SYNOPSIS¶

#include "SDL3/SDL.h"

Uint32 SDL_StepBackUTF8(const char *start, const char **pstr);

DESCRIPTION¶

This will go to the start of the previous Unicode codepoint in the string, move pstr to that location and return that codepoint.

If pstr is already at the start of the string), it will not advance *pstr at all.

Generally this function is called in a loop until it returns zero, adjusting its parameter each iteration.

If an invalid UTF-8 sequence is encountered, this function returns

SDL_INVALID_UNICODE_CODEPOINT .

Several things can generate invalid UTF-8 sequences, including overlong encodings, the use of UTF-16 surrogate values, and truncated data. Please refer to

⟨URL: ⟩

for details.

FUNCTION PARAMETERS¶

start

a pointer to the beginning of the UTF-8 string.

pstr

a pointer to a UTF-8 string pointer to be read and adjusted.

RETURN VALUE¶

Returns the previous Unicode codepoint in the string.

THREAD SAFETY¶

It is safe to call this function from any thread.

AVAILABILITY¶

This function is available since SDL 3.2.0.