classCPVRTBoneBatches.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>PowerVR SDK</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. <table width="100%">
  7. <tr>
  8. <td width="33%">
  9. <p align="left">&nbsp;<a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
  10. </td>
  11. <td width="33%">
  12. <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
  13. </td>
  14. <td width="34%">
  15. <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
  16. </td>
  17. </tr>
  18. </table>
  19. <hr>
  20. </head><body>
  21. <!-- Generated by Doxygen 1.3.6 -->
  22. <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
  23. <h1>CPVRTBoneBatches Class Reference</h1>A class for processing vertices into bone batches.
  24. <a href="#_details">More...</a>
  25. <p>
  26. <code>#include &lt;<a class="el" href="PVRTBoneBatch_8h-source.html">PVRTBoneBatch.h</a>&gt;</code>
  27. <p>
  28. <a href="classCPVRTBoneBatches-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  29. <tr><td></td></tr>
  30. <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  31. <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="PVRTError_8h.html#a5">EPVRTError</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#a0">Create</a> (int *const pnVtxNumOut, char **const pVtxOut, unsigned int *const pui32Idx, const int nVtxNum, const char *const pVtx, const int nStride, const int nOffsetWeight, const <a class="el" href="PVRTVertex_8h.html#a24">EPVRTDataType</a> eTypeWeight, const int nOffsetIdx, const <a class="el" href="PVRTVertex_8h.html#a24">EPVRTDataType</a> eTypeIdx, const int nTriNum, const int <a class="el" href="classCPVRTBoneBatches.html#o3">nBatchBoneMax</a>, const int nVertexBones)</td></tr>
  32. <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#a1">Release</a> ()</td></tr>
  33. <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  34. <tr><td class="memItemLeft" nowrap align=right valign=top>int *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#o0">pnBatches</a></td></tr>
  35. <tr><td class="memItemLeft" nowrap align=right valign=top>int *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#o1">pnBatchBoneCnt</a></td></tr>
  36. <tr><td class="memItemLeft" nowrap align=right valign=top>int *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#o2">pnBatchOffset</a></td></tr>
  37. <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#o3">nBatchBoneMax</a></td></tr>
  38. <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCPVRTBoneBatches.html#o4">nBatchCnt</a></td></tr>
  39. </table>
  40. <hr><a name="_details"></a><h2>Detailed Description</h2>
  41. A class for processing vertices into bone batches.
  42. <p>
  43. <hr><h2>Member Function Documentation</h2>
  44. <a class="anchor" name="a0" doxytag="CPVRTBoneBatches::Create" ></a><p>
  45. <br><br><h3>Create</h3><br><div>
  46. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  47. <tr>
  48. <td class="mdRow">
  49. <table cellpadding="0" cellspacing="0" border="0">
  50. <tr>
  51. <td class="md" nowrap valign="top"> <a class="el" href="PVRTError_8h.html#a5">EPVRTError</a> CPVRTBoneBatches::Create </td>
  52. <td class="md" valign="top">(&nbsp;</td>
  53. <td class="md" nowrap valign="top">int *const&nbsp;</td>
  54. <td class="mdname" nowrap> <em>pnVtxNumOut</em>, </td>
  55. </tr>
  56. <tr>
  57. <td class="md" nowrap align="right"></td>
  58. <td></td>
  59. <td class="md" nowrap>char **const&nbsp;</td>
  60. <td class="mdname" nowrap> <em>pVtxOut</em>, </td>
  61. </tr>
  62. <tr>
  63. <td class="md" nowrap align="right"></td>
  64. <td></td>
  65. <td class="md" nowrap>unsigned int *const&nbsp;</td>
  66. <td class="mdname" nowrap> <em>pui32Idx</em>, </td>
  67. </tr>
  68. <tr>
  69. <td class="md" nowrap align="right"></td>
  70. <td></td>
  71. <td class="md" nowrap>const int&nbsp;</td>
  72. <td class="mdname" nowrap> <em>nVtxNum</em>, </td>
  73. </tr>
  74. <tr>
  75. <td class="md" nowrap align="right"></td>
  76. <td></td>
  77. <td class="md" nowrap>const char *const&nbsp;</td>
  78. <td class="mdname" nowrap> <em>pVtx</em>, </td>
  79. </tr>
  80. <tr>
  81. <td class="md" nowrap align="right"></td>
  82. <td></td>
  83. <td class="md" nowrap>const int&nbsp;</td>
  84. <td class="mdname" nowrap> <em>nStride</em>, </td>
  85. </tr>
  86. <tr>
  87. <td class="md" nowrap align="right"></td>
  88. <td></td>
  89. <td class="md" nowrap>const int&nbsp;</td>
  90. <td class="mdname" nowrap> <em>nOffsetWeight</em>, </td>
  91. </tr>
  92. <tr>
  93. <td class="md" nowrap align="right"></td>
  94. <td></td>
  95. <td class="md" nowrap>const <a class="el" href="PVRTVertex_8h.html#a24">EPVRTDataType</a>&nbsp;</td>
  96. <td class="mdname" nowrap> <em>eTypeWeight</em>, </td>
  97. </tr>
  98. <tr>
  99. <td class="md" nowrap align="right"></td>
  100. <td></td>
  101. <td class="md" nowrap>const int&nbsp;</td>
  102. <td class="mdname" nowrap> <em>nOffsetIdx</em>, </td>
  103. </tr>
  104. <tr>
  105. <td class="md" nowrap align="right"></td>
  106. <td></td>
  107. <td class="md" nowrap>const <a class="el" href="PVRTVertex_8h.html#a24">EPVRTDataType</a>&nbsp;</td>
  108. <td class="mdname" nowrap> <em>eTypeIdx</em>, </td>
  109. </tr>
  110. <tr>
  111. <td class="md" nowrap align="right"></td>
  112. <td></td>
  113. <td class="md" nowrap>const int&nbsp;</td>
  114. <td class="mdname" nowrap> <em>nTriNum</em>, </td>
  115. </tr>
  116. <tr>
  117. <td class="md" nowrap align="right"></td>
  118. <td></td>
  119. <td class="md" nowrap>const int&nbsp;</td>
  120. <td class="mdname" nowrap> <em>nBatchBoneMax</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="md" nowrap align="right"></td>
  124. <td></td>
  125. <td class="md" nowrap>const int&nbsp;</td>
  126. <td class="mdname" nowrap> <em>nVertexBones</em></td>
  127. </tr>
  128. <tr>
  129. <td></td>
  130. <td class="md">)&nbsp;</td>
  131. <td class="md" colspan="2"></td>
  132. </tr>
  133. </table>
  134. </td>
  135. </tr>
  136. </table>
  137. <table cellspacing=5 cellpadding=0 border=0>
  138. <tr>
  139. <td>
  140. &nbsp;
  141. </td>
  142. <td>
  143. <p>
  144. <dl compact><dt><b>Outputs:</b></dt><dd>
  145. <table border="0" cellspacing="2" cellpadding="0">
  146. <tr><td valign=top><em>pnVtxNumOut</em>&nbsp;</td><td>vertex count </td></tr>
  147. <tr><td valign=top><em>pVtxOut</em>&nbsp;</td><td>Output vertices (program must free() this) </td></tr>
  148. </table>
  149. </dl>
  150. <dl compact><dt><b>Modified:</b></dt><dd>
  151. <table border="0" cellspacing="2" cellpadding="0">
  152. <tr><td valign=top><em>pui32Idx</em>&nbsp;</td><td>index array for triangle list </td></tr>
  153. </table>
  154. </dl>
  155. <dl compact><dt><b>Inputs:</b></dt><dd>
  156. <table border="0" cellspacing="2" cellpadding="0">
  157. <tr><td valign=top><em>nVtxNum</em>&nbsp;</td><td>vertex count </td></tr>
  158. <tr><td valign=top><em>pVtx</em>&nbsp;</td><td>vertices </td></tr>
  159. <tr><td valign=top><em>nStride</em>&nbsp;</td><td>Size of a vertex (in bytes) </td></tr>
  160. <tr><td valign=top><em>nOffsetWeight</em>&nbsp;</td><td>Offset in bytes to the vertex bone-weights </td></tr>
  161. <tr><td valign=top><em>eTypeWeight</em>&nbsp;</td><td>Data type of the vertex bone-weights </td></tr>
  162. <tr><td valign=top><em>nOffsetIdx</em>&nbsp;</td><td>Offset in bytes to the vertex bone-indices </td></tr>
  163. <tr><td valign=top><em>eTypeIdx</em>&nbsp;</td><td>Data type of the vertex bone-indices </td></tr>
  164. <tr><td valign=top><em>nTriNum</em>&nbsp;</td><td>Number of triangles </td></tr>
  165. <tr><td valign=top><em>nBatchBoneMax</em>&nbsp;</td><td>Number of bones a batch can reference </td></tr>
  166. <tr><td valign=top><em>nVertexBones</em>&nbsp;</td><td>Number of bones affecting each vertex </td></tr>
  167. </table>
  168. </dl>
  169. <dl compact><dt><b>Returns:</b></dt><dd>PVR_SUCCESS if successful </dd></dl>
  170. <dl compact><dt><b>Description:</b></dt><dd>Fills the bone batch structure </dd></dl>
  171. </td>
  172. </tr>
  173. </table>
  174. <a class="anchor" name="a1" doxytag="CPVRTBoneBatches::Release" ></a><p>
  175. <br><br><h3>Release</h3><br><div>
  176. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  177. <tr>
  178. <td class="mdRow">
  179. <table cellpadding="0" cellspacing="0" border="0">
  180. <tr>
  181. <td class="md" nowrap valign="top"> void CPVRTBoneBatches::Release </td>
  182. <td class="md" valign="top">(&nbsp;</td>
  183. <td class="mdname1" valign="top" nowrap> </td>
  184. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  185. <td class="md" nowrap><code> [inline]</code></td>
  186. </tr>
  187. </table>
  188. </td>
  189. </tr>
  190. </table>
  191. <table cellspacing=5 cellpadding=0 border=0>
  192. <tr>
  193. <td>
  194. &nbsp;
  195. </td>
  196. <td>
  197. <p>
  198. <dl compact><dt><b>Description:</b></dt><dd>Destroy the bone batch structure </dd></dl>
  199. </td>
  200. </tr>
  201. </table>
  202. <hr><h2>Member Data Documentation</h2>
  203. <a class="anchor" name="o3" doxytag="CPVRTBoneBatches::nBatchBoneMax" ></a><p>
  204. <br><br><h3>nBatchBoneMax</h3><br><div>
  205. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  206. <tr>
  207. <td class="mdRow">
  208. <table cellpadding="0" cellspacing="0" border="0">
  209. <tr>
  210. <td class="md" nowrap valign="top"> int <a class="el" href="classCPVRTBoneBatches.html#o3">CPVRTBoneBatches::nBatchBoneMax</a>
  211. </table>
  212. </td>
  213. </tr>
  214. </table>
  215. <table cellspacing=5 cellpadding=0 border=0>
  216. <tr>
  217. <td>
  218. &nbsp;
  219. </td>
  220. <td>
  221. <p>
  222. Stored value as was passed into <a class="el" href="classCPVRTBoneBatches.html#a0">Create()</a> </td>
  223. </tr>
  224. </table>
  225. <a class="anchor" name="o4" doxytag="CPVRTBoneBatches::nBatchCnt" ></a><p>
  226. <br><br><h3>nBatchCnt</h3><br><div>
  227. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  228. <tr>
  229. <td class="mdRow">
  230. <table cellpadding="0" cellspacing="0" border="0">
  231. <tr>
  232. <td class="md" nowrap valign="top"> int <a class="el" href="classCPVRTBoneBatches.html#o4">CPVRTBoneBatches::nBatchCnt</a>
  233. </table>
  234. </td>
  235. </tr>
  236. </table>
  237. <table cellspacing=5 cellpadding=0 border=0>
  238. <tr>
  239. <td>
  240. &nbsp;
  241. </td>
  242. <td>
  243. <p>
  244. Number of batches to render </td>
  245. </tr>
  246. </table>
  247. <a class="anchor" name="o1" doxytag="CPVRTBoneBatches::pnBatchBoneCnt" ></a><p>
  248. <br><br><h3>pnBatchBoneCnt</h3><br><div>
  249. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  250. <tr>
  251. <td class="mdRow">
  252. <table cellpadding="0" cellspacing="0" border="0">
  253. <tr>
  254. <td class="md" nowrap valign="top"> int* <a class="el" href="classCPVRTBoneBatches.html#o1">CPVRTBoneBatches::pnBatchBoneCnt</a>
  255. </table>
  256. </td>
  257. </tr>
  258. </table>
  259. <table cellspacing=5 cellpadding=0 border=0>
  260. <tr>
  261. <td>
  262. &nbsp;
  263. </td>
  264. <td>
  265. <p>
  266. Actual number of bone indices, per batch </td>
  267. </tr>
  268. </table>
  269. <a class="anchor" name="o0" doxytag="CPVRTBoneBatches::pnBatches" ></a><p>
  270. <br><br><h3>pnBatches</h3><br><div>
  271. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  272. <tr>
  273. <td class="mdRow">
  274. <table cellpadding="0" cellspacing="0" border="0">
  275. <tr>
  276. <td class="md" nowrap valign="top"> int* <a class="el" href="classCPVRTBoneBatches.html#o0">CPVRTBoneBatches::pnBatches</a>
  277. </table>
  278. </td>
  279. </tr>
  280. </table>
  281. <table cellspacing=5 cellpadding=0 border=0>
  282. <tr>
  283. <td>
  284. &nbsp;
  285. </td>
  286. <td>
  287. <p>
  288. Space for nBatchBoneMax bone indices, per batch </td>
  289. </tr>
  290. </table>
  291. <a class="anchor" name="o2" doxytag="CPVRTBoneBatches::pnBatchOffset" ></a><p>
  292. <br><br><h3>pnBatchOffset</h3><br><div>
  293. <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  294. <tr>
  295. <td class="mdRow">
  296. <table cellpadding="0" cellspacing="0" border="0">
  297. <tr>
  298. <td class="md" nowrap valign="top"> int* <a class="el" href="classCPVRTBoneBatches.html#o2">CPVRTBoneBatches::pnBatchOffset</a>
  299. </table>
  300. </td>
  301. </tr>
  302. </table>
  303. <table cellspacing=5 cellpadding=0 border=0>
  304. <tr>
  305. <td>
  306. &nbsp;
  307. </td>
  308. <td>
  309. <p>
  310. Offset into triangle array, per batch </td>
  311. </tr>
  312. </table>
  313. <hr>The documentation for this class was generated from the following file:<ul>
  314. <li><a class="el" href="PVRTBoneBatch_8h-source.html">PVRTBoneBatch.h</a></ul>
  315. <br>
  316. <br>
  317. <P align=left><FONT size=2><STRONG><A
  318. href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> ©
  319. 1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
  320. <hr>
  321. <address style="align: left;"><small><FONT color=f0f>
  322. Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
  323. </body>
  324. </html>