SDL_UpdateRects(3)

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

✨ SDL_UpdateRects(3) ✨

okay bestie, we're in the SDL API Reference and this one is literally about pushing a whole list of rectangles to the screen 💖

🌸 NAME 🌸

SDL_UpdateRects — makes sure the given list of rectangles is updated on the given screen. yes, list, plural, we're doing a whole lil squad of rects 💅

🎀 SYNOPSIS 🎀

#include "SDL.h"

void SDL_UpdateRects(SDL_Surface *screen, int numrects, SDL_Rect
*rects);

copy it exactly like that, no cap 🫶

🦋 DESCRIPTION 🦋

So basically: this function makes sure the given list of rectangles is updated on the given screen. That's the whole job. It takes your little collection of rects and says "okay screen, catch these" ✨

BUT. Important. The rectangles must all be confined within the screen boundaries (no clipping is done). So if you go handing it a rect that hangs off the edge, it is not gonna be nice about it and trim it for you — no clipping, none, zero. You gotta keep them inside the screen yourself. Vibe check your coordinates first, fr fr 😭

Also: this function should not be called while screen is locked. Like, do not. That's a locked door, bestie, we don't go in there 🚪🙈

Note: It is adviced to call this function only once per frame, since each call has some processing overhead. This is no restriction since you can pass any number of rectangles each time. (so like… one call, many rects, that's the move. efficiency queen behavior 👑) The rectangles are not automatically merged or checked for overlap. In general, the programmer can use his knowledge about his particular rectangles to merge them in an efficient way, to avoid overdraw. (SDL is not gonna do your homework for you here — you know your rects better than it does, so merge them smart and skip the overdraw 💀✨)

🌈 SEE ALSO 🌈

  • SDL_UpdateRect
  • SDL_Rect
  • SDL_Surface
  • SDL_LockSurface

go read those too, they're all part of the same friend group 🫶

k bye ily, this page came from SDL and it's dated Tue 11 Sep 2001, 23:01 — vintage but iconic, and SDL_UpdateRects(3) is the name, slay 💅💖✨

📦 where this page comes from