SDL_GetDisplayForRect(3)

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

💖 SDL_GetDisplayForRect(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we find out which screen a lil rectangle is living on 🖥️✨

🌸 NAME 🌸

SDL_GetDisplayForRect — get the display primarily containing a rect. that's the whole vibe, no cap 💅

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_video.h>

SDL_DisplayID SDL_GetDisplayForRect(const SDL_Rect *rect);

🎀 FUNCTION PARAMETERS 🎀

  • rect — the rect you're querying, girl. hand it over and let's see where it belongs 🫶

✨ RETURN VALUE ✨

On success you get back the instance ID of the display that entirely contains the rect — or, if nobody fully claims it, the display closest to the center of the rect 👑 If it fails? You get 0, and bestie you're gonna wanna call SDL_GetError() for more information because that's where the tea is 😭

💀 THREAD SAFETY 💀

This function should only be called on the main thread. periodt. don't be out here on a side thread thinking you're the main character, because in this case the main thread literally is 🧚

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0 — so if you're on anything older, no it isn't, sorry bestie 💜

⭐ SEE ALSO ⭐

iykyk, go read those next 🎀

mwah 💋 this page came to you from Simple Directmedia Layer, rockin' SDL 3.4.18 — now go find your display and slay 💅✨

📦 where this page comes from