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

SDL_SetClipboardData

Offer clipboard data to the OS.

Header File

Syntax

bool SDL_SetClipboardData(SDL_ClipboardDataCallback callback, SDL_ClipboardCleanupCallback cleanup, void *userdata, const char **mime_types, size_t num_mime_types);

Function Parameters

SDL_ClipboardDataCallback	callback	a function pointer to the function that provides the clipboard data.
SDL_ClipboardCleanupCallback	cleanup	a function pointer to the function that cleans up the clipboard data.
void *	userdata	an opaque pointer that will be forwarded to the callbacks.
const char **	mime_types	a list of mime-types that are being offered.
size_t	num_mime_types	the number of mime-types in the mime_types list.

Return Value

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

Remarks

Tell the operating system that the application is offering clipboard data for each of the provided mime-types. Once another application requests the data the callback function will be called, allowing it to generate and respond with the data for the requested mime-type.

The size of text data does not include any terminator, and the text does not need to be null terminated (e.g. you can directly copy a portion of a document).

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.