IMG_LoadICO_IO(3)

💅 IMG_LoadICO_IO(3) — girl help, we're loading an ICO directly

okay so this is a page from the SDL_image3 FUNCTIONS manual, and it's all about the one function that loads your .ico file with zero detective work involved. icon energy only, no cap ✨

---

🌸 NAME 🌸

IMG_LoadICO_IO — Load a ICO image directly.

(no but literally. that's the whole name. it loads ICOs. directly. she said what she said 💅)

---

🎀 SYNOPSIS 🎀

#include <SDL3_image/SDL_image.h>

SDL_Surface * IMG_LoadICO_IO(SDL_IOStream *src);

one include, one function, one SDL_IOStream pointer in, one SDL_Surface * out. that's the whole shebang bestie 🫶

---

🦋 DESCRIPTION 🦋

so here's the vibe: if you know you definitely have an ICO image — like, you're not guessing, you're not hoping, you're certain — then you can call this function. and the slay part? it skips SDL_image's file format detection routines entirely. no sniffing around, no "hmm what could this be", she just goes. 💨

but ngl, generally it's better to use the abstract interfaces. the icons are cute but the abstract ones are the main character here. 👑

also important: there is only an SDL_IOStream interface available here. that's it. that's the only door in. no cap.

---

🍓 FUNCTION PARAMETERS 🍓

• src — an SDL_IOStream to load image data from. that's your data source, your little stream of icon goodness 💖

---

✨ RETURN VALUE ✨

Returns SDL surface, or NULL on error.

so like — surface means yay 🎉, NULL means 😭. check it, bestie. always check it.

---

🔥 AVAILABILITY 🔥

This function is available since SDL_image 3.0.0.

been iconic since 3.0.0, fr fr 💅

---

👑 SEE ALSO 👑

the whole friend group, all here, all direct-loading legends:

• IMG_LoadAVIF_IO(3)
• IMG_LoadBMP_IO(3)
• IMG_LoadCUR_IO(3)
• IMG_LoadGIF_IO(3)
• IMG_LoadJPG_IO(3)
• IMG_LoadJXL_IO(3)
• IMG_LoadLBM_IO(3)
• IMG_LoadPCX_IO(3)
• IMG_LoadPNG_IO(3)
• IMG_LoadPNM_IO(3)
• IMG_LoadQOI_IO(3)
• IMG_LoadSVG_IO(3)
• IMG_LoadTGA_IO(3)
• IMG_LoadTIF_IO(3)
• IMG_LoadWEBP_IO(3)
• IMG_LoadXCF_IO(3)
• IMG_LoadXPM_IO(3)
• IMG_LoadXV_IO(3)

---

🫶 tiny reminder: only call this when you're sure it's an ICO, because she is not doing a vibe check on the format for you. skipping detection is a choice, and it's yours to make 💀

---

and that's the page!! this was served up by SDL_image, version 3.4.4 — go off, 3.4.4, we love a version number that ate 🌈⭐💜