SDL_Overlay(3)

✨ SDL_Overlay ✨

okay bestie, welcome to the YUV video overlay page 💖 this is from the SDL API Reference and it's lowkey iconic.

🎀 NAME 🎀

SDL_Overlay — YUV video overlay. that's it, that's the whole vibe 🦋

🧚 STRUCTURE DEFINITION 🧚

here's the whole struct, no cap, every field exactly as it is:

typedef struct{
  Uint32 format;
  int w, h;
  int planes;
  Uint16 *pitches;
  Uint8 **pixels;
  Uint32 hw_overlay:1;
} SDL_Overlay;

🌸 STRUCTURE DATA 🌸

• format — the overlay format, and there's a whole list of those down below 👇
• w, h — width and height of the overlay, obviously 💅
• planes — how many planes are in the overlay. usually it's either 1 or 3, no in-between energy
• pitches — an array of pitches, one for each plane. a pitch is the length of a row, in bytes 📏
• pixels — an array of pointers to the data of each plane. bestie, listen: the overlay should be locked before you touch these pointers, fr fr 🔒
• hw_overlay — this gets set to 1 if the overlay is hardware accelerated ⚡ main character energy

💜 DESCRIPTION 💜

so a SDL_Overlay is basically a SDL_Surface's cousin, except instead of regular pixel data it stores a YUV overlay. same family, different vibe 🫶

every single field is read only — all of them — except pixels, which you gotta lock before you use it. the format field stores the format of the overlay, and it's one of these:

#define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
#define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
#define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
#define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
#define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */

if you want more info on YUV formats (and honestly, who doesn't), it's at http://www.webartz.com/fourcc/indexyuv.htm (link to URL http://www.webartz.com/fourcc/indexyuv.htm) 🌈

🔥 SEE ALSO 🔥

• SDL_CreateYUVOverlay
• SDL_LockYUVOverlay
• SDL_UnlockYUVOverlay
• SDL_FreeYUVOverlay

and that's the page!! mwah 💋 this was SDL, from the SDL API Reference, dated Tue 11 Sep 2001, 23:01 — yeah she's vintage but she ate and left no crumbs 👑✨ go lock your overlays bestie, ily 🍓