<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>My Project: SDL_pixels.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">My Project </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#define-members">Macros</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">SDL_pixels.h File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include "<a class="el" href="SDL__stdinc_8h_source.html">SDL_stdinc.h</a>"</code><br /> <code>#include "<a class="el" href="SDL__endian_8h_source.html">SDL_endian.h</a>"</code><br /> <code>#include "<a class="el" href="begin__code_8h_source.html">begin_code.h</a>"</code><br /> <code>#include "<a class="el" href="close__code_8h_source.html">close_code.h</a>"</code><br /> </div> <p><a href="SDL__pixels_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__Color.html">SDL_Color</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__Palette.html">SDL_Palette</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a7dc1903b18ca972a3676628782873f71"><td class="memItemLeft" align="right" valign="top"><a id="a7dc1903b18ca972a3676628782873f71"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_DEFINE_PIXELFOURCC</b>(A, B, C, D)   SDL_FOURCC(A, B, C, D)</td></tr> <tr class="separator:a7dc1903b18ca972a3676628782873f71"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a99163b258b6b49ab19845cf800a803f8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_DEFINE_PIXELFORMAT</b>(type, order, layout, bits, bytes)</td></tr> <tr class="separator:a99163b258b6b49ab19845cf800a803f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a11eb1848a5ecbc9033855a3d7fabcf83"><td class="memItemLeft" align="right" valign="top"><a id="a11eb1848a5ecbc9033855a3d7fabcf83"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_PIXELFLAG</b>(X)   (((X) >> 28) & 0x0F)</td></tr> <tr class="separator:a11eb1848a5ecbc9033855a3d7fabcf83"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9a13feff26a3bed0e04a74f503b0397e"><td class="memItemLeft" align="right" valign="top"><a id="a9a13feff26a3bed0e04a74f503b0397e"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_PIXELTYPE</b>(X)   (((X) >> 24) & 0x0F)</td></tr> <tr class="separator:a9a13feff26a3bed0e04a74f503b0397e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a38b57b9e01151753588d55a4e2438856"><td class="memItemLeft" align="right" valign="top"><a id="a38b57b9e01151753588d55a4e2438856"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_PIXELORDER</b>(X)   (((X) >> 20) & 0x0F)</td></tr> <tr class="separator:a38b57b9e01151753588d55a4e2438856"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a850007b089215fe1d5e0efa5e4e73d72"><td class="memItemLeft" align="right" valign="top"><a id="a850007b089215fe1d5e0efa5e4e73d72"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_PIXELLAYOUT</b>(X)   (((X) >> 16) & 0x0F)</td></tr> <tr class="separator:a850007b089215fe1d5e0efa5e4e73d72"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4637c50b3383aa176eac2d267684e75d"><td class="memItemLeft" align="right" valign="top"><a id="a4637c50b3383aa176eac2d267684e75d"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_BITSPERPIXEL</b>(X)   (((X) >> 8) & 0xFF)</td></tr> <tr class="separator:a4637c50b3383aa176eac2d267684e75d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0a65fc19d5122dd3c544f283553ad42c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_BYTESPERPIXEL</b>(X)</td></tr> <tr class="separator:a0a65fc19d5122dd3c544f283553ad42c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8bbf98a12987b0b22864743efb4b136e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_ISPIXELFORMAT_INDEXED</b>(format)</td></tr> <tr class="separator:a8bbf98a12987b0b22864743efb4b136e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a29855dc8b3cd34b288ec4ba50fd4ca0c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_ISPIXELFORMAT_PACKED</b>(format)</td></tr> <tr class="separator:a29855dc8b3cd34b288ec4ba50fd4ca0c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8f842c1384f7d6bc17fa2b33738e9b4b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_ISPIXELFORMAT_ARRAY</b>(format)</td></tr> <tr class="separator:a8f842c1384f7d6bc17fa2b33738e9b4b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4d4ef3b8864a55ebc83539a6d0c6b15d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>SDL_ISPIXELFORMAT_ALPHA</b>(format)</td></tr> <tr class="separator:a4d4ef3b8864a55ebc83539a6d0c6b15d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac2a8124d1f6842ddf7ef5cc01c760818"><td class="memItemLeft" align="right" valign="top"><a id="ac2a8124d1f6842ddf7ef5cc01c760818"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_ISPIXELFORMAT_FOURCC</b>(format)   ((format) && (SDL_PIXELFLAG(format) != 1))</td></tr> <tr class="separator:ac2a8124d1f6842ddf7ef5cc01c760818"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aceb6cb42789d5646f5206f02a07a36dc"><td class="memItemLeft" align="right" valign="top"><a id="aceb6cb42789d5646f5206f02a07a36dc"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_Colour</b>   <a class="el" href="structSDL__Color.html">SDL_Color</a></td></tr> <tr class="separator:aceb6cb42789d5646f5206f02a07a36dc"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">Transparency definitions</div></td></tr> <tr><td colspan="2"><div class="groupText"><p>These define alpha as the opacity of a surface. </p> </div></td></tr> <tr class="memitem:a5d933eb0233ca33d598800f33ef43376"><td class="memItemLeft" align="right" valign="top"><a id="a5d933eb0233ca33d598800f33ef43376"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_ALPHA_OPAQUE</b>   255</td></tr> <tr class="separator:a5d933eb0233ca33d598800f33ef43376"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a604d4b3b28add80eb4824ffd083d3ef4"><td class="memItemLeft" align="right" valign="top"><a id="a604d4b3b28add80eb4824ffd083d3ef4"></a> #define </td><td class="memItemRight" valign="bottom"><b>SDL_ALPHA_TRANSPARENT</b>   0</td></tr> <tr class="separator:a604d4b3b28add80eb4824ffd083d3ef4"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a6c62a9e85197f93df21a6a4a9d36eb25"><td class="memItemLeft" align="right" valign="top"><a id="a6c62a9e85197f93df21a6a4a9d36eb25"></a> typedef struct <a class="el" href="structSDL__Color.html">SDL_Color</a> </td><td class="memItemRight" valign="bottom"><b>SDL_Color</b></td></tr> <tr class="separator:a6c62a9e85197f93df21a6a4a9d36eb25"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a801e2814517a3e61daf86403d4dd1c6e"><td class="memItemLeft" align="right" valign="top"><a id="a801e2814517a3e61daf86403d4dd1c6e"></a> typedef struct <a class="el" href="structSDL__Palette.html">SDL_Palette</a> </td><td class="memItemRight" valign="bottom"><b>SDL_Palette</b></td></tr> <tr class="separator:a801e2814517a3e61daf86403d4dd1c6e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e5dc2921ca058ecb7cbe15ff38248e2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a9e5dc2921ca058ecb7cbe15ff38248e2">SDL_PixelFormat</a></td></tr> <tr class="separator:a9e5dc2921ca058ecb7cbe15ff38248e2"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:adc29c2ff13d900c2f185ee95427fb06c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />   <b>SDL_PIXELTYPE_UNKNOWN</b>, <b>SDL_PIXELTYPE_INDEX1</b>, <b>SDL_PIXELTYPE_INDEX4</b>, <b>SDL_PIXELTYPE_INDEX8</b>, <br />   <b>SDL_PIXELTYPE_PACKED8</b>, <b>SDL_PIXELTYPE_PACKED16</b>, <b>SDL_PIXELTYPE_PACKED32</b>, <b>SDL_PIXELTYPE_ARRAYU8</b>, <br />   <b>SDL_PIXELTYPE_ARRAYU16</b>, <b>SDL_PIXELTYPE_ARRAYU32</b>, <b>SDL_PIXELTYPE_ARRAYF16</b>, <b>SDL_PIXELTYPE_ARRAYF32</b> <br /> }</td></tr> <tr class="separator:adc29c2ff13d900c2f185ee95427fb06c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a61dadd085c1777f559549e05962b2c9e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <b>SDL_BITMAPORDER_NONE</b>, <b>SDL_BITMAPORDER_4321</b>, <b>SDL_BITMAPORDER_1234</b> }</td></tr> <tr class="separator:a61dadd085c1777f559549e05962b2c9e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a726ca809ffd3d67ab4b8476646f26635"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />   <b>SDL_PACKEDORDER_NONE</b>, <b>SDL_PACKEDORDER_XRGB</b>, <b>SDL_PACKEDORDER_RGBX</b>, <b>SDL_PACKEDORDER_ARGB</b>, <br />   <b>SDL_PACKEDORDER_RGBA</b>, <b>SDL_PACKEDORDER_XBGR</b>, <b>SDL_PACKEDORDER_BGRX</b>, <b>SDL_PACKEDORDER_ABGR</b>, <br />   <b>SDL_PACKEDORDER_BGRA</b> <br /> }</td></tr> <tr class="separator:a726ca809ffd3d67ab4b8476646f26635"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0411cd49bb5b71852cecd93bcbf0ca2d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />   <b>SDL_ARRAYORDER_NONE</b>, <b>SDL_ARRAYORDER_RGB</b>, <b>SDL_ARRAYORDER_RGBA</b>, <b>SDL_ARRAYORDER_ARGB</b>, <br />   <b>SDL_ARRAYORDER_BGR</b>, <b>SDL_ARRAYORDER_BGRA</b>, <b>SDL_ARRAYORDER_ABGR</b> <br /> }</td></tr> <tr class="separator:a0411cd49bb5b71852cecd93bcbf0ca2d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abed82baf7f470b522273a3e37c24c600"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />   <b>SDL_PACKEDLAYOUT_NONE</b>, <b>SDL_PACKEDLAYOUT_332</b>, <b>SDL_PACKEDLAYOUT_4444</b>, <b>SDL_PACKEDLAYOUT_1555</b>, <br />   <b>SDL_PACKEDLAYOUT_5551</b>, <b>SDL_PACKEDLAYOUT_565</b>, <b>SDL_PACKEDLAYOUT_8888</b>, <b>SDL_PACKEDLAYOUT_2101010</b>, <br />   <b>SDL_PACKEDLAYOUT_1010102</b> <br /> }</td></tr> <tr class="separator:abed82baf7f470b522273a3e37c24c600"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a95821d38f8029ed06c258e9be3dfc111"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111">SDL_PixelFormatEnum</a> { <br />   <b>SDL_PIXELFORMAT_UNKNOWN</b>, <b>SDL_PIXELFORMAT_INDEX1LSB</b>, <b>SDL_PIXELFORMAT_INDEX1MSB</b>, <b>SDL_PIXELFORMAT_INDEX4LSB</b>, <br />   <b>SDL_PIXELFORMAT_INDEX4MSB</b>, <b>SDL_PIXELFORMAT_INDEX8</b>, <b>SDL_PIXELFORMAT_RGB332</b>, <b>SDL_PIXELFORMAT_RGB444</b>, <br />   <b>SDL_PIXELFORMAT_RGB555</b>, <b>SDL_PIXELFORMAT_BGR555</b>, <b>SDL_PIXELFORMAT_ARGB4444</b>, <b>SDL_PIXELFORMAT_RGBA4444</b>, <br />   <b>SDL_PIXELFORMAT_ABGR4444</b>, <b>SDL_PIXELFORMAT_BGRA4444</b>, <b>SDL_PIXELFORMAT_ARGB1555</b>, <b>SDL_PIXELFORMAT_RGBA5551</b>, <br />   <b>SDL_PIXELFORMAT_ABGR1555</b>, <b>SDL_PIXELFORMAT_BGRA5551</b>, <b>SDL_PIXELFORMAT_RGB565</b>, <b>SDL_PIXELFORMAT_BGR565</b>, <br />   <b>SDL_PIXELFORMAT_RGB24</b>, <b>SDL_PIXELFORMAT_BGR24</b>, <b>SDL_PIXELFORMAT_RGB888</b>, <b>SDL_PIXELFORMAT_RGBX8888</b>, <br />   <b>SDL_PIXELFORMAT_BGR888</b>, <b>SDL_PIXELFORMAT_BGRX8888</b>, <b>SDL_PIXELFORMAT_ARGB8888</b>, <b>SDL_PIXELFORMAT_RGBA8888</b>, <br />   <b>SDL_PIXELFORMAT_ABGR8888</b>, <b>SDL_PIXELFORMAT_BGRA8888</b>, <b>SDL_PIXELFORMAT_ARGB2101010</b>, <b>SDL_PIXELFORMAT_RGBA32</b> = SDL_PIXELFORMAT_ABGR8888, <br />   <b>SDL_PIXELFORMAT_ARGB32</b> = SDL_PIXELFORMAT_BGRA8888, <b>SDL_PIXELFORMAT_BGRA32</b> = SDL_PIXELFORMAT_ARGB8888, <b>SDL_PIXELFORMAT_ABGR32</b> = SDL_PIXELFORMAT_RGBA8888, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a706edeff2993aaabae0e8a85dd456d23">SDL_PIXELFORMAT_YV12</a>, <br />   <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a9d5d930c6560d21d02be1d3738160e08">SDL_PIXELFORMAT_IYUV</a>, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a87d182ad80264610243c4bdbba13b456">SDL_PIXELFORMAT_YUY2</a>, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a69bd11cf739b7e762d5103555fe85094">SDL_PIXELFORMAT_UYVY</a>, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a0fba10d58b6af54319f3653724a54a29">SDL_PIXELFORMAT_YVYU</a>, <br />   <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a8fa8e4c226ea2918366e68b239921099">SDL_PIXELFORMAT_NV12</a>, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a97f2d6c51817862e1927e462960e7052">SDL_PIXELFORMAT_NV21</a>, <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a0d8d7ba67039174e96fc561962d3b0f7">SDL_PIXELFORMAT_EXTERNAL_OES</a> = <br /> }</td></tr> <tr class="separator:a95821d38f8029ed06c258e9be3dfc111"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:abc7a949ed918d285449d6a8fcc2b0321"><td class="memItemLeft" align="right" valign="top"><a id="abc7a949ed918d285449d6a8fcc2b0321"></a> DECLSPEC const char *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#abc7a949ed918d285449d6a8fcc2b0321">SDL_GetPixelFormatName</a> (Uint32 format)</td></tr> <tr class="memdesc:abc7a949ed918d285449d6a8fcc2b0321"><td class="mdescLeft"> </td><td class="mdescRight">Get the human readable name of a pixel format. <br /></td></tr> <tr class="separator:abc7a949ed918d285449d6a8fcc2b0321"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aabce46ecd37dd031b6b9a1b2d64f962b"><td class="memItemLeft" align="right" valign="top">DECLSPEC SDL_bool SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#aabce46ecd37dd031b6b9a1b2d64f962b">SDL_PixelFormatEnumToMasks</a> (Uint32 format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask)</td></tr> <tr class="memdesc:aabce46ecd37dd031b6b9a1b2d64f962b"><td class="mdescLeft"> </td><td class="mdescRight">Convert one of the enumerated pixel formats to a bpp and RGBA masks. <a href="#aabce46ecd37dd031b6b9a1b2d64f962b">More...</a><br /></td></tr> <tr class="separator:aabce46ecd37dd031b6b9a1b2d64f962b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a60fede85fba7bdca549f46b3f6372593"><td class="memItemLeft" align="right" valign="top">DECLSPEC Uint32 SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a60fede85fba7bdca549f46b3f6372593">SDL_MasksToPixelFormatEnum</a> (int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)</td></tr> <tr class="memdesc:a60fede85fba7bdca549f46b3f6372593"><td class="mdescLeft"> </td><td class="mdescRight">Convert a bpp and RGBA masks to an enumerated pixel format. <a href="#a60fede85fba7bdca549f46b3f6372593">More...</a><br /></td></tr> <tr class="separator:a60fede85fba7bdca549f46b3f6372593"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a95972bb1fcfc9ddde496cd9ce13c7edd"><td class="memItemLeft" align="right" valign="top"><a id="a95972bb1fcfc9ddde496cd9ce13c7edd"></a> DECLSPEC <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a95972bb1fcfc9ddde496cd9ce13c7edd">SDL_AllocFormat</a> (Uint32 pixel_format)</td></tr> <tr class="memdesc:a95972bb1fcfc9ddde496cd9ce13c7edd"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> structure from a pixel format enum. <br /></td></tr> <tr class="separator:a95972bb1fcfc9ddde496cd9ce13c7edd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6b40e44d9a48dfecde34428a78648f8a"><td class="memItemLeft" align="right" valign="top"><a id="a6b40e44d9a48dfecde34428a78648f8a"></a> DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a6b40e44d9a48dfecde34428a78648f8a">SDL_FreeFormat</a> (<a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format)</td></tr> <tr class="memdesc:a6b40e44d9a48dfecde34428a78648f8a"><td class="mdescLeft"> </td><td class="mdescRight">Free an <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> structure. <br /></td></tr> <tr class="separator:a6b40e44d9a48dfecde34428a78648f8a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9824eb994b2431017b57fcc1b6a8055c"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="structSDL__Palette.html">SDL_Palette</a> *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a9824eb994b2431017b57fcc1b6a8055c">SDL_AllocPalette</a> (int ncolors)</td></tr> <tr class="memdesc:a9824eb994b2431017b57fcc1b6a8055c"><td class="mdescLeft"> </td><td class="mdescRight">Create a palette structure with the specified number of color entries. <a href="#a9824eb994b2431017b57fcc1b6a8055c">More...</a><br /></td></tr> <tr class="separator:a9824eb994b2431017b57fcc1b6a8055c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae7835e283254c53bed7e7b3d2287d3b6"><td class="memItemLeft" align="right" valign="top"><a id="ae7835e283254c53bed7e7b3d2287d3b6"></a> DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#ae7835e283254c53bed7e7b3d2287d3b6">SDL_SetPixelFormatPalette</a> (<a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format, <a class="el" href="structSDL__Palette.html">SDL_Palette</a> *palette)</td></tr> <tr class="memdesc:ae7835e283254c53bed7e7b3d2287d3b6"><td class="mdescLeft"> </td><td class="mdescRight">Set the palette for a pixel format structure. <br /></td></tr> <tr class="separator:ae7835e283254c53bed7e7b3d2287d3b6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a51164f5ac7a7b2b4117ff0e0f256eaff"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a51164f5ac7a7b2b4117ff0e0f256eaff">SDL_SetPaletteColors</a> (<a class="el" href="structSDL__Palette.html">SDL_Palette</a> *palette, const <a class="el" href="structSDL__Color.html">SDL_Color</a> *colors, int firstcolor, int ncolors)</td></tr> <tr class="memdesc:a51164f5ac7a7b2b4117ff0e0f256eaff"><td class="mdescLeft"> </td><td class="mdescRight">Set a range of colors in a palette. <a href="#a51164f5ac7a7b2b4117ff0e0f256eaff">More...</a><br /></td></tr> <tr class="separator:a51164f5ac7a7b2b4117ff0e0f256eaff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a31d328d11619b5f5ed0a14612cbb429a"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a31d328d11619b5f5ed0a14612cbb429a">SDL_FreePalette</a> (<a class="el" href="structSDL__Palette.html">SDL_Palette</a> *palette)</td></tr> <tr class="memdesc:a31d328d11619b5f5ed0a14612cbb429a"><td class="mdescLeft"> </td><td class="mdescRight">Free a palette created with <a class="el" href="SDL__pixels_8h.html#a9824eb994b2431017b57fcc1b6a8055c" title="Create a palette structure with the specified number of color entries.">SDL_AllocPalette()</a>. <a href="#a31d328d11619b5f5ed0a14612cbb429a">More...</a><br /></td></tr> <tr class="separator:a31d328d11619b5f5ed0a14612cbb429a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a157cf64c250c578722b939ea11a85b39"><td class="memItemLeft" align="right" valign="top">DECLSPEC Uint32 SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a157cf64c250c578722b939ea11a85b39">SDL_MapRGB</a> (const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format, Uint8 r, Uint8 g, Uint8 b)</td></tr> <tr class="memdesc:a157cf64c250c578722b939ea11a85b39"><td class="mdescLeft"> </td><td class="mdescRight">Maps an RGB triple to an opaque pixel value for a given pixel format. <a href="#a157cf64c250c578722b939ea11a85b39">More...</a><br /></td></tr> <tr class="separator:a157cf64c250c578722b939ea11a85b39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8cc5000a066e052d4d36070ea91ac942"><td class="memItemLeft" align="right" valign="top">DECLSPEC Uint32 SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a8cc5000a066e052d4d36070ea91ac942">SDL_MapRGBA</a> (const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a)</td></tr> <tr class="memdesc:a8cc5000a066e052d4d36070ea91ac942"><td class="mdescLeft"> </td><td class="mdescRight">Maps an RGBA quadruple to a pixel value for a given pixel format. <a href="#a8cc5000a066e052d4d36070ea91ac942">More...</a><br /></td></tr> <tr class="separator:a8cc5000a066e052d4d36070ea91ac942"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a26dc44b5dac11825abb4b59ac5af76e3"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a26dc44b5dac11825abb4b59ac5af76e3">SDL_GetRGB</a> (Uint32 pixel, const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format, Uint8 *r, Uint8 *g, Uint8 *b)</td></tr> <tr class="memdesc:a26dc44b5dac11825abb4b59ac5af76e3"><td class="mdescLeft"> </td><td class="mdescRight">Get the RGB components from a pixel of the specified format. <a href="#a26dc44b5dac11825abb4b59ac5af76e3">More...</a><br /></td></tr> <tr class="separator:a26dc44b5dac11825abb4b59ac5af76e3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02d675543e9c5bb72232a08a529ae64e"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a02d675543e9c5bb72232a08a529ae64e">SDL_GetRGBA</a> (Uint32 pixel, const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> *format, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)</td></tr> <tr class="memdesc:a02d675543e9c5bb72232a08a529ae64e"><td class="mdescLeft"> </td><td class="mdescRight">Get the RGBA components from a pixel of the specified format. <a href="#a02d675543e9c5bb72232a08a529ae64e">More...</a><br /></td></tr> <tr class="separator:a02d675543e9c5bb72232a08a529ae64e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a768b7ed72549e36a26a36267772906fb"><td class="memItemLeft" align="right" valign="top"><a id="a768b7ed72549e36a26a36267772906fb"></a> DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__pixels_8h.html#a768b7ed72549e36a26a36267772906fb">SDL_CalculateGammaRamp</a> (float gamma, Uint16 *ramp)</td></tr> <tr class="memdesc:a768b7ed72549e36a26a36267772906fb"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a 256 entry gamma ramp for a gamma value. <br /></td></tr> <tr class="separator:a768b7ed72549e36a26a36267772906fb"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Header for the enumerated pixel format definitions. </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a0a65fc19d5122dd3c544f283553ad42c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0a65fc19d5122dd3c544f283553ad42c">◆ </a></span>SDL_BYTESPERPIXEL</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_BYTESPERPIXEL</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">X</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">(SDL_ISPIXELFORMAT_FOURCC(X) ? \</div><div class="line"> ((((X) == <a class="code" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a87d182ad80264610243c4bdbba13b456">SDL_PIXELFORMAT_YUY2</a>) || \</div><div class="line"> ((X) == <a class="code" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a69bd11cf739b7e762d5103555fe85094">SDL_PIXELFORMAT_UYVY</a>) || \</div><div class="line"> ((X) == <a class="code" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a0fba10d58b6af54319f3653724a54a29">SDL_PIXELFORMAT_YVYU</a>)) ? 2 : 1) : (((X) >> 0) & 0xFF))</div><div class="ttc" id="SDL__pixels_8h_html_a95821d38f8029ed06c258e9be3dfc111a0fba10d58b6af54319f3653724a54a29"><div class="ttname"><a href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a0fba10d58b6af54319f3653724a54a29">SDL_PIXELFORMAT_YVYU</a></div><div class="ttdef"><b>Definition:</b> SDL_pixels.h:285</div></div> <div class="ttc" id="SDL__pixels_8h_html_a95821d38f8029ed06c258e9be3dfc111a87d182ad80264610243c4bdbba13b456"><div class="ttname"><a href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a87d182ad80264610243c4bdbba13b456">SDL_PIXELFORMAT_YUY2</a></div><div class="ttdef"><b>Definition:</b> SDL_pixels.h:281</div></div> <div class="ttc" id="SDL__pixels_8h_html_a95821d38f8029ed06c258e9be3dfc111a69bd11cf739b7e762d5103555fe85094"><div class="ttname"><a href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111a69bd11cf739b7e762d5103555fe85094">SDL_PIXELFORMAT_UYVY</a></div><div class="ttdef"><b>Definition:</b> SDL_pixels.h:283</div></div> </div><!-- fragment --> </div> </div> <a id="a99163b258b6b49ab19845cf800a803f8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a99163b258b6b49ab19845cf800a803f8">◆ </a></span>SDL_DEFINE_PIXELFORMAT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_DEFINE_PIXELFORMAT</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">type, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">order, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">layout, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">bits, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">bytes </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">((1 << 28) | ((type) << 24) | ((order) << 20) | ((layout) << 16) | \</div><div class="line"> ((bits) << 8) | ((bytes) << 0))</div></div><!-- fragment --> </div> </div> <a id="a4d4ef3b8864a55ebc83539a6d0c6b15d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4d4ef3b8864a55ebc83539a6d0c6b15d">◆ </a></span>SDL_ISPIXELFORMAT_ALPHA</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_ISPIXELFORMAT_ALPHA</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">format</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">((SDL_ISPIXELFORMAT_PACKED(format) && \</div><div class="line"> ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))) || \</div><div class="line"> (SDL_ISPIXELFORMAT_ARRAY(format) && \</div><div class="line"> ((SDL_PIXELORDER(format) == SDL_ARRAYORDER_ARGB) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_ARRAYORDER_RGBA) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_ARRAYORDER_ABGR) || \</div><div class="line"> (SDL_PIXELORDER(format) == SDL_ARRAYORDER_BGRA))))</div></div><!-- fragment --> </div> </div> <a id="a8f842c1384f7d6bc17fa2b33738e9b4b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8f842c1384f7d6bc17fa2b33738e9b4b">◆ </a></span>SDL_ISPIXELFORMAT_ARRAY</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_ISPIXELFORMAT_ARRAY</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">format</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">(!SDL_ISPIXELFORMAT_FOURCC(format) && \</div><div class="line"> ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))</div></div><!-- fragment --> </div> </div> <a id="a8bbf98a12987b0b22864743efb4b136e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8bbf98a12987b0b22864743efb4b136e">◆ </a></span>SDL_ISPIXELFORMAT_INDEXED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_ISPIXELFORMAT_INDEXED</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">format</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">(!SDL_ISPIXELFORMAT_FOURCC(format) && \</div><div class="line"> ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))</div></div><!-- fragment --> </div> </div> <a id="a29855dc8b3cd34b288ec4ba50fd4ca0c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a29855dc8b3cd34b288ec4ba50fd4ca0c">◆ </a></span>SDL_ISPIXELFORMAT_PACKED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SDL_ISPIXELFORMAT_PACKED</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">format</td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">(!SDL_ISPIXELFORMAT_FOURCC(format) && \</div><div class="line"> ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \</div><div class="line"> (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))</div></div><!-- fragment --> </div> </div> <h2 class="groupheader">Typedef Documentation</h2> <a id="a9e5dc2921ca058ecb7cbe15ff38248e2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9e5dc2921ca058ecb7cbe15ff38248e2">◆ </a></span>SDL_PixelFormat</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a></td> </tr> </table> </div><div class="memdoc"> <dl class="section note"><dt>Note</dt><dd>Everything in the pixel format structure is read-only. </dd></dl> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="adc29c2ff13d900c2f185ee95427fb06c"></a> <h2 class="memtitle"><span class="permalink"><a href="#adc29c2ff13d900c2f185ee95427fb06c">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Pixel type. </p> </div> </div> <a id="a61dadd085c1777f559549e05962b2c9e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a61dadd085c1777f559549e05962b2c9e">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Bitmap pixel order, high bit -> low bit. </p> </div> </div> <a id="a726ca809ffd3d67ab4b8476646f26635"></a> <h2 class="memtitle"><span class="permalink"><a href="#a726ca809ffd3d67ab4b8476646f26635">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Packed component order, high bit -> low bit. </p> </div> </div> <a id="a0411cd49bb5b71852cecd93bcbf0ca2d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0411cd49bb5b71852cecd93bcbf0ca2d">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Array component order, low byte -> high byte. </p> </div> </div> <a id="abed82baf7f470b522273a3e37c24c600"></a> <h2 class="memtitle"><span class="permalink"><a href="#abed82baf7f470b522273a3e37c24c600">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Packed component layout. </p> </div> </div> <a id="a95821d38f8029ed06c258e9be3dfc111"></a> <h2 class="memtitle"><span class="permalink"><a href="#a95821d38f8029ed06c258e9be3dfc111">◆ </a></span>SDL_PixelFormatEnum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="SDL__pixels_8h.html#a95821d38f8029ed06c258e9be3dfc111">SDL_PixelFormatEnum</a></td> </tr> </table> </div><div class="memdoc"> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a706edeff2993aaabae0e8a85dd456d23"></a>SDL_PIXELFORMAT_YV12 </td><td class="fielddoc"><p>Planar mode: Y + V + U (3 planes) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a9d5d930c6560d21d02be1d3738160e08"></a>SDL_PIXELFORMAT_IYUV </td><td class="fielddoc"><p>Planar mode: Y + U + V (3 planes) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a87d182ad80264610243c4bdbba13b456"></a>SDL_PIXELFORMAT_YUY2 </td><td class="fielddoc"><p>Packed mode: Y0+U0+Y1+V0 (1 plane) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a69bd11cf739b7e762d5103555fe85094"></a>SDL_PIXELFORMAT_UYVY </td><td class="fielddoc"><p>Packed mode: U0+Y0+V0+Y1 (1 plane) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a0fba10d58b6af54319f3653724a54a29"></a>SDL_PIXELFORMAT_YVYU </td><td class="fielddoc"><p>Packed mode: Y0+V0+Y1+U0 (1 plane) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a8fa8e4c226ea2918366e68b239921099"></a>SDL_PIXELFORMAT_NV12 </td><td class="fielddoc"><p>Planar mode: Y + U/V interleaved (2 planes) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a97f2d6c51817862e1927e462960e7052"></a>SDL_PIXELFORMAT_NV21 </td><td class="fielddoc"><p>Planar mode: Y + V/U interleaved (2 planes) </p> </td></tr> <tr><td class="fieldname"><a id="a95821d38f8029ed06c258e9be3dfc111a0d8d7ba67039174e96fc561962d3b0f7"></a>SDL_PIXELFORMAT_EXTERNAL_OES </td><td class="fielddoc"><p>Android video texture format </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a9824eb994b2431017b57fcc1b6a8055c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9824eb994b2431017b57fcc1b6a8055c">◆ </a></span>SDL_AllocPalette()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC <a class="el" href="structSDL__Palette.html">SDL_Palette</a>* SDLCALL SDL_AllocPalette </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>ncolors</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a palette structure with the specified number of color entries. </p> <dl class="section return"><dt>Returns</dt><dd>A new palette, or NULL if there wasn't enough memory.</dd></dl> <dl class="section note"><dt>Note</dt><dd>The palette entries are initialized to white.</dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a31d328d11619b5f5ed0a14612cbb429a" title="Free a palette created with SDL_AllocPalette().">SDL_FreePalette()</a> </dd></dl> </div> </div> <a id="a31d328d11619b5f5ed0a14612cbb429a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a31d328d11619b5f5ed0a14612cbb429a">◆ </a></span>SDL_FreePalette()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC void SDLCALL SDL_FreePalette </td> <td>(</td> <td class="paramtype"><a class="el" href="structSDL__Palette.html">SDL_Palette</a> * </td> <td class="paramname"><em>palette</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a palette created with <a class="el" href="SDL__pixels_8h.html#a9824eb994b2431017b57fcc1b6a8055c" title="Create a palette structure with the specified number of color entries.">SDL_AllocPalette()</a>. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a9824eb994b2431017b57fcc1b6a8055c" title="Create a palette structure with the specified number of color entries.">SDL_AllocPalette()</a> </dd></dl> </div> </div> <a id="a26dc44b5dac11825abb4b59ac5af76e3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a26dc44b5dac11825abb4b59ac5af76e3">◆ </a></span>SDL_GetRGB()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC void SDLCALL SDL_GetRGB </td> <td>(</td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>pixel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> * </td> <td class="paramname"><em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>g</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Get the RGB components from a pixel of the specified format. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a02d675543e9c5bb72232a08a529ae64e" title="Get the RGBA components from a pixel of the specified format.">SDL_GetRGBA</a> </dd></dl> </div> </div> <a id="a02d675543e9c5bb72232a08a529ae64e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a02d675543e9c5bb72232a08a529ae64e">◆ </a></span>SDL_GetRGBA()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC void SDLCALL SDL_GetRGBA </td> <td>(</td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>pixel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> * </td> <td class="paramname"><em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>g</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>b</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 * </td> <td class="paramname"><em>a</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Get the RGBA components from a pixel of the specified format. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a26dc44b5dac11825abb4b59ac5af76e3" title="Get the RGB components from a pixel of the specified format.">SDL_GetRGB</a> </dd></dl> </div> </div> <a id="a157cf64c250c578722b939ea11a85b39"></a> <h2 class="memtitle"><span class="permalink"><a href="#a157cf64c250c578722b939ea11a85b39">◆ </a></span>SDL_MapRGB()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC Uint32 SDLCALL SDL_MapRGB </td> <td>(</td> <td class="paramtype">const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> * </td> <td class="paramname"><em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>g</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>b</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Maps an RGB triple to an opaque pixel value for a given pixel format. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a8cc5000a066e052d4d36070ea91ac942" title="Maps an RGBA quadruple to a pixel value for a given pixel format.">SDL_MapRGBA</a> </dd></dl> </div> </div> <a id="a8cc5000a066e052d4d36070ea91ac942"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8cc5000a066e052d4d36070ea91ac942">◆ </a></span>SDL_MapRGBA()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC Uint32 SDLCALL SDL_MapRGBA </td> <td>(</td> <td class="paramtype">const <a class="el" href="structSDL__PixelFormat.html">SDL_PixelFormat</a> * </td> <td class="paramname"><em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>g</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>b</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint8 </td> <td class="paramname"><em>a</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Maps an RGBA quadruple to a pixel value for a given pixel format. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a157cf64c250c578722b939ea11a85b39" title="Maps an RGB triple to an opaque pixel value for a given pixel format.">SDL_MapRGB</a> </dd></dl> </div> </div> <a id="a60fede85fba7bdca549f46b3f6372593"></a> <h2 class="memtitle"><span class="permalink"><a href="#a60fede85fba7bdca549f46b3f6372593">◆ </a></span>SDL_MasksToPixelFormatEnum()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC Uint32 SDLCALL SDL_MasksToPixelFormatEnum </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>bpp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>Rmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>Gmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>Bmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>Amask</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert a bpp and RGBA masks to an enumerated pixel format. </p> <dl class="section return"><dt>Returns</dt><dd>The pixel format, or ::SDL_PIXELFORMAT_UNKNOWN if the conversion wasn't possible.</dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#aabce46ecd37dd031b6b9a1b2d64f962b" title="Convert one of the enumerated pixel formats to a bpp and RGBA masks.">SDL_PixelFormatEnumToMasks()</a> </dd></dl> </div> </div> <a id="aabce46ecd37dd031b6b9a1b2d64f962b"></a> <h2 class="memtitle"><span class="permalink"><a href="#aabce46ecd37dd031b6b9a1b2d64f962b">◆ </a></span>SDL_PixelFormatEnumToMasks()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC SDL_bool SDLCALL SDL_PixelFormatEnumToMasks </td> <td>(</td> <td class="paramtype">Uint32 </td> <td class="paramname"><em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>bpp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 * </td> <td class="paramname"><em>Rmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 * </td> <td class="paramname"><em>Gmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 * </td> <td class="paramname"><em>Bmask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint32 * </td> <td class="paramname"><em>Amask</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert one of the enumerated pixel formats to a bpp and RGBA masks. </p> <dl class="section return"><dt>Returns</dt><dd>SDL_TRUE, or SDL_FALSE if the conversion wasn't possible.</dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__pixels_8h.html#a60fede85fba7bdca549f46b3f6372593" title="Convert a bpp and RGBA masks to an enumerated pixel format.">SDL_MasksToPixelFormatEnum()</a> </dd></dl> </div> </div> <a id="a51164f5ac7a7b2b4117ff0e0f256eaff"></a> <h2 class="memtitle"><span class="permalink"><a href="#a51164f5ac7a7b2b4117ff0e0f256eaff">◆ </a></span>SDL_SetPaletteColors()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DECLSPEC int SDLCALL SDL_SetPaletteColors </td> <td>(</td> <td class="paramtype"><a class="el" href="structSDL__Palette.html">SDL_Palette</a> * </td> <td class="paramname"><em>palette</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structSDL__Color.html">SDL_Color</a> * </td> <td class="paramname"><em>colors</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>firstcolor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>ncolors</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a range of colors in a palette. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">palette</td><td>The palette to modify. </td></tr> <tr><td class="paramname">colors</td><td>An array of colors to copy into the palette. </td></tr> <tr><td class="paramname">firstcolor</td><td>The index of the first palette entry to modify. </td></tr> <tr><td class="paramname">ncolors</td><td>The number of entries to modify.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 if not all of the colors could be set. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>