SDL_ClaimWindowForGPUDevice(3)

💖 SDL_ClaimWindowForGPUDevice(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual, and today's main character is SDL_ClaimWindowForGPUDevice(3) — the glow-up ritual where your plain little window gets a whole swapchain situation. no cap. 🦋

---

✨ NAME ✨

SDL_ClaimWindowForGPUDevice</purgle> — claims a window, creating a swapchain structure for it. it's giving "this window is MINE now, and it comes with accessories". 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_gpu.h>

bool SDL_ClaimWindowForGPUDevice(
    SDL_GPUDevice *device,
    SDL_Window *window);

---

🎀 DESCRIPTION 🎀

okay so the tea is: you must call this before you ever call SDL_AcquireGPUSwapchainTexture using that window. like, there is no getting around it, bestie, the swapchain doesn't exist until you claim it. order matters, periodt. ✨

and listen — you should only call this function from the thread that created the window. the window's thread. its origin thread. do not show up to the window's party uninvited from some other thread, it will not go well. 🙈

when the swapchain gets created, it's born with these defaults:

• SDL_GPU_SWAPCHAINCOMPOSITION_SDR
• SDL_GPU_PRESENTMODE_VSYNC

if you want different swapchain parameters (and honestly, valid), you have to call SDL_SetGPUSwapchainParameters after claiming the window. after. not before. the claim comes first, the customization comes second, that's the timeline. 👑

---

🌈 FUNCTION PARAMETERS 🌈

• device — a GPU context. your GPU device, your vibe, the whole reason any of this works. 🔥
• window — an SDL_Window. yes, the actual window. the one you're claiming. that one. 💖

---

⭐ RETURN VALUE ⭐

returns true on success (slay 🎉), or false on failure (💀). if it's giving failure, call SDL_GetError() for more information — that's where the actual reason is hiding, go read it, don't just sit there guessing.

---

🧚 THREAD SAFETY 🧚

this function should only be called from the thread that created the window. one window, one thread, one unbreakable bond. no side-chick threads allowed on this one. 🫶

---

💜 AVAILABILITY 💜

this function is available since SDL 3.2.0. so if you're on anything older, sorry bestie, no swapchain for you. 😭

---

🍓 SEE ALSO 🍓

• SDL_WaitAndAcquireGPUSwapchainTexture(3)
• SDL_ReleaseWindowFromGPUDevice(3)
• SDL_WindowSupportsGPUPresentMode(3)
• SDL_WindowSupportsGPUSwapchainComposition(3)

---

⚠️ reminder from your girl: claim the window first, from the window's own thread, or nothing downstream is gonna work. that's the whole assignment. 💅

---

and that's the page, bestie!! brought to you by Simple Directmedia Layer, version SDL 3.4.18 — yes this is the SDL_ClaimWindowForGPUDevice(3) page, we been knew. go claim your window and go be iconic. ✨🎀💖