a00184.html 10 KB

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