SDL_UpdateRect(3)

📦 version 1.2.15, in debian bookworm, nixos 26.05, nixpkgs unstable, ubuntu jammy

💖 SDL_UpdateRect(3) — the SDL API Reference glow-up ✨

okay bestie, so this one's from the SDL API Reference and it's giving "make my pixels show up" energy. let's get into it 🫶

🌸 NAME 🌸

SDL_UpdateRect — makes sure the given area is updated on the given screen. that's it, that's the whole job, and she does it flawlessly 💅

✨ SYNOPSIS ✨

#include "SDL.h"

void SDL_UpdateRect(SDL_Surface *screen, Sint32 x, Sint32 y, Sint32 w,
Sint32 h);

like yes, she takes five args. we love a thorough queen 👑

🎀 DESCRIPTION 🎀

so basically, SDL_UpdateRect makes sure the given area is updated on the given screen. iconic. that's her main character moment.

⚠️ but listen, the rectangle must be confined within the screen boundaries — no clipping is done. not a single pixel gets trimmed for you. so don't come at her with a rectangle that's hanging off the edge, she will NOT be fixing that for you 😭

if x, y, w and h are all 0, then SDL_UpdateRect will update the entire screen. zeroes across the board = full-screen slay, no cap 🌈

🚫 and this part is important fr fr: this function should not be called while screen is locked. locked screen + update = do not. just don't. 🙈

🦋 SEE ALSO 🦋

  • SDL_UpdateRects — the plural version, she does many at once 💖
  • SDL_Rect — the rectangle struct of your dreams
  • SDL_Surface — the screen/thing you're drawing on
  • SDL_LockSurface — the lock in question. remember the warning above bestie, iykyk 🔒

and that's the whole page, periodt. 💜 this was pulled straight from the SDL API Reference, dated Tue 11 Sep 2001, 23:01 — a vintage queen, honestly, and she still ate. mwah 🎀✨💅

📦 where this page comes from