SDL_SetWindowFillDocument(3)

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

💖 SDL_SetWindowFillDocument(3) 💖

okay so bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where today's main character is SDL_SetWindowFillDocument 🎀

✨ NAME ✨

SDL_SetWindowFillDocument — set the window to fill the current document space (Emscripten only). no cap, that's the whole gig 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_video.h>

bool SDL_SetWindowFillDocument(SDL_Window *window, bool fill);

🦋 DESCRIPTION 🦋

so what this does is it adds or removes the window's SDL_WINDOW_FILL_DOCUMENT flag. that's it, that's the vibe ✨

currently this flag only applies to the Emscripten target. like, only Emscripten, fr fr.

when it's enabled, the canvas element fills the entire document. resize events get generated as the browser window is resized, because that resizes the canvas too — it's giving responsive, honestly. and the canvas will cover anything else on the page, including any controls that Emscripten provides in its generated HTML file. in fact, any elements on the page that aren't the canvas get moved into a hidden div element 🙈 like, they're still there, just... banished.

often times this is desirable for a browser-based game 🎮 but bestie, it means several things we expect of an SDL window on other platforms might not work as expected — like minimum window sizes and aspect ratios. so know what you're signing up for, okay? 💀

🌈 FUNCTION PARAMETERS 🌈

  • window — the window of which to change the fill-document state. (your girl 🫶)
  • fill — true to set the window to fill the document, false to disable. on/off, slay/unsay 💅

⭐ RETURN VALUE ⭐

returns true on success or false on failure 😭 and if it's a fail, call SDL_GetError() for more information. she'll tell you what went wrong, i promise.

🧚 THREAD SAFETY 🧚

this function should only be called on the main thread. periodt. don't be chaotic about it 🔥

👑 AVAILABILITY 👑

this function is available since SDL 3.4.0. iconic behavior, honestly 🌟

💜 SEE ALSO 💜

and that's the tea, bestie 🍓 this page came to you from Simple Directmedia Layer, version SDL 3.4.18, and it's literally the SDL_SetWindowFillDocument(3) manual page. go forth and fill that document 💖✨🎀🦋🌸💅🫶

📦 where this page comes from