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
/
a00341.html

a00341.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298 
  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_matrix_transform_2d</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_matrix_transform_2d<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="a00110.html" title="GLM_GTX_matrix_transform_2d ">glm/gtx/matrix_transform_2d.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:gad5c84a4932a758f385a87098ce1b1660"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
    91. 

  91. <tr class="memitem:gad5c84a4932a758f385a87098ce1b1660"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00341.html#gad5c84a4932a758f385a87098ce1b1660">rotate</a> (mat&lt; 3, 3, T, Q &gt; const &amp;m, T angle)</td></tr>
    92. 

  92. <tr class="memdesc:gad5c84a4932a758f385a87098ce1b1660"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a rotation 3 * 3 matrix created from an angle.  <a href="a00341.html#gad5c84a4932a758f385a87098ce1b1660">More...</a><br /></td></tr>
    93. 

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

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

  95. <tr class="memitem:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00341.html#gadb47d2ad2bd984b213e8ff7d9cd8154e">scale</a> (mat&lt; 3, 3, T, Q &gt; const &amp;m, vec&lt; 2, T, Q &gt; const &amp;v)</td></tr>
    96. 

  96. <tr class="memdesc:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a scale 3 * 3 matrix created from a vector of 2 components.  <a href="a00341.html#gadb47d2ad2bd984b213e8ff7d9cd8154e">More...</a><br /></td></tr>
    97. 

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

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

  99. <tr class="memitem:ga2a118ece5db1e2022112b954846012af"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00341.html#ga2a118ece5db1e2022112b954846012af">shearX</a> (mat&lt; 3, 3, T, Q &gt; const &amp;m, T y)</td></tr>
    100. 

  100. <tr class="memdesc:ga2a118ece5db1e2022112b954846012af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix.  <a href="a00341.html#ga2a118ece5db1e2022112b954846012af">More...</a><br /></td></tr>
    101. 

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

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

  103. <tr class="memitem:ga717f1833369c1ac4a40e4ac015af885e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00341.html#ga717f1833369c1ac4a40e4ac015af885e">shearY</a> (mat&lt; 3, 3, T, Q &gt; const &amp;m, T x)</td></tr>
    104. 

  104. <tr class="memdesc:ga717f1833369c1ac4a40e4ac015af885e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a vertical (parallel to the y axis) shear 3 * 3 matrix.  <a href="a00341.html#ga717f1833369c1ac4a40e4ac015af885e">More...</a><br /></td></tr>
    105. 

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

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

  107. <tr class="memitem:gaf4573ae47c80938aa9053ef6a33755ab"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00341.html#gaf4573ae47c80938aa9053ef6a33755ab">translate</a> (mat&lt; 3, 3, T, Q &gt; const &amp;m, vec&lt; 2, T, Q &gt; const &amp;v)</td></tr>
    108. 

  108. <tr class="memdesc:gaf4573ae47c80938aa9053ef6a33755ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a translation 3 * 3 matrix created from a vector of 2 components.  <a href="a00341.html#gaf4573ae47c80938aa9053ef6a33755ab">More...</a><br /></td></tr>
    109. 

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

  110. </table>
    111. 

  111. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    112. 

  112. <p>Include &lt;<a class="el" href="a00110.html" title="GLM_GTX_matrix_transform_2d ">glm/gtx/matrix_transform_2d.hpp</a>&gt; to use the features of this extension. </p>
    113. 

  113. <p>Defines functions that generate common 2d transformation matrices. </p>
    114. 

  114. <h2 class="groupheader">Function Documentation</h2>
    115. 

  115. <a class="anchor" id="gad5c84a4932a758f385a87098ce1b1660"></a>
    116. 

  116. <div class="memitem">
    117. 

  117. <div class="memproto">
    118. 

  118.       <table class="memname">
    119. 

  119.         <tr>
    120. 

  120.           <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::rotate </td>
    121. 

  121.           <td>(</td>
    122. 

  122.           <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
    123. 

  123.           <td class="paramname"><em>m</em>, </td>
    124. 

  124.         </tr>
    125. 

  125.         <tr>
    126. 

  126.           <td class="paramkey"></td>
    127. 

  127.           <td></td>
    128. 

  128.           <td class="paramtype">T&#160;</td>
    129. 

  129.           <td class="paramname"><em>angle</em>&#160;</td>
    130. 

  130.         </tr>
    131. 

  131.         <tr>
    132. 

  132.           <td></td>
    133. 

  133.           <td>)</td>
    134. 

  134.           <td></td><td></td>
    135. 

  135.         </tr>
    136. 

  136.       </table>
    137. 

  137. </div><div class="memdoc">
    138. 

  138. 

  139. <p>Builds a rotation 3 * 3 matrix created from an angle. </p>
    140. 

  140. <dl class="params"><dt>Parameters</dt><dd>
    141. 

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

  142.     <tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
    143. 

  143.     <tr><td class="paramname">angle</td><td>Rotation angle expressed in radians. </td></tr>
    144. 

  144.   </table>
    145. 

  145.   </dd>
    146. 

  146. </dl>
    147. 

  147. 

  148. </div>
    149. 

  149. </div>
    150. 

  150. <a class="anchor" id="gadb47d2ad2bd984b213e8ff7d9cd8154e"></a>
    151. 

  151. <div class="memitem">
    152. 

  152. <div class="memproto">
    153. 

  153.       <table class="memname">
    154. 

  154.         <tr>
    155. 

  155.           <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::scale </td>
    156. 

  156.           <td>(</td>
    157. 

  157.           <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
    158. 

  158.           <td class="paramname"><em>m</em>, </td>
    159. 

  159.         </tr>
    160. 

  160.         <tr>
    161. 

  161.           <td class="paramkey"></td>
    162. 

  162.           <td></td>
    163. 

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

  164.           <td class="paramname"><em>v</em>&#160;</td>
    165. 

  165.         </tr>
    166. 

  166.         <tr>
    167. 

  167.           <td></td>
    168. 

  168.           <td>)</td>
    169. 

  169.           <td></td><td></td>
    170. 

  170.         </tr>
    171. 

  171.       </table>
    172. 

  172. </div><div class="memdoc">
    173. 

  173. 

  174. <p>Builds a scale 3 * 3 matrix created from a vector of 2 components. </p>
    175. 

  175. <dl class="params"><dt>Parameters</dt><dd>
    176. 

  176.   <table class="params">
    177. 

  177.     <tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
    178. 

  178.     <tr><td class="paramname">v</td><td>Coordinates of a scale vector. </td></tr>
    179. 

  179.   </table>
    180. 

  180.   </dd>
    181. 

  181. </dl>
    182. 

  182. 

  183. </div>
    184. 

  184. </div>
    185. 

  185. <a class="anchor" id="ga2a118ece5db1e2022112b954846012af"></a>
    186. 

  186. <div class="memitem">
    187. 

  187. <div class="memproto">
    188. 

  188.       <table class="memname">
    189. 

  189.         <tr>
    190. 

  190.           <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::shearX </td>
    191. 

  191.           <td>(</td>
    192. 

  192.           <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
    193. 

  193.           <td class="paramname"><em>m</em>, </td>
    194. 

  194.         </tr>
    195. 

  195.         <tr>
    196. 

  196.           <td class="paramkey"></td>
    197. 

  197.           <td></td>
    198. 

  198.           <td class="paramtype">T&#160;</td>
    199. 

  199.           <td class="paramname"><em>y</em>&#160;</td>
    200. 

  200.         </tr>
    201. 

  201.         <tr>
    202. 

  202.           <td></td>
    203. 

  203.           <td>)</td>
    204. 

  204.           <td></td><td></td>
    205. 

  205.         </tr>
    206. 

  206.       </table>
    207. 

  207. </div><div class="memdoc">
    208. 

  208. 

  209. <p>Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix. </p>
    210. 

  210. <dl class="params"><dt>Parameters</dt><dd>
    211. 

  211.   <table class="params">
    212. 

  212.     <tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
    213. 

  213.     <tr><td class="paramname">y</td><td>Shear factor. </td></tr>
    214. 

  214.   </table>
    215. 

  215.   </dd>
    216. 

  216. </dl>
    217. 

  217. 

  218. </div>
    219. 

  219. </div>
    220. 

  220. <a class="anchor" id="ga717f1833369c1ac4a40e4ac015af885e"></a>
    221. 

  221. <div class="memitem">
    222. 

  222. <div class="memproto">
    223. 

  223.       <table class="memname">
    224. 

  224.         <tr>
    225. 

  225.           <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::shearY </td>
    226. 

  226.           <td>(</td>
    227. 

  227.           <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
    228. 

  228.           <td class="paramname"><em>m</em>, </td>
    229. 

  229.         </tr>
    230. 

  230.         <tr>
    231. 

  231.           <td class="paramkey"></td>
    232. 

  232.           <td></td>
    233. 

  233.           <td class="paramtype">T&#160;</td>
    234. 

  234.           <td class="paramname"><em>x</em>&#160;</td>
    235. 

  235.         </tr>
    236. 

  236.         <tr>
    237. 

  237.           <td></td>
    238. 

  238.           <td>)</td>
    239. 

  239.           <td></td><td></td>
    240. 

  240.         </tr>
    241. 

  241.       </table>
    242. 

  242. </div><div class="memdoc">
    243. 

  243. 

  244. <p>Builds a vertical (parallel to the y axis) shear 3 * 3 matrix. </p>
    245. 

  245. <dl class="params"><dt>Parameters</dt><dd>
    246. 

  246.   <table class="params">
    247. 

  247.     <tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
    248. 

  248.     <tr><td class="paramname">x</td><td>Shear factor. </td></tr>
    249. 

  249.   </table>
    250. 

  250.   </dd>
    251. 

  251. </dl>
    252. 

  252. 

  253. </div>
    254. 

  254. </div>
    255. 

  255. <a class="anchor" id="gaf4573ae47c80938aa9053ef6a33755ab"></a>
    256. 

  256. <div class="memitem">
    257. 

  257. <div class="memproto">
    258. 

  258.       <table class="memname">
    259. 

  259.         <tr>
    260. 

  260.           <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::translate </td>
    261. 

  261.           <td>(</td>
    262. 

  262.           <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
    263. 

  263.           <td class="paramname"><em>m</em>, </td>
    264. 

  264.         </tr>
    265. 

  265.         <tr>
    266. 

  266.           <td class="paramkey"></td>
    267. 

  267.           <td></td>
    268. 

  268.           <td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
    269. 

  269.           <td class="paramname"><em>v</em>&#160;</td>
    270. 

  270.         </tr>
    271. 

  271.         <tr>
    272. 

  272.           <td></td>
    273. 

  273.           <td>)</td>
    274. 

  274.           <td></td><td></td>
    275. 

  275.         </tr>
    276. 

  276.       </table>
    277. 

  277. </div><div class="memdoc">
    278. 

  278. 

  279. <p>Builds a translation 3 * 3 matrix created from a vector of 2 components. </p>
    280. 

  280. <dl class="params"><dt>Parameters</dt><dd>
    281. 

  281.   <table class="params">
    282. 

  282.     <tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
    283. 

  283.     <tr><td class="paramname">v</td><td>Coordinates of a translation vector. </td></tr>
    284. 

  284.   </table>
    285. 

  285.   </dd>
    286. 

  286. </dl>
    287. 

  287. 

  288. </div>
    289. 

  289. </div>
    290. 

  290. </div><!-- contents -->
    291. 

  291. <!-- start footer part -->
    292. 

  292. <hr class="footer"/><address class="footer"><small>
    293. 

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

  294. <img class="footer" src="doxygen.png" alt="doxygen"/>
    295. 

  295. </a> 1.8.10
    296. 

  296. </small></address>
    297. 

  297. </body>
    298. 

  298. </html>
    299.