NAME¶

SDL_ClipboardDataCallback - Callback function that will be called when data for the specified mime-type is requested by the OS.

SYNOPSIS¶

#include <SDL3/SDL_clipboard.h>

typedef const void *(SDLCALL *SDL_ClipboardDataCallback)(void *userdata, const char *mime_type, size_t *size);

DESCRIPTION¶

The callback function is called with NULL as the mime_type when the clipboard is cleared or new data is set. The clipboard is automatically cleared in SDL_Quit().

FUNCTION PARAMETERS¶

userdata

a pointer to the provided user data.

mime_type

the requested mime-type.

size

a pointer filled in with the length of the returned data.

RETURN VALUE¶

Returns a pointer to the data for the provided mime-type. Returning NULL or setting the length to 0 will cause zero length data to be sent to the "receiver", which should be able to handle this. The returned data will not be freed, so it needs to be retained and dealt with internally.

AVAILABILITY¶

This function is available since SDL 3.2.0.

SEE ALSO¶

SDL_SetClipboardData(3)