(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_WriteSurfacePixel

Writes a single pixel to a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

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

Function Parameters

SDL_Surface *	surface	the surface to write.
int	x	the horizontal coordinate, 0 <= x < width.
int	y	the vertical coordinate, 0 <= y < height.
Uint8	r	the red channel value, 0-255.
Uint8	g	the green channel value, 0-255.
Uint8	b	the blue channel value, 0-255.
Uint8	a	the alpha channel value, 0-255.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This function prioritizes correctness over speed: it is suitable for unit tests, but is not intended for use in a game engine.

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.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.