.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_ReadSurfacePixel:
.\"   https://wiki.libsdl.org/SDL_ReadSurfacePixel
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_ReadSurfacePixel
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_ReadSurfacePixel 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_ReadSurfacePixel \- Retrieves a single pixel from a surface\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
.fi
.SH DESCRIPTION
This function prioritizes correctness over speed: it is suitable for unit
tests, but is not intended for use in a game engine\[char46]

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

.SH FUNCTION PARAMETERS
.TP
.I surface
the surface to read
.TP
.I x
the horizontal coordinate, 0 <= x < width
.TP
.I y
the vertical coordinate, 0 <= y < height
.TP
.I r
a pointer filled in with the red channel, 0-255, or NULL to ignore this channel
.TP
.I g
a pointer filled in with the green channel, 0-255, or NULL to ignore this channel
.TP
.I b
a pointer filled in with the blue channel, 0-255, or NULL to ignore this channel
.TP
.I a
a pointer filled in with the alpha channel, 0-255, or NULL to ignore this channel
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]