Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Precision types</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<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="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,12 +46,9 @@
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>Precision types</h1> </div>
<div class="title">Precision types</div> </div>
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<p>Non-GLSL types that are used to define precision-based types.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
@@ -144,7 +155,7 @@ Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef detail::tvec4<br class="typebreak"/>
&lt; mediump_float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00156.html#gafddaa69a1d46a27e2767b780e0e6b4b0">mediump_vec4</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Non-GLSL types that are used to define precision-based types. </p>
<p>The GLSL language allows the user to define the precision of a particular variable. In OpenGL's GLSL, these precision qualifiers have no effect; they are there for compatibility with OpenGL ES's precision qualifiers, where they <em>do</em> have an effect.</p>
<p>C++ has no language equivalent to precision qualifiers. So GLM provides the next-best thing: a number of typedefs of the <a class="el" href="a00157.html">Template types</a> that use a particular precision.</p>
@@ -164,7 +175,7 @@ Typedefs</h2></td></tr>
<p>High precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification </p>
<p>Definition at line <a class="el" href="a00108_source.html#l00070">70</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00108_source.html#l00061">61</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
</div>
</div>
@@ -200,7 +211,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of high precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00269">269</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00268">268</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -218,7 +229,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of high precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00294">294</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00293">293</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -236,7 +247,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of high precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00351">351</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00350">350</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -434,7 +445,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of high precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00287">287</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00286">286</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -452,7 +463,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of high precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00312">312</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00311">311</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -470,7 +481,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of high precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00369">369</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00368">368</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -488,7 +499,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of high precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00251">251</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00250">250</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -506,7 +517,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of high precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00276">276</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00275">275</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -524,7 +535,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of high precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00333">333</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00332">332</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -542,7 +553,7 @@ Typedefs</h2></td></tr>
<p>Low precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification </p>
<p>Definition at line <a class="el" href="a00108_source.html#l00058">58</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00108_source.html#l00049">49</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
</div>
</div>
@@ -578,7 +589,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of low precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00281">281</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00280">280</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -596,7 +607,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of low precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00306">306</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00305">305</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -614,7 +625,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of low precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00363">363</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00362">362</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -812,7 +823,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of low precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00299">299</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00298">298</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -830,7 +841,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of low precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00324">324</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00323">323</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -848,7 +859,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of low precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00381">381</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00380">380</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -866,7 +877,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of low precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00263">263</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00262">262</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -884,7 +895,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of low precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00288">288</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00287">287</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -902,7 +913,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of low precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00345">345</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00344">344</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -920,7 +931,7 @@ Typedefs</h2></td></tr>
<p>Medium precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification </p>
<p>Definition at line <a class="el" href="a00108_source.html#l00064">64</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00108_source.html#l00055">55</a> of file <a class="el" href="a00108_source.html">type_float.hpp</a>.</p>
</div>
</div>
@@ -956,7 +967,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of medium precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00275">275</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00274">274</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -974,7 +985,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of medium precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00300">300</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00299">299</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -992,7 +1003,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of medium precision signed integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00357">357</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00356">356</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -1190,7 +1201,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of medium precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00293">293</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00292">292</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -1208,7 +1219,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of medium precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00318">318</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00317">317</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -1226,7 +1237,7 @@ Typedefs</h2></td></tr>
<p>4 components vector of medium precision unsigned integer numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.1.5 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00375">375</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00374">374</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
@@ -1244,7 +1255,7 @@ Typedefs</h2></td></tr>
<p>2 components vector of medium precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00257">257</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00127_source.html#l00256">256</a> of file <a class="el" href="a00127_source.html">type_vec2.hpp</a>.</p>
</div>
</div>
@@ -1262,7 +1273,7 @@ Typedefs</h2></td></tr>
<p>3 components vector of medium precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00128_source.html#l00282">282</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00128_source.html#l00281">281</a> of file <a class="el" href="a00128_source.html">type_vec3.hpp</a>.</p>
</div>
</div>
@@ -1280,13 +1291,18 @@ Typedefs</h2></td></tr>
<p>4 components vector of medium precision floating-point numbers. </p>
<p>There is no guarantee on the actual precision. From GLSL 1.30.8 specification, section 4.5.2 Precision Qualifiers. </p>
<p>Definition at line <a class="el" href="a00129_source.html#l00339">339</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
<p>Definition at line <a class="el" href="a00129_source.html#l00338">338</a> of file <a class="el" href="a00129_source.html">type_vec4.hpp</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>