SDL_Init(3)

💖 SDL_Init — bestie edition 💖

okay so we're in the SDL3 FUNCTIONS section of the SDL_Init(3) manual and honestly? this one is a whole vibe. it's the "wake up babe, we're initializing" function. let's get into it 🫶

---

✨ NAME ✨

SDL_Init — Initialize the SDL library. that's it, that's the whole job. she wakes the library up 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_init.h>

bool SDL_Init(SDL_InitFlags flags);

like, that's the entire thing. one function, one flag argument, and then the party starts 🎀

---

🦋 DESCRIPTION 🦋

okay so here's the tea: SDL_Init() literally just forwards to calling SDL_InitSubSystem(). no cap. they are interchangeable, fr fr. but — and this is the girlypop coding-taste part — for readability of your code, SDL_InitSubSystem() might be the one you prefer. it's giving "clear communication" ✨

now the important bit, listen up 👑

• file I/O (for example: SDL_IOFromFile) and threading (SDL_CreateThread) subsystems are initialized by default. you don't gotta do anything, they just show up 💖
• message boxes (SDL_ShowSimpleMessageBox) also attempt to work without initializing the video subsystem, in hopes of being useful in showing an error dialog when SDL_Init fails. so thoughtful of her, honestly 😭
• you must specifically initialize other subsystems if you use them in your application. no mind-reading here bestie
• logging (such as SDL_Log) works without initialization, too. main character energy, doesn't need permission 🌈

flags may be any of the following OR'd together. yes, OR'd — like stacking accessories, you can wear more than one 💅

• SDL_INIT_AUDIO — audio subsystem; automatically initializes the events subsystem 🔊
• SDL_INIT_VIDEO — video subsystem; automatically initializes the events subsystem, and should be initialized on the main thread. (main thread!! don't be messy about it 🚨)
• SDL_INIT_JOYSTICK — joystick subsystem; automatically initializes the events subsystem 🕹️
• SDL_INIT_HAPTIC — haptic (force feedback) subsystem. yes, the rumbly one 💫
• SDL_INIT_GAMEPAD — gamepad subsystem; automatically initializes the joystick subsystem 🎮
• SDL_INIT_EVENTS — events subsystem 📬
• SDL_INIT_SENSOR — sensor subsystem; automatically initializes the events subsystem 🌡️
• SDL_INIT_CAMERA — camera subsystem; automatically initializes the events subsystem 📸

subsystem initialization is ref-counted, bestie. so you must call SDL_QuitSubSystem() for each SDL_InitSubSystem() to correctly shutdown a subsystem manually (or call SDL_Quit() to force shutdown, if you're feeling dramatic 💀). and if a subsystem is already loaded, then this call will increase the ref-count and return. it's just counting, she's not gonna redo the work 💅

also — cute little suggestion — consider reporting some basic metadata about your application before calling SDL_Init, using either SDL_SetAppMetadata() or SDL_SetAppMetadataProperty(). it's giving "introduce yourself before you walk in" 🌸

---

💜 FUNCTION PARAMETERS 💜

• flags — subsystem initialization flags. the little wishlist of what you want woken up.

---

🌟 RETURN VALUE 🌟

returns true on success or false on failure. if it's a fail, call SDL_GetError() for more information — she'll tell you what went wrong, she's not gatekeeping 😌

---

💀 THREAD SAFETY 💀

this function should only be called on the main thread. no side-quests, no background threads, no exceptions. periodt. 🚫

---

👑 AVAILABILITY 👑

this function is available since SDL 3.2.0. iconic, we've had her for a minute 💖

---

🔥 SEE ALSO 🔥

• SDL_SetAppMetadata(3)
• SDL_SetAppMetadataProperty(3)
• SDL_InitSubSystem(3)
• SDL_Quit(3)
• SDL_SetMainReady(3)
• SDL_WasInit(3)

---

and that's the whole page, bestie!! this one came to you from Simple Directmedia Layer, for <b>SDL 3.4.18</b>, and yeah the SDL_Init(3) girlies know exactly what time it is. go forth and initialize responsibly 🫶✨💅