NAME¶

SDL_SetClipboardData - 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.1.3.

SEE ALSO¶

•(3), SDL_ClearClipboardData(3), •(3), SDL_GetClipboardData(3), •(3), SDL_HasClipboardData(3)