Mercurial > sdl-ios-xcode
comparison docs/man3/SDL_GetRGBA.3 @ 0:74212992fb08
Initial revision
| author | Sam Lantinga <slouken@lokigames.com> |
|---|---|
| date | Thu, 26 Apr 2001 16:45:43 +0000 |
| parents | |
| children | 55f1f1b3e27d |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:74212992fb08 |
|---|---|
| 1 .TH "SDL_GetRGBA" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" | |
| 2 .SH "NAME" | |
| 3 SDL_GetRGBA\- Get RGBA values from a pixel in the specified pixel format\&. | |
| 4 .SH "SYNOPSIS" | |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBvoid \fBSDL_GetRGBA\fP\fR(\fBUint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 Get RGBA component values from a pixel stored in the specified pixel format\&. | |
| 12 .PP | |
| 13 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])\&. | |
| 14 .PP | |
| 15 If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque)\&. | |
| 16 .SH "SEE ALSO" | |
| 17 .PP | |
| 18 \fISDL_GetRGB\fR, \fISDL_MapRGB\fR, \fISDL_MapRGBA\fR, \fISDL_PixelFormat\fR | |
| 19 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 |