Mercurial > sdl-ios-xcode
annotate docs/html/sdlmaprgb.html @ 3261:72b542f34739
The new, cleaner, version of the atomic operations. The dummy code is what you should start working with to port atomic ops.
The linux code appears to be complete and *should* be the base of all Unix and GCC based versions. The macosx and win32 versions
are currently just copies of the dummy code. I will begin working on the windows version as soon as this check in is done. I
need someone to work on the Mac OS X version.
I'm afraid that this check in will break QNX (Sorry!)
| author | Bob Pendleton <bob@pendleton.com> |
|---|---|
| date | Thu, 17 Sep 2009 20:35:12 +0000 |
| parents | 355632dca928 |
| children |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_MapRGB</TITLE | |
| 5 ><META | |
| 6 NAME="GENERATOR" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
| 0 | 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 | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
| 0 | 32 WIDTH="100%" |
| 33 BORDER="0" | |
| 34 CELLPADDING="0" | |
| 35 CELLSPACING="0" | |
| 36 ><TR | |
| 37 ><TH | |
| 38 COLSPAN="3" | |
| 39 ALIGN="center" | |
| 40 >SDL Library Documentation</TH | |
| 41 ></TR | |
| 42 ><TR | |
| 43 ><TD | |
| 44 WIDTH="10%" | |
| 45 ALIGN="left" | |
| 46 VALIGN="bottom" | |
| 47 ><A | |
| 48 HREF="sdlsetgammaramp.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
| 0 | 50 >Prev</A |
| 51 ></TD | |
| 52 ><TD | |
| 53 WIDTH="80%" | |
| 54 ALIGN="center" | |
| 55 VALIGN="bottom" | |
| 56 ></TD | |
| 57 ><TD | |
| 58 WIDTH="10%" | |
| 59 ALIGN="right" | |
| 60 VALIGN="bottom" | |
| 61 ><A | |
| 62 HREF="sdlmaprgba.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
| 0 | 64 >Next</A |
| 65 ></TD | |
| 66 ></TR | |
| 67 ></TABLE | |
| 68 ><HR | |
| 69 ALIGN="LEFT" | |
| 70 WIDTH="100%"></DIV | |
| 71 ><H1 | |
| 72 ><A | |
| 73 NAME="SDLMAPRGB" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
|
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_MapRGB</H1 |
| 0 | 76 ><DIV |
| 77 CLASS="REFNAMEDIV" | |
| 78 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN1652" |
| 0 | 80 ></A |
| 81 ><H2 | |
| 82 >Name</H2 | |
| 83 >SDL_MapRGB -- Map a RGB color value to a pixel format.</DIV | |
| 84 ><DIV | |
| 85 CLASS="REFSYNOPSISDIV" | |
| 86 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN1655" |
| 0 | 88 ></A |
| 89 ><H2 | |
| 90 >Synopsis</H2 | |
| 91 ><DIV | |
| 92 CLASS="FUNCSYNOPSIS" | |
| 93 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN1656" |
| 0 | 95 ></A |
| 96 ><P | |
| 97 ></P | |
| 98 ><PRE | |
| 99 CLASS="FUNCSYNOPSISINFO" | |
| 100 >#include "SDL.h"</PRE | |
| 101 ><P | |
| 102 ><CODE | |
| 103 ><CODE | |
| 104 CLASS="FUNCDEF" | |
| 105 >Uint32 <B | |
| 106 CLASS="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 | |
| 116 CLASS="REFSECT1" | |
| 117 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN1662" |
| 0 | 119 ></A |
| 120 ><H2 | |
| 121 >Description</H2 | |
| 122 ><P | |
| 123 >Maps the RGB color value to the specified pixel format and returns the | |
| 124 pixel value as a 32-bit int.</P | |
| 125 ><P | |
| 126 >If the format has a palette (8-bit) the index of the closest matching | |
| 127 color in the palette will be returned.</P | |
| 128 ><P | |
| 129 >If the specified pixel format has an alpha component it will be returned | |
| 130 as all 1 bits (fully opaque).</P | |
| 131 ></DIV | |
| 132 ><DIV | |
| 133 CLASS="REFSECT1" | |
| 134 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
135 NAME="AEN1667" |
| 0 | 136 ></A |
| 137 ><H2 | |
| 138 >Return Value</H2 | |
| 139 ><P | |
| 140 >A pixel value best approximating the given RGB color value for a given | |
| 141 pixel format. If the pixel format bpp (color depth) is less than 32-bpp | |
| 142 then 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 | |
| 145 CLASS="TYPE" | |
| 146 >Uint16</SPAN | |
| 147 >, and similarly a <SPAN | |
| 148 CLASS="TYPE" | |
| 149 >Uint8</SPAN | |
| 150 > for an 8-bpp | |
| 151 format).</P | |
| 152 ></DIV | |
| 153 ><DIV | |
| 154 CLASS="REFSECT1" | |
| 155 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
156 NAME="AEN1672" |
| 0 | 157 ></A |
| 158 ><H2 | |
| 159 >See Also</H2 | |
| 160 ><P | |
| 161 ><A | |
| 162 HREF="sdlgetrgb.html" | |
| 163 ><TT | |
| 164 CLASS="FUNCTION" | |
| 165 >SDL_GetRGB</TT | |
| 166 ></A | |
| 167 >, | |
| 168 <A | |
| 169 HREF="sdlgetrgba.html" | |
| 170 ><TT | |
| 171 CLASS="FUNCTION" | |
| 172 >SDL_GetRGBA</TT | |
| 173 ></A | |
| 174 >, | |
| 175 <A | |
| 176 HREF="sdlmaprgba.html" | |
| 177 ><TT | |
| 178 CLASS="FUNCTION" | |
| 179 >SDL_MapRGBA</TT | |
| 180 ></A | |
| 181 >, | |
| 182 <A | |
| 183 HREF="sdlpixelformat.html" | |
| 184 ><SPAN | |
| 185 CLASS="STRUCTNAME" | |
| 186 >SDL_PixelFormat</SPAN | |
| 187 ></A | |
| 188 ></P | |
| 189 ></DIV | |
| 190 ><DIV | |
| 191 CLASS="NAVFOOTER" | |
| 192 ><HR | |
| 193 ALIGN="LEFT" | |
| 194 WIDTH="100%"><TABLE | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
195 SUMMARY="Footer navigation table" |
| 0 | 196 WIDTH="100%" |
| 197 BORDER="0" | |
| 198 CELLPADDING="0" | |
| 199 CELLSPACING="0" | |
| 200 ><TR | |
| 201 ><TD | |
| 202 WIDTH="33%" | |
| 203 ALIGN="left" | |
| 204 VALIGN="top" | |
| 205 ><A | |
| 206 HREF="sdlsetgammaramp.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
207 ACCESSKEY="P" |
| 0 | 208 >Prev</A |
| 209 ></TD | |
| 210 ><TD | |
| 211 WIDTH="34%" | |
| 212 ALIGN="center" | |
| 213 VALIGN="top" | |
| 214 ><A | |
| 215 HREF="index.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
216 ACCESSKEY="H" |
| 0 | 217 >Home</A |
| 218 ></TD | |
| 219 ><TD | |
| 220 WIDTH="33%" | |
| 221 ALIGN="right" | |
| 222 VALIGN="top" | |
| 223 ><A | |
| 224 HREF="sdlmaprgba.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
225 ACCESSKEY="N" |
| 0 | 226 >Next</A |
| 227 ></TD | |
| 228 ></TR | |
| 229 ><TR | |
| 230 ><TD | |
| 231 WIDTH="33%" | |
| 232 ALIGN="left" | |
| 233 VALIGN="top" | |
| 234 >SDL_SetGammaRamp</TD | |
| 235 ><TD | |
| 236 WIDTH="34%" | |
| 237 ALIGN="center" | |
| 238 VALIGN="top" | |
| 239 ><A | |
| 240 HREF="video.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
241 ACCESSKEY="U" |
| 0 | 242 >Up</A |
| 243 ></TD | |
| 244 ><TD | |
| 245 WIDTH="33%" | |
| 246 ALIGN="right" | |
| 247 VALIGN="top" | |
| 248 >SDL_MapRGBA</TD | |
| 249 ></TR | |
| 250 ></TABLE | |
| 251 ></DIV | |
| 252 ></BODY | |
| 253 ></HTML | |
| 254 > |