NAME¶

SDL_WriteSurfacePixel - Writes a single pixel to a surface.

HEADER FILE¶

Defined in SDL3/SDL_surface.h

SYNOPSIS¶

#include "SDL3/SDL.h"

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

DESCRIPTION¶

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.

FUNCTION PARAMETERS¶

surface

the surface to write.

x

the horizontal coordinate, 0 <= x < width.

y

the vertical coordinate, 0 <= y < height.

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; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.1.3.