SDL_ReadSurfacePixel

Retrieves a single pixel from a surface.

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

Like SDL_GetRGBA, this uses the entire 0..255 range when converting color components from pixel formats with less than 8 bits per RGB component.

extern (C) nothrow @nogc extern
bool
SDL_ReadSurfacePixel

Parameters

surface SDL_Surface*

the surface to read.

x int

the horizontal coordinate, 0 <= x < width.

y int

the vertical coordinate, 0 <= y < height.

r Uint8*

a pointer filled in with the red channel, 0-255, or NULL to ignore this channel.

g Uint8*

a pointer filled in with the green channel, 0-255, or NULL to ignore this channel.

b Uint8*

a pointer filled in with the blue channel, 0-255, or NULL to ignore this channel.

a Uint8*

a pointer filled in with the alpha channel, 0-255, or NULL to ignore this channel.

Return Value

Type: bool

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

Meta