class_huffman_processor.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: HuffmanProcessor Class 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. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  75. <a href="class_huffman_processor-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">HuffmanProcessor Class Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:af0113e629921b1fecb1c6453719e9b48" id="r_af0113e629921b1fecb1c6453719e9b48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_huffman_processor.html#af0113e629921b1fecb1c6453719e9b48">HuffmanProcessor</a> ()</td></tr>
  83. <tr class="separator:af0113e629921b1fecb1c6453719e9b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ab955aef374899906ab3906f727ec5456" id="r_ab955aef374899906ab3906f727ec5456"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_huffman_processor.html#ab955aef374899906ab3906f727ec5456">readHuffBuffer</a> (<a class="el" href="class_bit_stream.html">BitStream</a> *pStream, char *out_pBuffer)</td></tr>
  85. <tr class="separator:ab955aef374899906ab3906f727ec5456"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a6ff0860adf2d4cae8063aadeaff60c1d" id="r_a6ff0860adf2d4cae8063aadeaff60c1d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_huffman_processor.html#a6ff0860adf2d4cae8063aadeaff60c1d">writeHuffBuffer</a> (<a class="el" href="class_bit_stream.html">BitStream</a> *pStream, const char *out_pBuffer, S32 maxLen)</td></tr>
  87. <tr class="separator:a6ff0860adf2d4cae8063aadeaff60c1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table><table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  90. Static Public Attributes</h2></td></tr>
  91. <tr class="memitem:aa875499242a2fc105a2a133d91f5d962" id="r_aa875499242a2fc105a2a133d91f5d962"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_huffman_processor.html">HuffmanProcessor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_huffman_processor.html#aa875499242a2fc105a2a133d91f5d962">g_huffProcessor</a></td></tr>
  92. <tr class="separator:aa875499242a2fc105a2a133d91f5d962"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  95. <a id="af0113e629921b1fecb1c6453719e9b48" name="af0113e629921b1fecb1c6453719e9b48"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#af0113e629921b1fecb1c6453719e9b48">&#9670;&#160;</a></span>HuffmanProcessor()</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="mlabels">
  100. <tr>
  101. <td class="mlabels-left">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname"><a class="el" href="class_huffman_processor.html">HuffmanProcessor</a> </td>
  105. <td>(</td>
  106. <td class="paramname"></td><td>)</td>
  107. <td></td>
  108. </tr>
  109. </table>
  110. </td>
  111. <td class="mlabels-right">
  112. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  113. </tr>
  114. </table>
  115. </div><div class="memdoc">
  116. </div>
  117. </div>
  118. <h2 class="groupheader">Member Function Documentation</h2>
  119. <a id="ab955aef374899906ab3906f727ec5456" name="ab955aef374899906ab3906f727ec5456"></a>
  120. <h2 class="memtitle"><span class="permalink"><a href="#ab955aef374899906ab3906f727ec5456">&#9670;&#160;</a></span>readHuffBuffer()</h2>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">bool readHuffBuffer </td>
  126. <td>(</td>
  127. <td class="paramtype"><a class="el" href="class_bit_stream.html">BitStream</a> *&#160;</td>
  128. <td class="paramname"><em>pStream</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">char *&#160;</td>
  134. <td class="paramname"><em>out_pBuffer</em>&#160;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. </div>
  144. </div>
  145. <a id="a6ff0860adf2d4cae8063aadeaff60c1d" name="a6ff0860adf2d4cae8063aadeaff60c1d"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#a6ff0860adf2d4cae8063aadeaff60c1d">&#9670;&#160;</a></span>writeHuffBuffer()</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">bool writeHuffBuffer </td>
  152. <td>(</td>
  153. <td class="paramtype"><a class="el" href="class_bit_stream.html">BitStream</a> *&#160;</td>
  154. <td class="paramname"><em>pStream</em>, </td>
  155. </tr>
  156. <tr>
  157. <td class="paramkey"></td>
  158. <td></td>
  159. <td class="paramtype">const char *&#160;</td>
  160. <td class="paramname"><em>out_pBuffer</em>, </td>
  161. </tr>
  162. <tr>
  163. <td class="paramkey"></td>
  164. <td></td>
  165. <td class="paramtype">S32&#160;</td>
  166. <td class="paramname"><em>maxLen</em>&#160;</td>
  167. </tr>
  168. <tr>
  169. <td></td>
  170. <td>)</td>
  171. <td></td><td></td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. </div>
  176. </div>
  177. <h2 class="groupheader">Member Data Documentation</h2>
  178. <a id="aa875499242a2fc105a2a133d91f5d962" name="aa875499242a2fc105a2a133d91f5d962"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#aa875499242a2fc105a2a133d91f5d962">&#9670;&#160;</a></span>g_huffProcessor</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="mlabels">
  183. <tr>
  184. <td class="mlabels-left">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname"><a class="el" href="class_huffman_processor.html">HuffmanProcessor</a> g_huffProcessor</td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <hr/>The documentation for this class was generated from the following file:<ul>
  199. <li>io/<b>bitStream.cc</b></li>
  200. </ul>
  201. </div><!-- contents -->
  202. <!-- start footer part -->
  203. <hr class="footer"/><address class="footer"><small>
  204. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  205. </small></address>
  206. </body>
  207. </html>