SDL_GetRenderVSync(3)

💖 SDL_GetRenderVSync 💖

okay bestie, welcome to the SDL3 functions manual, and today's main character is SDL_GetRenderVSync — she's the one who tells you what your renderer's VSync situation is rn. no cap. 🦋

---

✨ NAME ✨

SDL_GetRenderVSync — get the VSync of the given renderer. that's it, that's the whole job. she's a getter, she's nosy, she slays. 💅

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_render.h>

bool SDL_GetRenderVSync(SDL_Renderer *renderer, int *vsync);

look at her. iconic signature. two args, one bool return. periodt. ✨

---

✨ FUNCTION PARAMETERS ✨

• renderer — the renderer to toggle. yes girl, that's literally what the manpage says, we pass the renderer in and she gets poked at. 👑
• vsync — an int that gets filled with the current vertical refresh sync interval. so like, this is where the answer lands, bestie. if you wanna know what the number means, go read SDL_SetRenderVSync() — she's the one holding the lore. 📖

---

✨ RETURN VALUE ✨

returns true on success or false on failure. and if it fails?? call SDL_GetError() for more info, because she will NOT be explaining herself otherwise. 😭

fr fr, always check the return value. don't just assume it worked and then act surprised later. that's not the vibe. 🙈

---

✨ THREAD SAFETY ✨

okay this is important so listen up: this function should only be called on the main thread. no side-quests, no background thread shenanigans. main character energy only, literally. 🎀

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. so if you're on something older, sorry babe, she's not there yet. 🧚

---

✨ SEE ALSO ✨

• SDL_SetRenderVSync(3) — her counterpart, her other half, the one who actually sets the thing. go read her next. 🫶

---

and that's the whole page, bestie!! go forth and get your VSync, you've got this. 🌸

mwah 💋 — brought to you by Simple Directmedia Layer, <strong>SDL 3.4.18</strong>, dated SDL_GetRenderVSync(3) (yeah the date slot is just the page name again, iconic honestly). stay synced. 🌈✨