namespace_half_float_conversion.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: HalfFloatConversion Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('namespace_half_float_conversion.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#enum-members">Enumerations</a> &#124;
  108. <a href="#func-members">Functions</a> </div>
  109. <div class="headertitle"><div class="title">HalfFloatConversion Namespace Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
  114. Enumerations</h2></td></tr>
  115. <tr class="memitem:aa3241cac5bd296cd04f7600e353eb1a4" id="r_aa3241cac5bd296cd04f7600e353eb1a4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3241cac5bd296cd04f7600e353eb1a4">ERoundingMode</a> { <a class="el" href="#aa3241cac5bd296cd04f7600e353eb1a4a469f1ba56ff2b3d2cb1b8f5bbba127d9">ROUND_TO_NEG_INF</a>
  116. , <a class="el" href="#aa3241cac5bd296cd04f7600e353eb1a4a73c8f88f26cb5185803bc16adb69fbd6">ROUND_TO_POS_INF</a>
  117. , <a class="el" href="#aa3241cac5bd296cd04f7600e353eb1a4aaa7855ec8f43c914312cd51064ad0f64">ROUND_TO_NEAREST</a>
  118. }</td></tr>
  119. <tr class="memdesc:aa3241cac5bd296cd04f7600e353eb1a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define half-float rounding modes. <a href="#aa3241cac5bd296cd04f7600e353eb1a4">More...</a><br /></td></tr>
  120. <tr class="separator:aa3241cac5bd296cd04f7600e353eb1a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  123. Functions</h2></td></tr>
  124. <tr class="memitem:af81e63a2dc6f5cdfeb150d4dab3fdcbc" id="r_af81e63a2dc6f5cdfeb150d4dab3fdcbc"><td class="memTemplParams" colspan="2">template&lt;int RoundingMode&gt; </td></tr>
  125. <tr class="memitem:af81e63a2dc6f5cdfeb150d4dab3fdcbc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="_half_float_8h.html#ad1bfc12994d4af290926964a4eaee88d">HalfFloat</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af81e63a2dc6f5cdfeb150d4dab3fdcbc">FromFloatFallback</a> (float inV)</td></tr>
  126. <tr class="memdesc:af81e63a2dc6f5cdfeb150d4dab3fdcbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a float (32-bits) to a half float (16-bits), fallback version when no intrinsics available. <br /></td></tr>
  127. <tr class="separator:af81e63a2dc6f5cdfeb150d4dab3fdcbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a65b0aba81626b49a45fb9ac238c04d2d" id="r_a65b0aba81626b49a45fb9ac238c04d2d"><td class="memTemplParams" colspan="2">template&lt;int RoundingMode&gt; </td></tr>
  129. <tr class="memitem:a65b0aba81626b49a45fb9ac238c04d2d"><td class="memTemplItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="_half_float_8h.html#ad1bfc12994d4af290926964a4eaee88d">HalfFloat</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a65b0aba81626b49a45fb9ac238c04d2d">FromFloat</a> (float inV)</td></tr>
  130. <tr class="memdesc:a65b0aba81626b49a45fb9ac238c04d2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a float (32-bits) to a half float (16-bits) <br /></td></tr>
  131. <tr class="separator:a65b0aba81626b49a45fb9ac238c04d2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a222fa9e87d5e494aa324defa2925d03e" id="r_a222fa9e87d5e494aa324defa2925d03e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec4.html">Vec4</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a222fa9e87d5e494aa324defa2925d03e">ToFloatFallback</a> (<a class="el" href="_math_types_8h.html#afe962105a594eb55fe13daa266182a7e">UVec4Arg</a> inValue)</td></tr>
  133. <tr class="memdesc:a222fa9e87d5e494aa324defa2925d03e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert 4 half floats (lower 64 bits) to floats, fallback version when no intrinsics available. <br /></td></tr>
  134. <tr class="separator:a222fa9e87d5e494aa324defa2925d03e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a25cf44e188c51d03e061f23e1eabe36a" id="r_a25cf44e188c51d03e061f23e1eabe36a"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="class_vec4.html">Vec4</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25cf44e188c51d03e061f23e1eabe36a">ToFloat</a> (<a class="el" href="_math_types_8h.html#afe962105a594eb55fe13daa266182a7e">UVec4Arg</a> inValue)</td></tr>
  136. <tr class="memdesc:a25cf44e188c51d03e061f23e1eabe36a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert 4 half floats (lower 64 bits) to floats. <br /></td></tr>
  137. <tr class="separator:a25cf44e188c51d03e061f23e1eabe36a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table>
  139. <h2 class="groupheader">Enumeration Type Documentation</h2>
  140. <a id="aa3241cac5bd296cd04f7600e353eb1a4" name="aa3241cac5bd296cd04f7600e353eb1a4"></a>
  141. <h2 class="memtitle"><span class="permalink"><a href="#aa3241cac5bd296cd04f7600e353eb1a4">&#9670;&#160;</a></span>ERoundingMode</h2>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">enum <a class="el" href="#aa3241cac5bd296cd04f7600e353eb1a4">HalfFloatConversion::ERoundingMode</a></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Define half-float rounding modes. </p>
  151. <table class="fieldtable">
  152. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa3241cac5bd296cd04f7600e353eb1a4a469f1ba56ff2b3d2cb1b8f5bbba127d9" name="aa3241cac5bd296cd04f7600e353eb1a4a469f1ba56ff2b3d2cb1b8f5bbba127d9"></a>ROUND_TO_NEG_INF&#160;</td><td class="fielddoc"><p>Round to negative infinity. </p>
  153. </td></tr>
  154. <tr><td class="fieldname"><a id="aa3241cac5bd296cd04f7600e353eb1a4a73c8f88f26cb5185803bc16adb69fbd6" name="aa3241cac5bd296cd04f7600e353eb1a4a73c8f88f26cb5185803bc16adb69fbd6"></a>ROUND_TO_POS_INF&#160;</td><td class="fielddoc"><p>Round to positive infinity. </p>
  155. </td></tr>
  156. <tr><td class="fieldname"><a id="aa3241cac5bd296cd04f7600e353eb1a4aaa7855ec8f43c914312cd51064ad0f64" name="aa3241cac5bd296cd04f7600e353eb1a4aaa7855ec8f43c914312cd51064ad0f64"></a>ROUND_TO_NEAREST&#160;</td><td class="fielddoc"><p>Round to nearest value. </p>
  157. </td></tr>
  158. </table>
  159. </div>
  160. </div>
  161. <h2 class="groupheader">Function Documentation</h2>
  162. <a id="a65b0aba81626b49a45fb9ac238c04d2d" name="a65b0aba81626b49a45fb9ac238c04d2d"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#a65b0aba81626b49a45fb9ac238c04d2d">&#9670;&#160;</a></span>FromFloat()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <div class="memtemplate">
  167. template&lt;int RoundingMode&gt; </div>
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">JPH_INLINE <a class="el" href="_half_float_8h.html#ad1bfc12994d4af290926964a4eaee88d">HalfFloat</a> HalfFloatConversion::FromFloat </td>
  171. <td>(</td>
  172. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  173. <td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Convert a float (32-bits) to a half float (16-bits) </p>
  178. </div>
  179. </div>
  180. <a id="af81e63a2dc6f5cdfeb150d4dab3fdcbc" name="af81e63a2dc6f5cdfeb150d4dab3fdcbc"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#af81e63a2dc6f5cdfeb150d4dab3fdcbc">&#9670;&#160;</a></span>FromFloatFallback()</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <div class="memtemplate">
  185. template&lt;int RoundingMode&gt; </div>
  186. <table class="mlabels">
  187. <tr>
  188. <td class="mlabels-left">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname"><a class="el" href="_half_float_8h.html#ad1bfc12994d4af290926964a4eaee88d">HalfFloat</a> HalfFloatConversion::FromFloatFallback </td>
  192. <td>(</td>
  193. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inV</em></span></td><td>)</td>
  194. <td></td>
  195. </tr>
  196. </table>
  197. </td>
  198. <td class="mlabels-right">
  199. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Convert a float (32-bits) to a half float (16-bits), fallback version when no intrinsics available. </p>
  204. </div>
  205. </div>
  206. <a id="a25cf44e188c51d03e061f23e1eabe36a" name="a25cf44e188c51d03e061f23e1eabe36a"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#a25cf44e188c51d03e061f23e1eabe36a">&#9670;&#160;</a></span>ToFloat()</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">JPH_INLINE <a class="el" href="class_vec4.html">Vec4</a> HalfFloatConversion::ToFloat </td>
  213. <td>(</td>
  214. <td class="paramtype"><a class="el" href="_math_types_8h.html#afe962105a594eb55fe13daa266182a7e">UVec4Arg</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Convert 4 half floats (lower 64 bits) to floats. </p>
  220. </div>
  221. </div>
  222. <a id="a222fa9e87d5e494aa324defa2925d03e" name="a222fa9e87d5e494aa324defa2925d03e"></a>
  223. <h2 class="memtitle"><span class="permalink"><a href="#a222fa9e87d5e494aa324defa2925d03e">&#9670;&#160;</a></span>ToFloatFallback()</h2>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="mlabels">
  227. <tr>
  228. <td class="mlabels-left">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname"><a class="el" href="class_vec4.html">Vec4</a> HalfFloatConversion::ToFloatFallback </td>
  232. <td>(</td>
  233. <td class="paramtype"><a class="el" href="_math_types_8h.html#afe962105a594eb55fe13daa266182a7e">UVec4Arg</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  234. <td></td>
  235. </tr>
  236. </table>
  237. </td>
  238. <td class="mlabels-right">
  239. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. <p>Convert 4 half floats (lower 64 bits) to floats, fallback version when no intrinsics available. </p>
  244. </div>
  245. </div>
  246. </div><!-- contents -->
  247. </div><!-- doc-content -->
  248. <!-- start footer part -->
  249. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  250. <ul>
  251. <li class="navelem"><a class="el" href="namespace_half_float_conversion.html">HalfFloatConversion</a></li>
  252. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  253. </ul>
  254. </div>
  255. </body>
  256. </html>