glm/doc/api-0.9.3/a00173.html

207 lines
9.1 KiB
HTML
Raw Normal View History

2011-10-24 14:24:48 +00:00
<!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"/>
<title>GLM_GTX_color_space: RGB to HSV conversion</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
2011-11-12 23:26:02 +00:00
<!-- Generated by Doxygen 1.7.3 -->
2011-10-24 14:24:48 +00:00
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
2011-11-12 23:26:02 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
2011-10-24 14:24:48 +00:00
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
2011-11-12 23:26:02 +00:00
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
2011-10-24 14:24:48 +00:00
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2011-11-12 23:26:02 +00:00
<h1>GLM_GTX_color_space: RGB to HSV conversion</h1> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
2011-10-24 14:24:48 +00:00
<div class="contents">
<p>Related to RGB to HSV conversions and operations.
2011-11-12 23:26:02 +00:00
<a href="#_details">More...</a></p>
2011-10-24 14:24:48 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaa9957385a0ec4908209cfb9890e17c24">hsvColor</a> (detail::tvec3&lt; valType &gt; const &amp;rgbValue)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga739ecb162c0ab7c238b6113f7538c42e">luminosity</a> (detail::tvec3&lt; valType &gt; const &amp;color)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga4ca555f0091dc71c54e36b0ddd9b31bc">rgbColor</a> (detail::tvec3&lt; valType &gt; const &amp;hsvValue)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gae45d26f7c6738a365aaa4560193a50ec">saturation</a> (valType const s, detail::tvec3&lt; valType &gt; const &amp;color)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaa5af7f22a8a56b3fb3f98103defe7099">saturation</a> (valType const s)</td></tr>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga45546394251769bf7c126dac3b2d5fbf">saturation</a> (valType const s, detail::tvec4&lt; valType &gt; const &amp;color)</td></tr>
2011-10-24 14:24:48 +00:00
</table>
2011-11-12 23:26:02 +00:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2011-10-24 14:24:48 +00:00
<p>Related to RGB to HSV conversions and operations. </p>
2011-11-12 23:26:02 +00:00
<p>&lt;<a class="el" href="a00028.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/color_space.hpp</a>&gt; need to be included to use these functionalities. </p>
2011-10-24 14:24:48 +00:00
<hr/><h2>Function Documentation</h2>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="gaa9957385a0ec4908209cfb9890e17c24"></a><!-- doxytag: member="glm::hsvColor" ref="gaa9957385a0ec4908209cfb9890e17c24" args="(detail::tvec3&lt; valType &gt; const &amp;rgbValue)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;valType&gt; glm::hsvColor </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>rgbValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts a color from RGB color space to its color in HSV color space. </p>
<p>From GLM_GTX_color_space extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga739ecb162c0ab7c238b6113f7538c42e"></a><!-- doxytag: member="glm::luminosity" ref="ga739ecb162c0ab7c238b6113f7538c42e" args="(detail::tvec3&lt; valType &gt; const &amp;color)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">valType glm::luminosity </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>color</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals. </p>
<p>From GLM_GTX_color_space extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga4ca555f0091dc71c54e36b0ddd9b31bc"></a><!-- doxytag: member="glm::rgbColor" ref="ga4ca555f0091dc71c54e36b0ddd9b31bc" args="(detail::tvec3&lt; valType &gt; const &amp;hsvValue)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;valType&gt; glm::rgbColor </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>hsvValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts a color from HSV color space to its color in RGB color space. </p>
<p>From GLM_GTX_color_space extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="gae45d26f7c6738a365aaa4560193a50ec"></a><!-- doxytag: member="glm::saturation" ref="gae45d26f7c6738a365aaa4560193a50ec" args="(valType const s, detail::tvec3&lt; valType &gt; const &amp;color)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;valType&gt; glm::saturation </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">valType const&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>color</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify the saturation of a color. </p>
<p>From GLM_GTX_color_space extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="gaa5af7f22a8a56b3fb3f98103defe7099"></a><!-- doxytag: member="glm::saturation" ref="gaa5af7f22a8a56b3fb3f98103defe7099" args="(valType const s)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::saturation </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">valType const&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a saturation matrix. </p>
<p>From GLM_GTX_color_space extension </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<a class="anchor" id="ga45546394251769bf7c126dac3b2d5fbf"></a><!-- doxytag: member="glm::saturation" ref="ga45546394251769bf7c126dac3b2d5fbf" args="(valType const s, detail::tvec4&lt; valType &gt; const &amp;color)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;valType&gt; glm::saturation </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">valType const&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec4&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>color</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modify the saturation of a color. </p>
<p>From GLM_GTX_color_space extension. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
2011-11-12 23:26:02 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
2011-10-24 14:24:48 +00:00
</body>
</html>