view docs/man3/SDL_GetRGB.3 @ 4440:7bb8f748a14d SDL-1.2

Fixed bug 978 Yann Leprince 2010-03-31 11:07:53 PDT Please add a #serial line as below to sdl.m4 and increase the serial number with each revision of this file. This allows using aclocal --install, thereby enabling automatic updating of sdl.m4 in SDL-based packages that distribute it. # serial 1 The complete documentation and rationale for #serial can be found in the Automake documentation: <http://www.gnu.org/software/automake/manual/html_node/Serials.html>.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 23 Apr 2010 02:19:19 -0700
parents 1238da4a7112
children
line wrap: on
line source

.TH "SDL_GetRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_GetRGB \- Get RGB values from a pixel in the specified pixel format\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBvoid \fBSDL_GetRGB\fP\fR(\fBUint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b\fR);
.SH "DESCRIPTION"
.PP
Get RGB component values from a pixel stored in the specified pixel format\&.
.PP
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])\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01