(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ReadSurfacePixelFloat

Retrieves a single pixel from a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

bool SDL_ReadSurfacePixelFloat(SDL_Surface *surface, int x, int y, float *r, float *g, float *b, float *a);

Function Parameters

SDL_Surface *	surface	the surface to read.
int	x	the horizontal coordinate, 0 <= x < width.
int	y	the vertical coordinate, 0 <= y < height.
float *	r	a pointer filled in with the red channel, normally in the range 0-1, or NULL to ignore this channel.
float *	g	a pointer filled in with the green channel, normally in the range 0-1, or NULL to ignore this channel.
float *	b	a pointer filled in with the blue channel, normally in the range 0-1, or NULL to ignore this channel.
float *	a	a pointer filled in with the alpha channel, normally in the range 0-1, or NULL to ignore this channel.

Return Value

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

Remarks

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

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.