aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.322
1 files changed, 22 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3 b/distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3
new file mode 100644
index 0000000..03d78d8
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_MapRGBA.3
@@ -0,0 +1,22 @@
+.TH "SDL_MapRGBA" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_MapRGBA \- Map a RGBA color value to a pixel format\&.
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBUint32 \fBSDL_MapRGBA\fP\fR(\fBSDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a\fR);
+.SH "DESCRIPTION"
+.PP
+Maps the RGBA color value to the specified pixel format and returns the pixel value as a 32-bit int\&.
+.PP
+If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned\&.
+.PP
+If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette)\&.
+.SH "RETURN VALUE"
+.PP
+A pixel value best approximating the given RGBA color value for a given pixel format\&. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e\&.g\&., with a 16-bpp format the return value can be assigned to a \fBUint16\fP, and similarly a \fBUint8\fP for an 8-bpp format)\&.
+.SH "SEE ALSO"
+.PP
+\fISDL_GetRGB\fR, \fISDL_GetRGBA\fR, \fISDL_MapRGB\fR, \fISDL_PixelFormat\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01