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