SDL_WriteSurfacePixel(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

✨ SDL_WriteSurfacePixel ✨

okay bestie, welcome to the SDL_WriteSurfacePixel(3) page — part of the SDL3 FUNCTIONS collection, obviously 💅

🌸 NAME 🌸

SDL_WriteSurfacePixel — Writes a single pixel to a surface.

like... one pixel. a single lil guy. that's the whole job 🎀

✨ SYNOPSIS ✨

#include <SDL3/SDL_surface.h>

bool SDL_WriteSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a);

🦋 DESCRIPTION 🦋

okay so here's the vibe: this function is prioritizing correctness over speed. it's not trying to be fast, it's trying to be right. so it's giving very much unit tests energy — but not intended for use in a game engine, bestie, please don't ship it in your render loop 😭

and lowkey important: like SDL_MapRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component. so no weird half-range shenanigans, it's full range, no cap ✨

💖 FUNCTION PARAMETERS 💖

  • surface — the surface to write to. your canvas, your moment, your main character 🫶
  • x — the horizontal coordinate, 0 <= x < width. stay in bounds pls 💀
  • y — the vertical coordinate, 0 <= y < height. same energy, vertical edition 🌈
  • r — the red channel value, 0-255. ❤️
  • g — the green channel value, 0-255. 💚
  • b — the blue channel value, 0-255. 💙
  • a — the alpha channel value, 0-255. 👻

⭐ RETURN VALUE ⭐

Returns true on success or false on failure 🥲 — and if it fails, call SDL_GetError() for more information. she will tell you what went wrong, periodt.

🧚 THREAD SAFETY 🧚

This function can be called on different threads with different surfaces. so like, go off, parallelize — just keep your surfaces separate, iykyk 👑

🌸 AVAILABILITY 🌸

This function is available since SDL 3.2.0. so if you're on anything older... girl. upgrade 💅

no cap: it's correctness-first on purpose. don't be out here using it in a game engine and then acting surprised, bestie 🙈

Simple Directmedia Layer · SDL 3.4.18 · SDL_WriteSurfacePixel(3)

and that's the whole page, mwah 💖 tysm for reading, go write exactly one pixel and slay 🎀🦋✨

📦 where this page comes from