SDL_GetDisplays(3)

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

💖 SDL_GetDisplays(3) — the SDL3 FUNCTIONS girlies' guide 💖

okay so bestie, welcome to SDL_GetDisplays(3). this is the one that gives you the whole lineup of screens that are plugged into your machine right now. like, every monitor currently connected? yeah, she knows them. she's got the receipts. 🖥️✨

🌸 NAME 🌸

SDL_GetDisplays — get a list of currently connected displays.

that's it. that's the whole job. she lists your displays. iconic behaviour, honestly. 👑

✨ SYNOPSIS ✨

#include <SDL3/SDL_video.h>

SDL_DisplayID * SDL_GetDisplays(int *count);

so you pull in the header, you call the function, you get back a pointer to a whole array of display IDs. it's giving "here's everybody, no cap." 🫶

🎀 FUNCTION PARAMETERS 🎀

  • count — a pointer that gets filled in with the number of displays returned. it may be NULL, so if you literally do not care how many came back, you can just pass NULL and vibe. 💅

🔥 RETURN VALUE 🔥

she returns a 0 terminated array of display instance IDs. or, if things went sideways, NULL on failure — and in that case you gotta call SDL_GetError() for more information. that's your bestie telling you what went wrong. 😭

important: when you're done with that array, free it with SDL_free(). do NOT just walk away from her. that's a memory leak and we don't do that here. 🚫💀

🧚 THREAD SAFETY 🧚

this function should only be called on the main thread. periodt. don't be out here calling her from some random worker thread, she will not answer. main character energy only, on the main thread. 👑

🌈 AVAILABILITY 🌈

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

🦋 and that's the tea 🦋

okay so that's SDL_GetDisplays(3) in full. go forth, enumerate your monitors, free your arrays, and stay on the main thread. mwah. 💜

this lil page comes to you from Simple Directmedia Layer, running SDL 3.4.18. ty for reading, ily, bye bestie!! 🎀✨🌸🫶

📦 where this page comes from