a00153.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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 documenation: GTC Extensions (Stable)</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 documenation
  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">GTC Extensions (Stable)</div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Functions and types that the GLSL specification doesn't define, but useful to have for a C++ program.
  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:a00159"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00159.html">GLM_GTC_bitfield</a></td></tr>
  88. <tr class="memdesc:a00159"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow to perform bit operations on integer values. <br /></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a00160"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html">GLM_GTC_color_encoding</a></td></tr>
  91. <tr class="memdesc:a00160"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow to perform bit operations on integer values. <br /></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a00161"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html">GLM_GTC_color_space</a></td></tr>
  94. <tr class="memdesc:a00161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow to perform bit operations on integer values. <br /></td></tr>
  95. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a00162"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html">GLM_GTC_constants</a></td></tr>
  97. <tr class="memdesc:a00162"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide a list of constants and precomputed useful values. <br /></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a00163"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html">GLM_GTC_epsilon</a></td></tr>
  100. <tr class="memdesc:a00163"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comparison functions for a user defined epsilon values. <br /></td></tr>
  101. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a00164"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00164.html">GLM_GTC_functions</a></td></tr>
  103. <tr class="memdesc:a00164"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of useful common functions. <br /></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a00165"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html">GLM_GTC_integer</a></td></tr>
  106. <tr class="memdesc:a00165"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow to perform bit operations on integer values. <br /></td></tr>
  107. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a00166"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00166.html">GLM_GTC_matrix_access</a></td></tr>
  109. <tr class="memdesc:a00166"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines functions to access rows or columns of a matrix easily. <br /></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a00167"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00167.html">GLM_GTC_matrix_integer</a></td></tr>
  112. <tr class="memdesc:a00167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines a number of matrices with integer types. <br /></td></tr>
  113. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a00168"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html">GLM_GTC_matrix_inverse</a></td></tr>
  115. <tr class="memdesc:a00168"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines additional matrix inverting functions. <br /></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a00169"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html">GLM_GTC_matrix_transform</a></td></tr>
  118. <tr class="memdesc:a00169"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines functions that generate common transformation matrices. <br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a00170"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html">GLM_GTC_noise</a></td></tr>
  121. <tr class="memdesc:a00170"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": <a href="https://github.com/ashima/webgl-noise">https://github.com/ashima/webgl-noise</a> Following Stefan Gustavson's paper "Simplex noise demystified": <a href="http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf">http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf</a> &lt;<a class="el" href="a00074.html" title="GLM_GTC_noise ">glm/gtc/noise.hpp</a>&gt; need to be included to use these functionalities. <br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a00171"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html">GLM_GTC_packing</a></td></tr>
  124. <tr class="memdesc:a00171"><td class="mdescLeft">&#160;</td><td class="mdescRight">This extension provides a set of function to convert vertors to packed formats. <br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a00172"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00172.html">GLM_GTC_quaternion</a></td></tr>
  127. <tr class="memdesc:a00172"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines a templated quaternion type and several quaternion operations. <br /></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a00173"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html">GLM_GTC_random</a></td></tr>
  130. <tr class="memdesc:a00173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random number from various distribution methods. <br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a00174"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html">GLM_GTC_reciprocal</a></td></tr>
  133. <tr class="memdesc:a00174"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define secant, cosecant and cotangent functions. <br /></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a00175"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html">GLM_GTC_round</a></td></tr>
  136. <tr class="memdesc:a00175"><td class="mdescLeft">&#160;</td><td class="mdescRight">rounding value to specific boundings <br /></td></tr>
  137. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a00176"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00176.html">GLM_GTC_type_aligned</a></td></tr>
  139. <tr class="memdesc:a00176"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aligned types. <br /></td></tr>
  140. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a00177"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html">GLM_GTC_type_precision</a></td></tr>
  142. <tr class="memdesc:a00177"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines specific C++-based precision types. <br /></td></tr>
  143. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a00178"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00178.html">GLM_GTC_type_ptr</a></td></tr>
  145. <tr class="memdesc:a00178"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles the interaction between pointers and vector, matrix types. <br /></td></tr>
  146. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a00179"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html">GLM_GTC_ulp</a></td></tr>
  148. <tr class="memdesc:a00179"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow the measurement of the accuracy of a function against a reference implementation. <br /></td></tr>
  149. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a00180"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00180.html">GLM_GTC_vec1</a></td></tr>
  151. <tr class="memdesc:a00180"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add vec1, ivec1, uvec1 and bvec1 types. <br /></td></tr>
  152. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table>
  154. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  155. <p>Functions and types that the GLSL specification doesn't define, but useful to have for a C++ program. </p>
  156. <p>GTC extensions aim to be stable.</p>
  157. <p>Even if it's highly unrecommended, it's possible to include all the extensions at once by including &lt;<a class="el" href="a00024.html" title="GLM Core (Dependence) ">glm/ext.hpp</a>&gt;. Otherwise, each extension needs to be included a specific file. </p>
  158. </div><!-- contents -->
  159. <!-- start footer part -->
  160. <hr class="footer"/><address class="footer"><small>
  161. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  162. <img class="footer" src="doxygen.png" alt="doxygen"/>
  163. </a> 1.8.10
  164. </small></address>
  165. </body>
  166. </html>