---
name: "SDL_ReadSurfacePixel"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_ReadSurfacePixel"
---

# SDL\_ReadSurfacePixel(3)

Retrieves a single pixel from a surface.

## NAME

SDL\_ReadSurfacePixel - Retrieves a single pixel from a surface.

## HEADER FILE

Defined in SDL3/SDL\_surface.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_ReadSurfacePixel(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\_GetRGBA** , 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 read.

- *x*

  the horizontal coordinate, 0 \<= x \< width.

- *y*

  the vertical coordinate, 0 \<= y \< height.

- *r*

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

- *g*

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

- *b*

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

- *a*

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

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

This function is not thread safe.

## AVAILABILITY

This function is available since SDL 3.2.0.
