a00188.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  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.5"/>
  7. <title>GLM: 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 style="padding-left: 0.5em;">
  20. <div id="projectname">GLM
  21. &#160;<span id="projectnumber">0.9.5</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.5 -->
  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="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. </div><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#func-members">Functions</a> </div>
  43. <div class="headertitle">
  44. <div class="title">GLM_GTX_color_space<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  51. <tr class="memitem:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gaef4a1b7ed5bec43e245cd152951ec28a">hsvColor</a> (detail::tvec3&lt; T, P &gt; const &amp;rgbValue)</td></tr>
  52. <tr class="separator:gaef4a1b7ed5bec43e245cd152951ec28a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gac62caac6baddd276a9569b3630fd47bf"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  54. <tr class="memitem:gac62caac6baddd276a9569b3630fd47bf"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gac62caac6baddd276a9569b3630fd47bf">luminosity</a> (detail::tvec3&lt; T, P &gt; const &amp;color)</td></tr>
  55. <tr class="separator:gac62caac6baddd276a9569b3630fd47bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  57. <tr class="memitem:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#ga8c25ad5eee2386d7f5180ccaa0523246">rgbColor</a> (detail::tvec3&lt; T, P &gt; const &amp;hsvValue)</td></tr>
  58. <tr class="separator:ga8c25ad5eee2386d7f5180ccaa0523246"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gad616175dd13cffd581c1bc30c8e3f904"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  60. <tr class="memitem:gad616175dd13cffd581c1bc30c8e3f904"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gad616175dd13cffd581c1bc30c8e3f904">saturation</a> (T const s)</td></tr>
  61. <tr class="separator:gad616175dd13cffd581c1bc30c8e3f904"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  63. <tr class="memitem:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#ga7cd62eb3794fa48b192dbf655e37ea94">saturation</a> (T const s, detail::tvec3&lt; T, P &gt; const &amp;color)</td></tr>
  64. <tr class="separator:ga7cd62eb3794fa48b192dbf655e37ea94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gae192fb7020b374297e54ae12dda1c478"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  66. <tr class="memitem:gae192fb7020b374297e54ae12dda1c478"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00188.html#gae192fb7020b374297e54ae12dda1c478">saturation</a> (T const s, detail::tvec4&lt; T, P &gt; const &amp;color)</td></tr>
  67. <tr class="separator:gae192fb7020b374297e54ae12dda1c478"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. </table>
  69. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  70. <p>Related to RGB to HSV conversions and operations. </p>
  71. <p>&lt;<a class="el" href="a00014.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/color_space.hpp</a>&gt; need to be included to use these functionalities. </p>
  72. <h2 class="groupheader">Function Documentation</h2>
  73. <a class="anchor" id="gaef4a1b7ed5bec43e245cd152951ec28a"></a>
  74. <div class="memitem">
  75. <div class="memproto">
  76. <table class="memname">
  77. <tr>
  78. <td class="memname">detail::tvec3&lt;T, P&gt; glm::hsvColor </td>
  79. <td>(</td>
  80. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  81. <td class="paramname"><em>rgbValue</em></td><td>)</td>
  82. <td></td>
  83. </tr>
  84. </table>
  85. </div><div class="memdoc">
  86. <p>Converts a color from RGB color space to its color in HSV color space. </p>
  87. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  88. </div>
  89. </div>
  90. <a class="anchor" id="gac62caac6baddd276a9569b3630fd47bf"></a>
  91. <div class="memitem">
  92. <div class="memproto">
  93. <table class="memname">
  94. <tr>
  95. <td class="memname">T glm::luminosity </td>
  96. <td>(</td>
  97. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  98. <td class="paramname"><em>color</em></td><td>)</td>
  99. <td></td>
  100. </tr>
  101. </table>
  102. </div><div class="memdoc">
  103. <p>Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals. </p>
  104. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  105. </div>
  106. </div>
  107. <a class="anchor" id="ga8c25ad5eee2386d7f5180ccaa0523246"></a>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">detail::tvec3&lt;T, P&gt; glm::rgbColor </td>
  113. <td>(</td>
  114. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  115. <td class="paramname"><em>hsvValue</em></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </div><div class="memdoc">
  120. <p>Converts a color from HSV color space to its color in RGB color space. </p>
  121. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  122. </div>
  123. </div>
  124. <a class="anchor" id="gad616175dd13cffd581c1bc30c8e3f904"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">detail::tmat4x4&lt;T, P&gt; glm::saturation </td>
  130. <td>(</td>
  131. <td class="paramtype">T const&#160;</td>
  132. <td class="paramname"><em>s</em></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Build a saturation matrix. </p>
  138. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  139. </div>
  140. </div>
  141. <a class="anchor" id="ga7cd62eb3794fa48b192dbf655e37ea94"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">detail::tvec3&lt;T, P&gt; glm::saturation </td>
  147. <td>(</td>
  148. <td class="paramtype">T const&#160;</td>
  149. <td class="paramname"><em>s</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  155. <td class="paramname"><em>color</em>&#160;</td>
  156. </tr>
  157. <tr>
  158. <td></td>
  159. <td>)</td>
  160. <td></td><td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Modify the saturation of a color. </p>
  165. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  166. </div>
  167. </div>
  168. <a class="anchor" id="gae192fb7020b374297e54ae12dda1c478"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">detail::tvec4&lt;T, P&gt; glm::saturation </td>
  174. <td>(</td>
  175. <td class="paramtype">T const&#160;</td>
  176. <td class="paramname"><em>s</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">detail::tvec4&lt; T, P &gt; const &amp;&#160;</td>
  182. <td class="paramname"><em>color</em>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Modify the saturation of a color. </p>
  192. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00188.html" title="Related to RGB to HSV conversions and operations. ">GLM_GTX_color_space</a> </dd></dl>
  193. </div>
  194. </div>
  195. </div><!-- contents -->
  196. <!-- start footer part -->
  197. <hr class="footer"/><address class="footer"><small>
  198. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  199. <img class="footer" src="doxygen.png" alt="doxygen"/>
  200. </a> 1.8.5
  201. </small></address>
  202. </body>
  203. </html>