structluwra_1_1Value.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <!-- HTML header for doxygen 1.8.10-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.11"/>
  8. <title>Luwra: luwra::Value&lt; T &gt; Struct Template 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="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top">
  17. <!-- Generated by Doxygen 1.8.11 -->
  18. <div id="navrow1" class="tabs">
  19. <ul class="tablist">
  20. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  21. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  22. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  23. </ul>
  24. </div>
  25. <div id="navrow2" class="tabs2">
  26. <ul class="tablist">
  27. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  28. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  29. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  30. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  31. </ul>
  32. </div>
  33. <div id="nav-path" class="navpath">
  34. <ul>
  35. <li class="navelem"><a class="el" href="namespaceluwra.html">luwra</a></li><li class="navelem"><a class="el" href="structluwra_1_1Value.html">Value</a></li> </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  41. <a href="structluwra_1_1Value-members.html">List of all members</a> </div>
  42. <div class="headertitle">
  43. <div class="title">luwra::Value&lt; T &gt; Struct Template Reference</div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <p>Inherited by <a class="el" href="structluwra_1_1Value_3_01const_01T_01_4.html">luwra::Value&lt; const T &gt;</a>, and <a class="el" href="structluwra_1_1Value_3_01volatile_01T_01_4.html">luwra::Value&lt; volatile T &gt;</a>.</p>
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  49. Static Public Member Functions</h2></td></tr>
  50. <tr class="memitem:a41e193fdb55028189fe8ca5e503efcfa"><td class="memItemLeft" align="right" valign="top">static T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1Value.html#a41e193fdb55028189fe8ca5e503efcfa">read</a> (<a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *state, int index)</td></tr>
  51. <tr class="separator:a41e193fdb55028189fe8ca5e503efcfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:aa376d68285606c206562b822e8187384"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1Value.html#aa376d68285606c206562b822e8187384">push</a> (<a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *state, const T &amp;value)</td></tr>
  53. <tr class="separator:aa376d68285606c206562b822e8187384"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. </table>
  55. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  56. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  57. struct luwra::Value&lt; T &gt;</h3>
  58. <p>User type </p>
  59. </div><h2 class="groupheader">Member Function Documentation</h2>
  60. <a class="anchor" id="aa376d68285606c206562b822e8187384"></a>
  61. <div class="memitem">
  62. <div class="memproto">
  63. <div class="memtemplate">
  64. template&lt;typename T &gt; </div>
  65. <table class="mlabels">
  66. <tr>
  67. <td class="mlabels-left">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname">static size_t <a class="el" href="structluwra_1_1Value.html">luwra::Value</a>&lt; T &gt;::push </td>
  71. <td>(</td>
  72. <td class="paramtype"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td>
  73. <td class="paramname"><em>state</em>, </td>
  74. </tr>
  75. <tr>
  76. <td class="paramkey"></td>
  77. <td></td>
  78. <td class="paramtype">const T &amp;&#160;</td>
  79. <td class="paramname"><em>value</em>&#160;</td>
  80. </tr>
  81. <tr>
  82. <td></td>
  83. <td>)</td>
  84. <td></td><td></td>
  85. </tr>
  86. </table>
  87. </td>
  88. <td class="mlabels-right">
  89. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  90. </tr>
  91. </table>
  92. </div><div class="memdoc">
  93. <p>Copy a user type value onto the stack. </p><dl class="params"><dt>Parameters</dt><dd>
  94. <table class="params">
  95. <tr><td class="paramname">state</td><td>Lua state </td></tr>
  96. <tr><td class="paramname">value</td><td><a class="el" href="structluwra_1_1Value.html">Value</a> you want to push </td></tr>
  97. </table>
  98. </dd>
  99. </dl>
  100. <dl class="section return"><dt>Returns</dt><dd>Number of values pushed </dd></dl>
  101. </div>
  102. </div>
  103. <a class="anchor" id="a41e193fdb55028189fe8ca5e503efcfa"></a>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <div class="memtemplate">
  107. template&lt;typename T &gt; </div>
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">static T <a class="el" href="structluwra_1_1Value.html">luwra::Value</a>&lt; T &gt;::read </td>
  114. <td>(</td>
  115. <td class="paramtype"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td>
  116. <td class="paramname"><em>state</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">int&#160;</td>
  122. <td class="paramname"><em>index</em>&#160;</td>
  123. </tr>
  124. <tr>
  125. <td></td>
  126. <td>)</td>
  127. <td></td><td></td>
  128. </tr>
  129. </table>
  130. </td>
  131. <td class="mlabels-right">
  132. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Copy a user type value from the stack. </p><dl class="params"><dt>Parameters</dt><dd>
  137. <table class="params">
  138. <tr><td class="paramname">state</td><td>Lua state </td></tr>
  139. <tr><td class="paramname">index</td><td>Position of the value </td></tr>
  140. </table>
  141. </dd>
  142. </dl>
  143. </div>
  144. </div>
  145. </div><!-- contents -->
  146. </body>
  147. </html>