SDL_GetDisplayBounds(3)

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

✨ SDL_GetDisplayBounds(3) ✨

okay bestie, so this is a page from the SDL3 FUNCTIONS manual — the whole Simple Directmedia Layer situation — and today we're talking about SDL_GetDisplayBounds. it's giving "where even IS my monitor, actually". 💅

🎀 NAME 🎀

SDL_GetDisplayBounds — get the desktop area represented by a display.

like, the actual rectangle of screen real estate that a display owns. no cap. 🖥️✨

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_video.h>

bool SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);

🦋 DESCRIPTION 🦋

so the whole vibe here is: you hand it a display, it tells you the rectangle that display occupies. easy.

the thing to know — and this is the iconic detail — is that the primary display is often located at (0,0), but it may be placed at a different location depending on monitor layout. so don't just assume (0,0) is home, bestie. multi-monitor setups said "not today". 😭

💖 FUNCTION PARAMETERS 💖

  • displayID — the instance ID of the display you wanna query. the one you're being nosy about. 👀
  • rect — the SDL_Rect structure filled in with the display bounds. this is the lil box that gets the answer dropped into it. 🎁

🔥 RETURN VALUE 🔥

returns true on success or false on failure — and if it fails, call SDL_GetError() for more information. so like, if you get a false, don't spiral, just go read the error. 🫶

👑 THREAD SAFETY 👑

this function should only be called on the main thread.

periodt. don't be cute and try it from a worker thread, it's not that girl. 🚫🧵

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. so if you're on anything older, sorry babe, no bounds for you. 🙈

🌈 SEE ALSO 🌈

iykyk — go read those next, they're the rest of the display lore. 💜

and that's the whole page, bestie!! 🎀 this came to you straight from the Simple Directmedia Layer manual, version SDL 3.4.18 — go forth and query your displays responsibly. mwah. 💖✨🦋🍓🧚

📦 where this page comes from