al_get_display_mode(3)

💖 al_get_display_mode(3) 💖

From the Library Functions Manual, bestie — this one’s Allegro 5 API realness ✨.

🌸 NAME 🌸

al_get_display_mode — Allegro 5 API

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

ALLEGRO_DISPLAY_MODE *al_get_display_mode(int index, ALLEGRO_DISPLAY_MODE *mode)

🦋 DESCRIPTION 🦋

Okay so this function retrieves a fullscreen mode — literally that’s the whole assignment, bestie 💅.

Vibe check: display parameters should not be changed between a call of al_get_num_display_modes(3) and al_get_display_mode(3). Do not be messy in that window, fr fr.

index must be between 0 and the number returned from al_get_num_display_modes-1. That’s the valid index zone, no guessing 🎀.

mode must be an allocated ALLEGRO_DISPLAY_MODE structure. Like, actually allocated — not just a cute little pointer with dreams 🌸.

This function will return NULL on failure, and the mode parameter that was passed in on success. So failure gives you NULL; success hands you back the same mode you passed in. Iconic behavior, no cap ✨.

🌈 SEE ALSO 🌈

• ALLEGRO_DISPLAY_MODE(3)
• al_get_num_display_modes(3)

---

Catch you later, bestie 🫶 — this page is from the Allegro reference manual and carries the page tag al_get_display_mode(3). The footer didn’t list a date, so no date reveal today 💀💖.