logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_ReadSurfacePixel - Retrieves a single pixel from a surface.

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10                            SDL_ReadSurfacePixel(3)

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.

Header File

       Defined in SDL3/SDL_surface.h

Name

       SDL_ReadSurfacePixel - Retrieves a single pixel from a surface.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

Synopsis

#include"SDL3/SDL.h"boolSDL_ReadSurfacePixel(SDL_Surface*surface,intx,inty,Uint8*r,Uint8*g,Uint8*b,Uint8*a);

Thread Safety

       This function is not thread safe.

See Also