mirror of
https://github.com/g-truc/glm.git
synced 2024-11-15 06:24:34 +00:00
6b1e7c6418
Replaced "documenation" with "documentation".
252 lines
13 KiB
HTML
252 lines
13 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>0.9.9 API documentation: GLM_GTX_color_space</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.9 API documentation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTX_color_space<div class="ingroups"><a class="el" href="a00705.html">Experimental extensions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#ga789802bec2d4fe0f9741c731b4a8a7d8">hsvColor</a> (vec< 3, T, Q > const &rgbValue)</td></tr>
|
|
<tr class="separator:ga789802bec2d4fe0f9741c731b4a8a7d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad028e0a4f1a9c812b39439b746295b34"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gad028e0a4f1a9c812b39439b746295b34"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#gad028e0a4f1a9c812b39439b746295b34">luminosity</a> (vec< 3, T, Q > const &color)</td></tr>
|
|
<tr class="separator:gad028e0a4f1a9c812b39439b746295b34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5f9193be46f45f0655c05a0cdca006db"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga5f9193be46f45f0655c05a0cdca006db"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#ga5f9193be46f45f0655c05a0cdca006db">rgbColor</a> (vec< 3, T, Q > const &hsvValue)</td></tr>
|
|
<tr class="separator:ga5f9193be46f45f0655c05a0cdca006db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga01a97152b44e1550edcac60bd849e884"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ga01a97152b44e1550edcac60bd849e884"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, defaultp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#ga01a97152b44e1550edcac60bd849e884">saturation</a> (T const s)</td></tr>
|
|
<tr class="separator:ga01a97152b44e1550edcac60bd849e884"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2156cea600e90148ece5bc96fd6db43a"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga2156cea600e90148ece5bc96fd6db43a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#ga2156cea600e90148ece5bc96fd6db43a">saturation</a> (T const s, vec< 3, T, Q > const &color)</td></tr>
|
|
<tr class="separator:ga2156cea600e90148ece5bc96fd6db43a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaba0eacee0736dae860e9371cc1ae4785"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gaba0eacee0736dae860e9371cc1ae4785"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 4, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00729.html#gaba0eacee0736dae860e9371cc1ae4785">saturation</a> (T const s, vec< 4, T, Q > const &color)</td></tr>
|
|
<tr class="separator:gaba0eacee0736dae860e9371cc1ae4785"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Include <<a class="el" href="a01349.html" title="GLM_GTX_color_space ">glm/gtx/color_space.hpp</a>> to use the features of this extension. </p>
|
|
<p>Related to RGB to HSV conversions and operations. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga789802bec2d4fe0f9741c731b4a8a7d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga789802bec2d4fe0f9741c731b4a8a7d8">◆ </a></span>hsvColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::hsvColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad028e0a4f1a9c812b39439b746295b34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad028e0a4f1a9c812b39439b746295b34">◆ </a></span>luminosity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T glm::luminosity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5f9193be46f45f0655c05a0cdca006db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5f9193be46f45f0655c05a0cdca006db">◆ </a></span>rgbColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::rgbColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga01a97152b44e1550edcac60bd849e884"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga01a97152b44e1550edcac60bd849e884">◆ </a></span>saturation() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, defaultp> glm::saturation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Build a saturation matrix. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2156cea600e90148ece5bc96fd6db43a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2156cea600e90148ece5bc96fd6db43a">◆ </a></span>saturation() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<3, T, Q> glm::saturation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const </td>
|
|
<td class="paramname"><em>s</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 3, T, Q > const & </td>
|
|
<td class="paramname"><em>color</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaba0eacee0736dae860e9371cc1ae4785"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaba0eacee0736dae860e9371cc1ae4785">◆ </a></span>saturation() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<4, T, Q> glm::saturation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const </td>
|
|
<td class="paramname"><em>s</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 4, T, Q > const & </td>
|
|
<td class="paramname"><em>color</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00729.html" title="Include <glm/gtx/color_space.hpp> to use the features of this extension. ">GLM_GTX_color_space</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|