SDL_SetClipboardData - Man Page
Offer clipboard data to the OS.
Header File
Defined in SDL3/SDL_clipboard.h
Synopsis
#include "SDL3/SDL.h" bool SDL_SetClipboardData(SDL_ClipboardDataCallback callback, SDL_ClipboardCleanupCallback cleanup, void *userdata, const char **mime_types, size_t num_mime_types);
Description
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).
Function Parameters
- callback
a function pointer to the function that provides the clipboard data.
- cleanup
a function pointer to the function that cleans up the clipboard data.
- userdata
an opaque pointer that will be forwarded to the callbacks.
- mime_types
a list of mime-types that are being offered.
- num_mime_types
the number of mime-types in the mime_types list.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_ClearClipboardData(3), ·(3), SDL_GetClipboardData(3), ·(3), SDL_HasClipboardData(3)
Referenced By
SDL_ClearClipboardData(3), SDL_ClipboardCleanupCallback.3type(3), SDL_ClipboardDataCallback.3type(3), SDL_GetClipboardData(3), SDL_GetClipboardMimeTypes(3), SDL_HasClipboardData(3).