(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetClipboardText

Get UTF-8 text from the clipboard.

Header File

Syntax

char * SDL_GetClipboardText(void);

Return Value

(char *) Returns the clipboard text on success or an empty string on failure; call SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

Remarks

This functions returns an empty string if there was not enough memory left for a copy of the clipboard's content.

Thread Safety

You may only call this function from the main thread.

Version

This function is available since SDL 3.1.3.