SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Offer clipboard data to the OS.

Header File

Defined in <SDL3/SDL_clipboard.h>


int 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

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


Tell the operating system that the application is offering clipboard data for each of the proivded 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)


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryClipboard

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.