classgameplay_1_1_vertex_format_1_1_element.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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. <title>gameplay: Main Page</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_vertex_format.html">VertexFormat</a> </li>
  81. <li class="navelem"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html">Element</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-methods">Public Member Functions</a> &#124;
  88. <a href="#pub-attribs">Public Attributes</a> </div>
  89. <div class="headertitle">
  90. <div class="title">gameplay::VertexFormat::Element Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <!-- doxytag: class="gameplay::VertexFormat::Element" -->
  94. <p><code>#include &lt;VertexFormat.h&gt;</code></p>
  95. <p><a href="classgameplay_1_1_vertex_format_1_1_element-members.html">List of all members.</a></p>
  96. <table class="memberdecls">
  97. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a4783c96c88ea37c6bbe860e7e279b3a3">Element</a> ()</td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#aab76739ff284b9eaf61f4ce325b5c087">Element</a> (<a class="el" href="classgameplay_1_1_vertex_format.html#a8ae70c40a5000a4e4b52cdca35923c26">Usage</a> <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#aedb2a6efcd033fe52fb3a9335697f760">usage</a>, unsigned int <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a42d29ad62d81493778d3d196c068ccb2">size</a>)</td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#aebd33e1ab3b57f929fb4a114872ef3fb">operator==</a> (const <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html">Element</a> &amp;e) const </td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#ac31d9501bc8053e2b0732ddc683140fe">operator!=</a> (const <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html">Element</a> &amp;e) const </td></tr>
  103. <tr><td colspan="2"><h2><a name="pub-attribs"></a>
  104. Public Attributes</h2></td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_vertex_format.html#a8ae70c40a5000a4e4b52cdca35923c26">Usage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#aedb2a6efcd033fe52fb3a9335697f760">usage</a></td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a42d29ad62d81493778d3d196c068ccb2">size</a></td></tr>
  107. </table>
  108. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  109. <div class="textblock"><p>Defines a single element within a vertex format.</p>
  110. <p>All vertex elements are assumed to be of type float, but can have a varying number of float values (1-4), which is represented by the size attribute. Additionally, vertex elements are assumed to be tightly packed. </p>
  111. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  112. <a class="anchor" id="a4783c96c88ea37c6bbe860e7e279b3a3"></a><!-- doxytag: member="gameplay::VertexFormat::Element::Element" ref="a4783c96c88ea37c6bbe860e7e279b3a3" args="()" -->
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a4783c96c88ea37c6bbe860e7e279b3a3">gameplay::VertexFormat::Element::Element</a> </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </div>
  124. <div class="memdoc">
  125. <p>Constructor. </p>
  126. </div>
  127. </div>
  128. <a class="anchor" id="aab76739ff284b9eaf61f4ce325b5c087"></a><!-- doxytag: member="gameplay::VertexFormat::Element::Element" ref="aab76739ff284b9eaf61f4ce325b5c087" args="(Usage usage, unsigned int size)" -->
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a4783c96c88ea37c6bbe860e7e279b3a3">gameplay::VertexFormat::Element::Element</a> </td>
  134. <td>(</td>
  135. <td class="paramtype"><a class="el" href="classgameplay_1_1_vertex_format.html#a8ae70c40a5000a4e4b52cdca35923c26">Usage</a>&#160;</td>
  136. <td class="paramname"><em>usage</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">unsigned int&#160;</td>
  142. <td class="paramname"><em>size</em>&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </div>
  151. <div class="memdoc">
  152. <p>Constructor.</p>
  153. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  154. <table class="params">
  155. <tr><td class="paramname">usage</td><td>The vertex element usage semantic. </td></tr>
  156. <tr><td class="paramname">size</td><td>The number of float values in the vertex element. </td></tr>
  157. </table>
  158. </dd>
  159. </dl>
  160. </div>
  161. </div>
  162. <hr/><h2>Member Function Documentation</h2>
  163. <a class="anchor" id="ac31d9501bc8053e2b0732ddc683140fe"></a><!-- doxytag: member="gameplay::VertexFormat::Element::operator!=" ref="ac31d9501bc8053e2b0732ddc683140fe" args="(const Element &amp;e) const " -->
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">bool gameplay::VertexFormat::Element::operator!= </td>
  169. <td>(</td>
  170. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html">Element</a> &amp;&#160;</td>
  171. <td class="paramname"><em>e</em></td><td>)</td>
  172. <td> const</td>
  173. </tr>
  174. </table>
  175. </div>
  176. <div class="memdoc">
  177. <p>Compares to vertex elements for inequality.</p>
  178. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  179. <table class="params">
  180. <tr><td class="paramname">e</td><td>The vertex element to compare.</td></tr>
  181. </table>
  182. </dd>
  183. </dl>
  184. <dl class="return"><dt><b>Returns:</b></dt><dd>true if this element does not match the specified one, false otherwise. </dd></dl>
  185. </div>
  186. </div>
  187. <a class="anchor" id="aebd33e1ab3b57f929fb4a114872ef3fb"></a><!-- doxytag: member="gameplay::VertexFormat::Element::operator==" ref="aebd33e1ab3b57f929fb4a114872ef3fb" args="(const Element &amp;e) const " -->
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">bool gameplay::VertexFormat::Element::operator== </td>
  193. <td>(</td>
  194. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html">Element</a> &amp;&#160;</td>
  195. <td class="paramname"><em>e</em></td><td>)</td>
  196. <td> const</td>
  197. </tr>
  198. </table>
  199. </div>
  200. <div class="memdoc">
  201. <p>Compares two vertex elements for equality.</p>
  202. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  203. <table class="params">
  204. <tr><td class="paramname">e</td><td>The vertex element to compare.</td></tr>
  205. </table>
  206. </dd>
  207. </dl>
  208. <dl class="return"><dt><b>Returns:</b></dt><dd>true if this element matches the specified one, false otherwise. </dd></dl>
  209. </div>
  210. </div>
  211. <hr/><h2>Member Data Documentation</h2>
  212. <a class="anchor" id="a42d29ad62d81493778d3d196c068ccb2"></a><!-- doxytag: member="gameplay::VertexFormat::Element::size" ref="a42d29ad62d81493778d3d196c068ccb2" args="" -->
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#a42d29ad62d81493778d3d196c068ccb2">gameplay::VertexFormat::Element::size</a></td>
  218. </tr>
  219. </table>
  220. </div>
  221. <div class="memdoc">
  222. <p>The number of values in the vertex element. </p>
  223. </div>
  224. </div>
  225. <a class="anchor" id="aedb2a6efcd033fe52fb3a9335697f760"></a><!-- doxytag: member="gameplay::VertexFormat::Element::usage" ref="aedb2a6efcd033fe52fb3a9335697f760" args="" -->
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname"><a class="el" href="classgameplay_1_1_vertex_format.html#a8ae70c40a5000a4e4b52cdca35923c26">Usage</a> <a class="el" href="classgameplay_1_1_vertex_format_1_1_element.html#aedb2a6efcd033fe52fb3a9335697f760">gameplay::VertexFormat::Element::usage</a></td>
  231. </tr>
  232. </table>
  233. </div>
  234. <div class="memdoc">
  235. <p>The vertex element usage semantic. </p>
  236. </div>
  237. </div>
  238. </div><!-- contents -->
  239. <!-- window showing the filter options -->
  240. <div id="MSearchSelectWindow"
  241. onmouseover="return searchBox.OnSearchSelectShow()"
  242. onmouseout="return searchBox.OnSearchSelectHide()"
  243. onkeydown="return searchBox.OnSearchSelectKey(event)">
  244. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  245. <!-- iframe showing the search results (closed by default) -->
  246. <div id="MSearchResultsWindow">
  247. <iframe src="javascript:void(0)" frameborder="0"
  248. name="MSearchResults" id="MSearchResults">
  249. </iframe>
  250. </div>
  251. <hr class="footer"/><address class="footer"><small>
  252. Generated on Sat Jan 24 2015 15:29:45 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  253. <img class="footer" src="doxygen.png" alt="doxygen"/>
  254. </a> 1.7.6.1
  255. </small></address>
  256. </body>
  257. </html>