• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_MapRGB</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Video"
14HREF="video.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_SetGammaRamp"
17HREF="sdlsetgammaramp.html"><LINK
18REL="NEXT"
19TITLE="SDL_MapRGBA"
20HREF="sdlmaprgba.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlsetgammaramp.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlmaprgba.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLMAPRGB"
74></A
75>SDL_MapRGB</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN1652"
80></A
81><H2
82>Name</H2
83>SDL_MapRGB&nbsp;--&nbsp;Map a RGB color value to a pixel format.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN1655"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN1656"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>Uint32 <B
106CLASS="FSFUNC"
107>SDL_MapRGB</B
108></CODE
109>(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN1662"
119></A
120><H2
121>Description</H2
122><P
123>Maps the RGB color value to the specified pixel format and returns the
124pixel value as a 32-bit int.</P
125><P
126>If the format has a palette (8-bit) the index of the closest matching
127color in the palette will be returned.</P
128><P
129>If the specified pixel format has an alpha component it will be returned
130as all 1 bits (fully opaque).</P
131></DIV
132><DIV
133CLASS="REFSECT1"
134><A
135NAME="AEN1667"
136></A
137><H2
138>Return Value</H2
139><P
140>A pixel value best approximating the given RGB color value for a given
141pixel format. If the pixel format bpp (color depth) is less than 32-bpp
142then the unused upper bits of the return value can safely be ignored
143(e.g., with a 16-bpp format the return value can be assigned to a
144<SPAN
145CLASS="TYPE"
146>Uint16</SPAN
147>, and similarly a <SPAN
148CLASS="TYPE"
149>Uint8</SPAN
150> for an 8-bpp
151format).</P
152></DIV
153><DIV
154CLASS="REFSECT1"
155><A
156NAME="AEN1672"
157></A
158><H2
159>See Also</H2
160><P
161><A
162HREF="sdlgetrgb.html"
163><TT
164CLASS="FUNCTION"
165>SDL_GetRGB</TT
166></A
167>,
168<A
169HREF="sdlgetrgba.html"
170><TT
171CLASS="FUNCTION"
172>SDL_GetRGBA</TT
173></A
174>,
175<A
176HREF="sdlmaprgba.html"
177><TT
178CLASS="FUNCTION"
179>SDL_MapRGBA</TT
180></A
181>,
182<A
183HREF="sdlpixelformat.html"
184><SPAN
185CLASS="STRUCTNAME"
186>SDL_PixelFormat</SPAN
187></A
188></P
189></DIV
190><DIV
191CLASS="NAVFOOTER"
192><HR
193ALIGN="LEFT"
194WIDTH="100%"><TABLE
195SUMMARY="Footer navigation table"
196WIDTH="100%"
197BORDER="0"
198CELLPADDING="0"
199CELLSPACING="0"
200><TR
201><TD
202WIDTH="33%"
203ALIGN="left"
204VALIGN="top"
205><A
206HREF="sdlsetgammaramp.html"
207ACCESSKEY="P"
208>Prev</A
209></TD
210><TD
211WIDTH="34%"
212ALIGN="center"
213VALIGN="top"
214><A
215HREF="index.html"
216ACCESSKEY="H"
217>Home</A
218></TD
219><TD
220WIDTH="33%"
221ALIGN="right"
222VALIGN="top"
223><A
224HREF="sdlmaprgba.html"
225ACCESSKEY="N"
226>Next</A
227></TD
228></TR
229><TR
230><TD
231WIDTH="33%"
232ALIGN="left"
233VALIGN="top"
234>SDL_SetGammaRamp</TD
235><TD
236WIDTH="34%"
237ALIGN="center"
238VALIGN="top"
239><A
240HREF="video.html"
241ACCESSKEY="U"
242>Up</A
243></TD
244><TD
245WIDTH="33%"
246ALIGN="right"
247VALIGN="top"
248>SDL_MapRGBA</TD
249></TR
250></TABLE
251></DIV
252></BODY
253></HTML
254>