Mercurial > sdl-ios-xcode
annotate docs/html/sdlmaprgba.html @ 1621:f12379c41042
Fixes bug #195:
The proper name of Apple's operating system is "Mac OS X" not "MacOS X", as can
bee seen in many places, for example http://www.apple.com/macosx/). This
contrasts the naming of the old operating system, which was called "MacOS" and
today is often refered to as "MacOS Classic".
The attached patches fixes the misuse of the name "MacOS X" in both the SDL12
and sdlweb CVS modules.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Thu, 13 Apr 2006 13:08:26 +0000 |
| parents | 355632dca928 |
| children |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_MapRGBA</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_MapRGB" | |
| 17 HREF="sdlmaprgb.html"><LINK | |
| 18 REL="NEXT" | |
| 19 TITLE="SDL_GetRGB" | |
| 20 HREF="sdlgetrgb.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="sdlmaprgb.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="sdlgetrgb.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="SDLMAPRGBA" | |
|
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_MapRGBA</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="AEN1687" |
| 0 | 80 ></A |
| 81 ><H2 | |
| 82 >Name</H2 | |
| 83 >SDL_MapRGBA -- Map a RGBA 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="AEN1690" |
| 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="AEN1691" |
| 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_MapRGBA</B | |
| 108 ></CODE | |
| 109 >(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a);</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="AEN1697" |
| 0 | 119 ></A |
| 120 ><H2 | |
| 121 >Description</H2 | |
| 122 ><P | |
| 123 >Maps the RGBA 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 no alpha component the alpha value | |
| 130 will be ignored (as it will be in formats with a palette).</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="AEN1702" |
| 0 | 136 ></A |
| 137 ><H2 | |
| 138 >Return Value</H2 | |
| 139 ><P | |
| 140 >A pixel value best approximating the given RGBA 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="AEN1707" |
| 0 | 157 ></A |
| 158 ><H2 | |
| 159 >See Also</H2 | |
| 160 ><P | |
| 161 ><A | |
| 162 HREF="sdlgetrgb.html" | |
| 163 >SDL_GetRGB</A | |
| 164 >, | |
| 165 <A | |
| 166 HREF="sdlgetrgba.html" | |
| 167 >SDL_GetRGBA</A | |
| 168 >, | |
| 169 <A | |
| 170 HREF="sdlmaprgb.html" | |
| 171 >SDL_MapRGB</A | |
| 172 >, | |
| 173 <A | |
| 174 HREF="sdlpixelformat.html" | |
| 175 >SDL_PixelFormat</A | |
| 176 ></P | |
| 177 ></DIV | |
| 178 ><DIV | |
| 179 CLASS="NAVFOOTER" | |
| 180 ><HR | |
| 181 ALIGN="LEFT" | |
| 182 WIDTH="100%"><TABLE | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
183 SUMMARY="Footer navigation table" |
| 0 | 184 WIDTH="100%" |
| 185 BORDER="0" | |
| 186 CELLPADDING="0" | |
| 187 CELLSPACING="0" | |
| 188 ><TR | |
| 189 ><TD | |
| 190 WIDTH="33%" | |
| 191 ALIGN="left" | |
| 192 VALIGN="top" | |
| 193 ><A | |
| 194 HREF="sdlmaprgb.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
195 ACCESSKEY="P" |
| 0 | 196 >Prev</A |
| 197 ></TD | |
| 198 ><TD | |
| 199 WIDTH="34%" | |
| 200 ALIGN="center" | |
| 201 VALIGN="top" | |
| 202 ><A | |
| 203 HREF="index.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
204 ACCESSKEY="H" |
| 0 | 205 >Home</A |
| 206 ></TD | |
| 207 ><TD | |
| 208 WIDTH="33%" | |
| 209 ALIGN="right" | |
| 210 VALIGN="top" | |
| 211 ><A | |
| 212 HREF="sdlgetrgb.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
213 ACCESSKEY="N" |
| 0 | 214 >Next</A |
| 215 ></TD | |
| 216 ></TR | |
| 217 ><TR | |
| 218 ><TD | |
| 219 WIDTH="33%" | |
| 220 ALIGN="left" | |
| 221 VALIGN="top" | |
| 222 >SDL_MapRGB</TD | |
| 223 ><TD | |
| 224 WIDTH="34%" | |
| 225 ALIGN="center" | |
| 226 VALIGN="top" | |
| 227 ><A | |
| 228 HREF="video.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
229 ACCESSKEY="U" |
| 0 | 230 >Up</A |
| 231 ></TD | |
| 232 ><TD | |
| 233 WIDTH="33%" | |
| 234 ALIGN="right" | |
| 235 VALIGN="top" | |
| 236 >SDL_GetRGB</TD | |
| 237 ></TR | |
| 238 ></TABLE | |
| 239 ></DIV | |
| 240 ></BODY | |
| 241 ></HTML | |
| 242 > |