aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.3
diff options
context:
space:
mode:
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.317
1 files changed, 17 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.3 b/distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.3
new file mode 100644
index 0000000..f21a162
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_GetRGB.3
@@ -0,0 +1,17 @@
+.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