SDL_GetClipboardData(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_GetClipboardData(3) 💖

okay bestie, so this one lives in the SDL3 FUNCTIONS part of the manual, and it's literally your backstage pass to whatever the clipboard is holding rn. Let's get into it ✨

🌸 NAME 🌸

SDL_GetClipboardData — grab the data sitting on the clipboard for a mime type you pick 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_clipboard.h>

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

✨ DESCRIPTION ✨

So like, the size of text data does not include the terminator, but the text is guaranteed to be null-terminated. Both things are true at once, she contains multitudes 💅

🎀 FUNCTION PARAMETERS 🎀

  • mime_type — the mime type you wanna read off the clipboard. pick your fighter 🫶
  • size — a pointer that gets filled in with the length of the returned data. she's an out-param, she's doing her job 📏

🔥 RETURN VALUE 🔥

Returns the retrieved data buffer, or NULL on failure 😭 — in that case call SDL_GetError() for more info, she'll tell you what went wrong.

⚠️ no cap: you must free that buffer with SDL_free() once you're done with it. don't just leave it sitting there, that's not main character energy, that's a leak 💀

💜 THREAD SAFETY 💜

This function should only be called on the main thread. do not be texting the clipboard from a side thread bestie, she will not answer 🙈

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. vintage but make it fresh ✨

🫶 SEE ALSO 🫶

iykyk, go read those next, they're the whole friend group 💖

mwah okay that's the whole page!! brought to you by the fine folks at Simple Directmedia Layer, from SDL 3.4.18, and yes this specific page is SDL_GetClipboardData(3) 🦋 go get that clipboard data queen 👑

📦 where this page comes from