a00164.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>GLM_GTX_color_space</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  19. </tr>
  20. </tbody>
  21. </table>
  22. </div>
  23. <!-- end header part -->
  24. <!-- Generated by Doxygen 1.8.2 -->
  25. <div id="navrow1" class="tabs">
  26. <ul class="tablist">
  27. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29. <li><a href="modules.html"><span>Modules</span></a></li>
  30. <li><a href="files.html"><span>Files</span></a></li>
  31. </ul>
  32. </div>
  33. </div><!-- top -->
  34. <div class="header">
  35. <div class="summary">
  36. <a href="#func-members">Functions</a> </div>
  37. <div class="headertitle">
  38. <div class="title">GLM_GTX_color_space</div> </div>
  39. <div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
  40. <div class="contents">
  41. <table class="memberdecls">
  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  43. Functions</h2></td></tr>
  44. <tr class="memitem:ga434478ff2e692c2bc9fbe4d3a05570ea"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  45. <tr class="memitem:ga434478ff2e692c2bc9fbe4d3a05570ea"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#ga434478ff2e692c2bc9fbe4d3a05570ea">hsvColor</a> (detail::tvec3&lt; valType &gt; const &amp;rgbValue)</td></tr>
  46. <tr class="separator:ga434478ff2e692c2bc9fbe4d3a05570ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:gaf9db3b89515c57d9d955b70a97c10f91"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  48. <tr class="memitem:gaf9db3b89515c57d9d955b70a97c10f91"><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#gaf9db3b89515c57d9d955b70a97c10f91">luminosity</a> (detail::tvec3&lt; valType &gt; const &amp;color)</td></tr>
  49. <tr class="separator:gaf9db3b89515c57d9d955b70a97c10f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:ga0106a26e8ceac4e83b428979eb70c6e5"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  51. <tr class="memitem:ga0106a26e8ceac4e83b428979eb70c6e5"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#ga0106a26e8ceac4e83b428979eb70c6e5">rgbColor</a> (detail::tvec3&lt; valType &gt; const &amp;hsvValue)</td></tr>
  52. <tr class="separator:ga0106a26e8ceac4e83b428979eb70c6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga81289d2f4a42f70d5cf66dbb6e75dc97"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  54. <tr class="memitem:ga81289d2f4a42f70d5cf66dbb6e75dc97"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#ga81289d2f4a42f70d5cf66dbb6e75dc97">saturation</a> (valType const s)</td></tr>
  55. <tr class="separator:ga81289d2f4a42f70d5cf66dbb6e75dc97"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga54a479f39450ab45417f5d48abee5fb2"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  57. <tr class="memitem:ga54a479f39450ab45417f5d48abee5fb2"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#ga54a479f39450ab45417f5d48abee5fb2">saturation</a> (valType const s, detail::tvec3&lt; valType &gt; const &amp;color)</td></tr>
  58. <tr class="separator:ga54a479f39450ab45417f5d48abee5fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga2bdc5f77884c822b0dbc92d74a649d87"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  60. <tr class="memitem:ga2bdc5f77884c822b0dbc92d74a649d87"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00164.html#ga2bdc5f77884c822b0dbc92d74a649d87">saturation</a> (valType const s, detail::tvec4&lt; valType &gt; const &amp;color)</td></tr>
  61. <tr class="separator:ga2bdc5f77884c822b0dbc92d74a649d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. </table>
  63. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  64. <p>Related to RGB to HSV conversions and operations. </p>
  65. <p>&lt;<a class="el" href="a00011.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/color_space.hpp</a>&gt; need to be included to use these functionalities. </p>
  66. <h2 class="groupheader">Function Documentation</h2>
  67. <a class="anchor" id="ga434478ff2e692c2bc9fbe4d3a05570ea"></a>
  68. <div class="memitem">
  69. <div class="memproto">
  70. <table class="memname">
  71. <tr>
  72. <td class="memname">detail::tvec3&lt;valType&gt; glm::hsvColor </td>
  73. <td>(</td>
  74. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  75. <td class="paramname"><em>rgbValue</em></td><td>)</td>
  76. <td></td>
  77. </tr>
  78. </table>
  79. </div><div class="memdoc">
  80. <p>Converts a color from RGB color space to its color in HSV color space. </p>
  81. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  82. </div>
  83. </div>
  84. <a class="anchor" id="gaf9db3b89515c57d9d955b70a97c10f91"></a>
  85. <div class="memitem">
  86. <div class="memproto">
  87. <table class="memname">
  88. <tr>
  89. <td class="memname">valType glm::luminosity </td>
  90. <td>(</td>
  91. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  92. <td class="paramname"><em>color</em></td><td>)</td>
  93. <td></td>
  94. </tr>
  95. </table>
  96. </div><div class="memdoc">
  97. <p>Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals. </p>
  98. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  99. </div>
  100. </div>
  101. <a class="anchor" id="ga0106a26e8ceac4e83b428979eb70c6e5"></a>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">detail::tvec3&lt;valType&gt; glm::rgbColor </td>
  107. <td>(</td>
  108. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  109. <td class="paramname"><em>hsvValue</em></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <p>Converts a color from HSV color space to its color in RGB color space. </p>
  115. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  116. </div>
  117. </div>
  118. <a class="anchor" id="ga81289d2f4a42f70d5cf66dbb6e75dc97"></a>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">detail::tmat4x4&lt;valType&gt; glm::saturation </td>
  124. <td>(</td>
  125. <td class="paramtype">valType const&#160;</td>
  126. <td class="paramname"><em>s</em></td><td>)</td>
  127. <td></td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>Build a saturation matrix. </p>
  132. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  133. </div>
  134. </div>
  135. <a class="anchor" id="ga54a479f39450ab45417f5d48abee5fb2"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">detail::tvec3&lt;valType&gt; glm::saturation </td>
  141. <td>(</td>
  142. <td class="paramtype">valType const&#160;</td>
  143. <td class="paramname"><em>s</em>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  149. <td class="paramname"><em>color</em>&#160;</td>
  150. </tr>
  151. <tr>
  152. <td></td>
  153. <td>)</td>
  154. <td></td><td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>Modify the saturation of a color. </p>
  159. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  160. </div>
  161. </div>
  162. <a class="anchor" id="ga2bdc5f77884c822b0dbc92d74a649d87"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">detail::tvec4&lt;valType&gt; glm::saturation </td>
  168. <td>(</td>
  169. <td class="paramtype">valType const&#160;</td>
  170. <td class="paramname"><em>s</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">detail::tvec4&lt; valType &gt; const &amp;&#160;</td>
  176. <td class="paramname"><em>color</em>&#160;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Modify the saturation of a color. </p>
  186. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00164.html" title="Related to RGB to HSV conversions and operations.">GLM_GTX_color_space</a> </dd></dl>
  187. </div>
  188. </div>
  189. </div><!-- contents -->
  190. <!-- start footer part -->
  191. <hr class="footer"/><address class="footer"><small>
  192. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  193. <img class="footer" src="doxygen.png" alt="doxygen"/>
  194. </a> 1.8.2
  195. </small></address>
  196. </body>
  197. </html>