.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_SetClipboardData:
.\"   https://wiki.libsdl.org/SDL_SetClipboardData
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_SetClipboardData
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_SetClipboardData 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_SetClipboardData \- Offer clipboard data to the OS 
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_SetClipboardData(SDL_ClipboardDataCallback callback, SDL_ClipboardCleanupCallback cleanup, void *userdata, const char **mime_types, size_t num_mime_types);
.fi
.SH DESCRIPTION
Tell the operating system that the application is offering clipboard data
for each of the proivded mime-types\[char46] 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\[char46]

The size of text data does not include any terminator, and the text does
not need to be null terminated (e\[char46]g\[char46] you can directly copy a portion of a
document)

.SH FUNCTION PARAMETERS
.TP
.I callback
A function pointer to the function that provides the clipboard data
.TP
.I cleanup
A function pointer to the function that cleans up the clipboard data
.TP
.I userdata
An opaque pointer that will be forwarded to the callbacks
.TP
.I mime_types
A list of mime-types that are being offered
.TP
.I num_mime_types
The number of mime-types in the mime_types list
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_ClearClipboardData (3),
.BR SDL_GetClipboardData (3),
.BR SDL_HasClipboardData (3)