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