Wiki Page Content

SDL_GetRGBA

Use this function to get RGBA values from a pixel in the specified format.

Syntax

void SDL_GetRGBA(Uint32                 pixel,
                 const SDL_PixelFormat* format,
                 Uint8*                 r,
                 Uint8*                 g,
                 Uint8*                 b,
                 Uint8*                 a)

Function Parameters

pixel

a pixel value

format

an SDL_PixelFormat structure describing the format of the pixel

r

a pointer filled in with the red component

g

a pointer filled in with the green component

b

a pointer filled in with the blue component

a

a pointer filled in with the alpha component

Code Examples

You can add your code example here

Remarks

This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque).


CategoryAPI, CategoryPixels

None: SDL_GetRGBA (last edited 2013-08-11 13:13:47 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit