SDL_GetClipboardData(3)

SDL_GetClipboardData3

Get the data from clipboard for a given mime type.

Usage

#include "SDL3/SDL.h"

void * SDL_GetClipboardData(const char *mime_type, size_t *size);

Header file

Defined in SDL3/SDL_clipboard.h

Overview

The size of text data does not include the terminator, but the text is guaranteed to be null terminated.

Function parameters

mime_type

the mime type to read from the clipboard.

size

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

Return value

Returns the retrieved data buffer or NULL on failure; call

SDL_GetError () for more information. This should be freed with SDL_free () when it is no longer needed.

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.