Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.9
Branches Tags
glm
/
doc
/
api
/
a00312.html

a00312.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.10"/>
    7. 

  7. <title>0.9.9 API documentation: GLM_GTX_color_space</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="search/searchdata.js"></script>
    13. 

  13. <script type="text/javascript" src="search/search.js"></script>
    14. 

  14. <script type="text/javascript">
    15. 

  15.   $(document).ready(function() { init_search(); });
    16. 

  16. </script>
    17. 

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    18. 

  18. </head>
    19. 

  19. <body>
    20. 

  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    21. 

  21. <div id="titlearea">
    22. 

  22. <table cellspacing="0" cellpadding="0">
    23. 

  23.  <tbody>
    24. 

  24.  <tr style="height: 56px;">
    25. 

  25.   <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
    26. 

  26.   <td id="projectalign" style="padding-left: 0.5em;">
    27. 

  27.    <div id="projectname">0.9.9 API documentation
    28. 

  28.    </div>
    29. 

  29.   </td>
    30. 

  30.  </tr>
    31. 

  31.  </tbody>
    32. 

  32. </table>
    33. 

  33. </div>
    34. 

  34. <!-- end header part -->
    35. 

  35. <!-- Generated by Doxygen 1.8.10 -->
    36. 

  36. <script type="text/javascript">
    37. 

  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    38. 

  38. </script>
    39. 

  39.   <div id="navrow1" class="tabs">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    42. 

  42.       <li><a href="modules.html"><span>Modules</span></a></li>
    43. 

  43.       <li><a href="files.html"><span>Files</span></a></li>
    44. 

  44.       <li>
    45. 

  45.         <div id="MSearchBox" class="MSearchBoxInactive">
    46. 

  46.         <span class="left">
    47. 

  47.           <img id="MSearchSelect" src="search/mag_sel.png"
    48. 

  48.                onmouseover="return searchBox.OnSearchSelectShow()"
    49. 

  49.                onmouseout="return searchBox.OnSearchSelectHide()"
    50. 

  50.                alt=""/>
    51. 

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    52. 

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    53. 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 
    54. 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    55. 

  55.           </span><span class="right">
    56. 

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    57. 

  57.           </span>
    58. 

  58.         </div>
    59. 

  59.       </li>
    60. 

  60.     </ul>
    61. 

  61.   </div>
    62. 

  62. </div><!-- top -->
    63. 

  63. <!-- window showing the filter options -->
    64. 

  64. <div id="MSearchSelectWindow"
    65. 

  65.      onmouseover="return searchBox.OnSearchSelectShow()"
    66. 

  66.      onmouseout="return searchBox.OnSearchSelectHide()"
    67. 

  67.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    68. 

  68. </div>
    69. 

  69. 

  70. <!-- iframe showing the search results (closed by default) -->
    71. 

  71. <div id="MSearchResultsWindow">
    72. 

  72. <iframe src="javascript:void(0)" frameborder="0" 
    73. 

  73.         name="MSearchResults" id="MSearchResults">
    74. 

  74. </iframe>
    75. 

  75. </div>
    76. 

  76. 

  77. <div class="header">
    78. 

  78.   <div class="summary">
    79. 

  79. <a href="#func-members">Functions</a>  </div>
    80. 

  80.   <div class="headertitle">
    81. 

  81. <div class="title">GLM_GTX_color_space<div class="ingroups"><a class="el" href="a00287.html">Experimental extensions</a></div></div>  </div>
    82. 

  82. </div><!--header-->
    83. 

  83. <div class="contents">
    84. 

  84. 

  85. <p>Include &lt;<a class="el" href="a00013.html" title="GLM_GTX_color_space ">glm/gtx/color_space.hpp</a>&gt; to use the features of this extension.  
    86. 

  86. <a href="#details">More...</a></p>
    87. 

  87. <table class="memberdecls">
    88. 

  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    89. 

  89. Functions</h2></td></tr>
    90. 

  90. <tr class="memitem:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    91. 

  91. <tr class="memitem:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#ga789802bec2d4fe0f9741c731b4a8a7d8">hsvColor</a> (vec&lt; 3, T, Q &gt; const &amp;rgbValue)</td></tr>
    92. 

  92. <tr class="memdesc:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a color from RGB color space to its color in HSV color space.  <a href="a00312.html#ga789802bec2d4fe0f9741c731b4a8a7d8">More...</a><br /></td></tr>
    93. 

  93. <tr class="separator:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    94. 

  94. <tr class="memitem:gad028e0a4f1a9c812b39439b746295b34"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    95. 

  95. <tr class="memitem:gad028e0a4f1a9c812b39439b746295b34"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#gad028e0a4f1a9c812b39439b746295b34">luminosity</a> (vec&lt; 3, T, Q &gt; const &amp;color)</td></tr>
    96. 

  96. <tr class="memdesc:gad028e0a4f1a9c812b39439b746295b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals.  <a href="a00312.html#gad028e0a4f1a9c812b39439b746295b34">More...</a><br /></td></tr>
    97. 

  97. <tr class="separator:gad028e0a4f1a9c812b39439b746295b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
    98. 

  98. <tr class="memitem:ga5f9193be46f45f0655c05a0cdca006db"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    99. 

  99. <tr class="memitem:ga5f9193be46f45f0655c05a0cdca006db"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#ga5f9193be46f45f0655c05a0cdca006db">rgbColor</a> (vec&lt; 3, T, Q &gt; const &amp;hsvValue)</td></tr>
    100. 

  100. <tr class="memdesc:ga5f9193be46f45f0655c05a0cdca006db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a color from HSV color space to its color in RGB color space.  <a href="a00312.html#ga5f9193be46f45f0655c05a0cdca006db">More...</a><br /></td></tr>
    101. 

  101. <tr class="separator:ga5f9193be46f45f0655c05a0cdca006db"><td class="memSeparator" colspan="2">&#160;</td></tr>
    102. 

  102. <tr class="memitem:ga01a97152b44e1550edcac60bd849e884"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
    103. 

  103. <tr class="memitem:ga01a97152b44e1550edcac60bd849e884"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#ga01a97152b44e1550edcac60bd849e884">saturation</a> (T const s)</td></tr>
    104. 

  104. <tr class="memdesc:ga01a97152b44e1550edcac60bd849e884"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a saturation matrix.  <a href="a00312.html#ga01a97152b44e1550edcac60bd849e884">More...</a><br /></td></tr>
    105. 

  105. <tr class="separator:ga01a97152b44e1550edcac60bd849e884"><td class="memSeparator" colspan="2">&#160;</td></tr>
    106. 

  106. <tr class="memitem:ga2156cea600e90148ece5bc96fd6db43a"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    107. 

  107. <tr class="memitem:ga2156cea600e90148ece5bc96fd6db43a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#ga2156cea600e90148ece5bc96fd6db43a">saturation</a> (T const s, vec&lt; 3, T, Q &gt; const &amp;color)</td></tr>
    108. 

  108. <tr class="memdesc:ga2156cea600e90148ece5bc96fd6db43a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify the saturation of a color.  <a href="a00312.html#ga2156cea600e90148ece5bc96fd6db43a">More...</a><br /></td></tr>
    109. 

  109. <tr class="separator:ga2156cea600e90148ece5bc96fd6db43a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    110. 

  110. <tr class="memitem:gaba0eacee0736dae860e9371cc1ae4785"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    111. 

  111. <tr class="memitem:gaba0eacee0736dae860e9371cc1ae4785"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00312.html#gaba0eacee0736dae860e9371cc1ae4785">saturation</a> (T const s, vec&lt; 4, T, Q &gt; const &amp;color)</td></tr>
    112. 

  112. <tr class="memdesc:gaba0eacee0736dae860e9371cc1ae4785"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify the saturation of a color.  <a href="a00312.html#gaba0eacee0736dae860e9371cc1ae4785">More...</a><br /></td></tr>
    113. 

  113. <tr class="separator:gaba0eacee0736dae860e9371cc1ae4785"><td class="memSeparator" colspan="2">&#160;</td></tr>
    114. 

  114. </table>
    115. 

  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    116. 

  116. <p>Include &lt;<a class="el" href="a00013.html" title="GLM_GTX_color_space ">glm/gtx/color_space.hpp</a>&gt; to use the features of this extension. </p>
    117. 

  117. <p>Related to RGB to HSV conversions and operations. </p>
    118. 

  118. <h2 class="groupheader">Function Documentation</h2>
    119. 

  119. <a class="anchor" id="ga789802bec2d4fe0f9741c731b4a8a7d8"></a>
    120. 

  120. <div class="memitem">
    121. 

  121. <div class="memproto">
    122. 

  122.       <table class="memname">
    123. 

  123.         <tr>
    124. 

  124.           <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::hsvColor </td>
    125. 

  125.           <td>(</td>
    126. 

  126.           <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
    127. 

  127.           <td class="paramname"><em>rgbValue</em></td><td>)</td>
    128. 

  128.           <td></td>
    129. 

  129.         </tr>
    130. 

  130.       </table>
    131. 

  131. </div><div class="memdoc">
    132. 

  132. 

  133. <p>Converts a color from RGB color space to its color in HSV color space. </p>
    134. 

  134. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    135. 

  135. 

  136. </div>
    137. 

  137. </div>
    138. 

  138. <a class="anchor" id="gad028e0a4f1a9c812b39439b746295b34"></a>
    139. 

  139. <div class="memitem">
    140. 

  140. <div class="memproto">
    141. 

  141.       <table class="memname">
    142. 

  142.         <tr>
    143. 

  143.           <td class="memname">GLM_FUNC_DECL T glm::luminosity </td>
    144. 

  144.           <td>(</td>
    145. 

  145.           <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
    146. 

  146.           <td class="paramname"><em>color</em></td><td>)</td>
    147. 

  147.           <td></td>
    148. 

  148.         </tr>
    149. 

  149.       </table>
    150. 

  150. </div><div class="memdoc">
    151. 

  151. 

  152. <p>Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals. </p>
    153. 

  153. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    154. 

  154. 

  155. </div>
    156. 

  156. </div>
    157. 

  157. <a class="anchor" id="ga5f9193be46f45f0655c05a0cdca006db"></a>
    158. 

  158. <div class="memitem">
    159. 

  159. <div class="memproto">
    160. 

  160.       <table class="memname">
    161. 

  161.         <tr>
    162. 

  162.           <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::rgbColor </td>
    163. 

  163.           <td>(</td>
    164. 

  164.           <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
    165. 

  165.           <td class="paramname"><em>hsvValue</em></td><td>)</td>
    166. 

  166.           <td></td>
    167. 

  167.         </tr>
    168. 

  168.       </table>
    169. 

  169. </div><div class="memdoc">
    170. 

  170. 

  171. <p>Converts a color from HSV color space to its color in RGB color space. </p>
    172. 

  172. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    173. 

  173. 

  174. </div>
    175. 

  175. </div>
    176. 

  176. <a class="anchor" id="ga01a97152b44e1550edcac60bd849e884"></a>
    177. 

  177. <div class="memitem">
    178. 

  178. <div class="memproto">
    179. 

  179.       <table class="memname">
    180. 

  180.         <tr>
    181. 

  181.           <td class="memname">GLM_FUNC_DECL mat&lt;4, 4, T, defaultp&gt; glm::saturation </td>
    182. 

  182.           <td>(</td>
    183. 

  183.           <td class="paramtype">T const&#160;</td>
    184. 

  184.           <td class="paramname"><em>s</em></td><td>)</td>
    185. 

  185.           <td></td>
    186. 

  186.         </tr>
    187. 

  187.       </table>
    188. 

  188. </div><div class="memdoc">
    189. 

  189. 

  190. <p>Build a saturation matrix. </p>
    191. 

  191. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    192. 

  192. 

  193. </div>
    194. 

  194. </div>
    195. 

  195. <a class="anchor" id="ga2156cea600e90148ece5bc96fd6db43a"></a>
    196. 

  196. <div class="memitem">
    197. 

  197. <div class="memproto">
    198. 

  198.       <table class="memname">
    199. 

  199.         <tr>
    200. 

  200.           <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::saturation </td>
    201. 

  201.           <td>(</td>
    202. 

  202.           <td class="paramtype">T const&#160;</td>
    203. 

  203.           <td class="paramname"><em>s</em>, </td>
    204. 

  204.         </tr>
    205. 

  205.         <tr>
    206. 

  206.           <td class="paramkey"></td>
    207. 

  207.           <td></td>
    208. 

  208.           <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
    209. 

  209.           <td class="paramname"><em>color</em>&#160;</td>
    210. 

  210.         </tr>
    211. 

  211.         <tr>
    212. 

  212.           <td></td>
    213. 

  213.           <td>)</td>
    214. 

  214.           <td></td><td></td>
    215. 

  215.         </tr>
    216. 

  216.       </table>
    217. 

  217. </div><div class="memdoc">
    218. 

  218. 

  219. <p>Modify the saturation of a color. </p>
    220. 

  220. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    221. 

  221. 

  222. </div>
    223. 

  223. </div>
    224. 

  224. <a class="anchor" id="gaba0eacee0736dae860e9371cc1ae4785"></a>
    225. 

  225. <div class="memitem">
    226. 

  226. <div class="memproto">
    227. 

  227.       <table class="memname">
    228. 

  228.         <tr>
    229. 

  229.           <td class="memname">GLM_FUNC_DECL vec&lt;4, T, Q&gt; glm::saturation </td>
    230. 

  230.           <td>(</td>
    231. 

  231.           <td class="paramtype">T const&#160;</td>
    232. 

  232.           <td class="paramname"><em>s</em>, </td>
    233. 

  233.         </tr>
    234. 

  234.         <tr>
    235. 

  235.           <td class="paramkey"></td>
    236. 

  236.           <td></td>
    237. 

  237.           <td class="paramtype">vec&lt; 4, T, Q &gt; const &amp;&#160;</td>
    238. 

  238.           <td class="paramname"><em>color</em>&#160;</td>
    239. 

  239.         </tr>
    240. 

  240.         <tr>
    241. 

  241.           <td></td>
    242. 

  242.           <td>)</td>
    243. 

  243.           <td></td><td></td>
    244. 

  244.         </tr>
    245. 

  245.       </table>
    246. 

  246. </div><div class="memdoc">
    247. 

  247. 

  248. <p>Modify the saturation of a color. </p>
    249. 

  249. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00312.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
    250. 

  250. 

  251. </div>
    252. 

  252. </div>
    253. 

  253. </div><!-- contents -->
    254. 

  254. <!-- start footer part -->
    255. 

  255. <hr class="footer"/><address class="footer"><small>
    256. 

  256. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    257. 

  257. <img class="footer" src="doxygen.png" alt="doxygen"/>
    258. 

  258. </a> 1.8.10
    259. 

  259. </small></address>
    260. 

  260. </body>
    261. 

  261. </html>
    262.