/usr/share/frei0r/html/group___c_o_l_o_r___m_o_d_e_l.html is in frei0r-plugins-doc 1.4-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.1"/>
<title>frei0r: Color Models</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">frei0r
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group___c_o_l_o_r___m_o_d_e_l.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Color Models</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4ff9ca3b84e5057b0b7aeee176d6d3a3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga4ff9ca3b84e5057b0b7aeee176d6d3a3">F0R_COLOR_MODEL_BGRA8888</a>   0</td></tr>
<tr class="separator:ga4ff9ca3b84e5057b0b7aeee176d6d3a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68d6ca25df33b7759dfb2c2f6b44a229"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga68d6ca25df33b7759dfb2c2f6b44a229">F0R_COLOR_MODEL_RGBA8888</a>   1</td></tr>
<tr class="separator:ga68d6ca25df33b7759dfb2c2f6b44a229"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42c9b2342651a04a3045b980cf31cf97"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga42c9b2342651a04a3045b980cf31cf97">F0R_COLOR_MODEL_PACKED32</a>   2</td></tr>
<tr class="separator:ga42c9b2342651a04a3045b980cf31cf97"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>List of supported color models.</p>
<p>Note: the color models are endian independent, because the color components are defined by their positon in memory, not by their significance in an uint32_t value.</p>
<p>For effects that work on the color components, RGBA8888 is the recommended color model for frei0r-1.2 effects. For effects that only work on pixels, PACKED32 is the recommended color model since it helps the application to avoid unnecessary color conversions.</p>
<p>Effects can choose an appropriate color model, applications must support all color models and do conversions if necessary. Source effects must not use the PACKED32 color model because the application must know in which color model the created framebuffers are represented.</p>
<p>For each color model, a frame consists of width*height pixels which are stored row-wise and consecutively in memory. The size of a pixel is 4 bytes. There is no extra pitch parameter (i.e. the pitch is simply width*4).</p>
<p>The following additional constraints must be honored:</p><ul>
<li>The top-most line of a frame is stored first in memory.</li>
<li>A frame must be aligned to a 16 byte border in memory.</li>
<li>The width and height of a frame must be positive</li>
<li>The width and height of a frame must be integer multiples of 8</li>
</ul>
<p>These constraints make sure that each line is stored at an address aligned to 16 byte. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4ff9ca3b84e5057b0b7aeee176d6d3a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define F0R_COLOR_MODEL_BGRA8888   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>In BGRA8888, each pixel is represented by 4 consecutive unsigned bytes, where the first byte value represents the blue, the second the green, and the third the red color component of the pixel. The last value represents the alpha value. </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00299">299</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga42c9b2342651a04a3045b980cf31cf97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define F0R_COLOR_MODEL_PACKED32   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>In PACKED32, each pixel is represented by 4 consecutive bytes, but it is not defined how the color componets are stored. The true color format could be RGBA8888, BGRA8888, a packed 32 bit YUV format, or any other color format that stores pixels in 32 bit.</p>
<p>This is useful for effects that don't work on color but only on pixels (for example a mirror effect).</p>
<p>Note that source effects must not use this color model. </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00322">322</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga68d6ca25df33b7759dfb2c2f6b44a229"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define F0R_COLOR_MODEL_RGBA8888   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>In RGBA8888, each pixel is represented by 4 consecutive unsigned bytes, where the first byte value represents the red, the second the green, and the third the blue color component of the pixel. The last value represents the alpha value. </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00308">308</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|