a00285.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  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.9 API documentation: Stable extensions</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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documentation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#groups">Modules</a> </div>
  78. <div class="headertitle">
  79. <div class="title">Stable extensions</div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Additional features not specified by GLSL specification.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  86. Modules</h2></td></tr>
  87. <tr class="memitem:a00243"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00243.html">GLM_EXT_matrix_clip_space</a></td></tr>
  88. <tr class="memdesc:a00243"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines functions that generate clip space transformation matrices. <br /></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a00244"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html">GLM_EXT_matrix_common</a></td></tr>
  91. <tr class="memdesc:a00244"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines functions for common matrix operations. <br /></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a00245"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00245.html">GLM_EXT_matrix_projection</a></td></tr>
  94. <tr class="memdesc:a00245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions that generate common projection transformation matrices. <br /></td></tr>
  95. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a00246"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00246.html">GLM_EXT_matrix_relational</a></td></tr>
  97. <tr class="memdesc:a00246"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes comparison functions for matrix types that take a user defined epsilon values. <br /></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a00247"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00247.html">GLM_EXT_matrix_transform</a></td></tr>
  100. <tr class="memdesc:a00247"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines functions that generate common transformation matrices. <br /></td></tr>
  101. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a00248"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00248.html">GLM_EXT_quaternion_common</a></td></tr>
  103. <tr class="memdesc:a00248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides common functions for quaternion types. <br /></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a00249"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00249.html">GLM_EXT_quaternion_double</a></td></tr>
  106. <tr class="memdesc:a00249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes double-precision floating point quaternion type. <br /></td></tr>
  107. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a00250"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00250.html">GLM_EXT_quaternion_double_precision</a></td></tr>
  109. <tr class="memdesc:a00250"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes double-precision floating point quaternion type with various precision in term of ULPs. <br /></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a00251"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00251.html">GLM_EXT_quaternion_exponential</a></td></tr>
  112. <tr class="memdesc:a00251"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides exponential functions for quaternion types. <br /></td></tr>
  113. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a00252"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00252.html">GLM_EXT_quaternion_float</a></td></tr>
  115. <tr class="memdesc:a00252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes single-precision floating point quaternion type. <br /></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a00253"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00253.html">GLM_EXT_quaternion_float_precision</a></td></tr>
  118. <tr class="memdesc:a00253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes single-precision floating point quaternion type with various precision in term of ULPs. <br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a00254"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00254.html">GLM_EXT_quaternion_geometric</a></td></tr>
  121. <tr class="memdesc:a00254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides geometric functions for quaternion types. <br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a00255"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00255.html">GLM_EXT_quaternion_relational</a></td></tr>
  124. <tr class="memdesc:a00255"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes comparison functions for quaternion types that take a user defined epsilon values. <br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a00256"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html">GLM_EXT_quaternion_transform</a></td></tr>
  127. <tr class="memdesc:a00256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides transformation functions for quaternion types. <br /></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a00257"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00257.html">GLM_EXT_quaternion_trigonometric</a></td></tr>
  130. <tr class="memdesc:a00257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides trigonometric functions for quaternion types. <br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a00258"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html">GLM_EXT_scalar_common</a></td></tr>
  133. <tr class="memdesc:a00258"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes min and max functions for 3 to 4 scalar parameters. <br /></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a00259"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00259.html">GLM_EXT_scalar_constants</a></td></tr>
  136. <tr class="memdesc:a00259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a list of constants and precomputed useful values. <br /></td></tr>
  137. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a00260"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00260.html">GLM_EXT_scalar_int_sized</a></td></tr>
  139. <tr class="memdesc:a00260"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes sized signed integer scalar types. <br /></td></tr>
  140. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a00261"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00261.html">GLM_EXT_scalar_integer</a></td></tr>
  142. <tr class="memdesc:a00261"><td class="mdescLeft">&#160;</td><td class="mdescRight">Include &lt;<a class="el" href="a00147.html" title="GLM_EXT_scalar_integer ">glm/ext/scalar_integer.hpp</a>&gt; to use the features of this extension. <br /></td></tr>
  143. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a00262"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00262.html">GLM_EXT_scalar_relational</a></td></tr>
  145. <tr class="memdesc:a00262"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes comparison functions for scalar types that take a user defined epsilon values. <br /></td></tr>
  146. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a00263"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00263.html">GLM_EXT_scalar_uint_sized</a></td></tr>
  148. <tr class="memdesc:a00263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes sized unsigned integer scalar types. <br /></td></tr>
  149. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a00264"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00264.html">GLM_EXT_scalar_ulp</a></td></tr>
  151. <tr class="memdesc:a00264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow the measurement of the accuracy of a function against a reference implementation. <br /></td></tr>
  152. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a00265"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00265.html">GLM_EXT_vector_bool1</a></td></tr>
  154. <tr class="memdesc:a00265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes bvec1 vector type. <br /></td></tr>
  155. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a00266"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00266.html">GLM_EXT_vector_bool1_precision</a></td></tr>
  157. <tr class="memdesc:a00266"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes highp_bvec1, mediump_bvec1 and lowp_bvec1 types. <br /></td></tr>
  158. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a00267"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00267.html">GLM_EXT_vector_common</a></td></tr>
  160. <tr class="memdesc:a00267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes min and max functions for 3 to 4 vector parameters. <br /></td></tr>
  161. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a00268"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00268.html">GLM_EXT_vector_double1</a></td></tr>
  163. <tr class="memdesc:a00268"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes double-precision floating point vector type with one component. <br /></td></tr>
  164. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a00269"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html">GLM_EXT_vector_double1_precision</a></td></tr>
  166. <tr class="memdesc:a00269"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes highp_dvec1, mediump_dvec1 and lowp_dvec1 types. <br /></td></tr>
  167. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a00270"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00270.html">GLM_EXT_vector_float1</a></td></tr>
  169. <tr class="memdesc:a00270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes single-precision floating point vector type with one component. <br /></td></tr>
  170. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a00271"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html">GLM_EXT_vector_float1_precision</a></td></tr>
  172. <tr class="memdesc:a00271"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes highp_vec1, mediump_vec1 and lowp_vec1 types. <br /></td></tr>
  173. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a00272"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00272.html">GLM_EXT_vector_int1</a></td></tr>
  175. <tr class="memdesc:a00272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes ivec1 vector type. <br /></td></tr>
  176. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a00273"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00273.html">GLM_EXT_vector_int1_precision</a></td></tr>
  178. <tr class="memdesc:a00273"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes highp_ivec1, mediump_ivec1 and lowp_ivec1 types. <br /></td></tr>
  179. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a00274"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html">GLM_EXT_vector_integer</a></td></tr>
  181. <tr class="memdesc:a00274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Include &lt;<a class="el" href="a00222.html" title="GLM_EXT_vector_integer ">glm/ext/vector_integer.hpp</a>&gt; to use the features of this extension. <br /></td></tr>
  182. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a00275"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html">GLM_EXT_vector_relational</a></td></tr>
  184. <tr class="memdesc:a00275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes comparison functions for vector types that take a user defined epsilon values. <br /></td></tr>
  185. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a00276"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00276.html">GLM_EXT_vector_uint1</a></td></tr>
  187. <tr class="memdesc:a00276"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes uvec1 vector type. <br /></td></tr>
  188. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a00277"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00277.html">GLM_EXT_vector_uint1_precision</a></td></tr>
  190. <tr class="memdesc:a00277"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exposes highp_uvec1, mediump_uvec1 and lowp_uvec1 types. <br /></td></tr>
  191. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a00278"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00278.html">GLM_EXT_vector_ulp</a></td></tr>
  193. <tr class="memdesc:a00278"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow the measurement of the accuracy of a function against a reference implementation. <br /></td></tr>
  194. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. </table>
  196. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  197. <p>Additional features not specified by GLSL specification. </p>
  198. <p>EXT extensions are fully tested and documented.</p>
  199. <p>Even if it's highly unrecommended, it's possible to include all the extensions at once by including &lt;<a class="el" href="a00027.html" title="Core features (Dependence) ">glm/ext.hpp</a>&gt;. Otherwise, each extension needs to be included a specific file. </p>
  200. </div><!-- contents -->
  201. <!-- start footer part -->
  202. <hr class="footer"/><address class="footer"><small>
  203. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  204. <img class="footer" src="doxygen.png" alt="doxygen"/>
  205. </a> 1.8.10
  206. </small></address>
  207. </body>
  208. </html>