SDL_GetDesktopDisplayMode(3)

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

💖 SDL_GetDesktopDisplayMode — the SDL3 functions era 💖

okay bestie, welcome to SDL_GetDesktopDisplayMode(3), fresh out of the SDL3 FUNCTIONS lineup 🎀

✨ NAME ✨

SDL_GetDesktopDisplayMode — get the tea on the desktop's display mode. like, the actual desktop's, not whatever chaos fullscreen is doing rn 🦋

✨ SYNOPSIS ✨

#include <SDL3/SDL_video.h>

const SDL_DisplayMode * SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);

✨ DESCRIPTION ✨

so here's the thing, and it's the whole point of this function existing: it is NOT the same as SDL_GetCurrentDisplayMode(). 😭

The difference shows up when SDL is running fullscreen and has changed the resolution. In that case, this function returns the previous native display mode — not the current display mode. So yeah, if you're sitting there like "why is this not matching SDL_GetCurrentDisplayMode()", that's why, and it's intentional, and it's iconic behavior actually 💅

✨ FUNCTION PARAMETERS ✨

  • displayID — the instance ID of the display you wanna query. that's it, that's the whole vibe check 🌸

✨ RETURN VALUE ✨

  • Returns a pointer to the desktop display mode, or NULL on failure 😭
  • If you get NULL, hit up SDL_GetError() for more info — it'll tell you what went wrong, fr fr 🫶

✨ THREAD SAFETY ✨

main thread ONLY bestie. do not pass go, do not call this from a worker thread. main character energy only 👑

✨ AVAILABILITY ✨

this one's been around since SDL 3.2.0 ⭐

✨ SEE ALSO ✨

and that's the whole page, no cap 💖 shoutout to Simple Directmedia Layer for shipping this in SDL 3.4.18 — go forth and query your displays, you absolute legend 🎀✨🦋

📦 where this page comes from