blob: 9ba68952b7281082c6e4be1e9b07b85850cfa255 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleExt::PxParticleExt::IndexPool Class Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
</head>
<body bgcolor="#FFFFFF">
<div id="header">
<hr class="first">
<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navpath"><a class="el" href="classPxParticleExt.html">PxParticleExt</a>::<a class="el" href="classPxParticleExt_1_1IndexPool.html">IndexPool</a>
</div>
<div class="contents">
<h1>PxParticleExt::PxParticleExt::IndexPool Class Reference</h1><!-- doxytag: class="PxParticleExt::IndexPool" -->Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">PxParticleExt::IndexPool</a> instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with <a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxParticleExt_8h-source.html">PxParticleExt.h</a>></code>
<p>
<p>
<a href="classPxParticleExt_1_1IndexPool-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#a8925253f6aba703d7ee7fa9c78ef5bb">allocateIndices</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> num, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates a requested number of indices if possible. <a href="#a8925253f6aba703d7ee7fa9c78ef5bb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#337a192c7148f0065865809e27797def">freeIndices</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> num, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates a requested number of indices. <a href="#337a192c7148f0065865809e27797def"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#c8c3dd06ac3fdf8129d1f32f763c99d7">freeIndices</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates all previously allocated indices. <a href="#c8c3dd06ac3fdf8129d1f32f763c99d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#0f3a38f3fa80a619cdf934349b4d2f79">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">IndexPool</a> instance. <a href="#0f3a38f3fa80a619cdf934349b4d2f79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleExt_1_1IndexPool.html#caa320043604a6cdf87803719e7ea193">~IndexPool</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <a href="#caa320043604a6cdf87803719e7ea193"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">PxParticleExt::IndexPool</a> instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with <a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a>.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleExt.html#b1c48052580ebe5df919b6b5505a9bad" title="Creates a PxParticlesExt::IndexPool instance.">PxParticleExt::createIndexPool()</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="caa320043604a6cdf87803719e7ea193"></a><!-- doxytag: member="PxParticleExt::IndexPool::~IndexPool" ref="caa320043604a6cdf87803719e7ea193" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxParticleExt::PxParticleExt::IndexPool::~IndexPool </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
virtual destructor
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a8925253f6aba703d7ee7fa9c78ef5bb"></a><!-- doxytag: member="PxParticleExt::IndexPool::allocateIndices" ref="a8925253f6aba703d7ee7fa9c78ef5bb" args="(PxU32 num, const PxStrideIterator< PxU32 > &indexBuffer)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxParticleExt::PxParticleExt::IndexPool::allocateIndices </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td>
<td class="paramname"> <em>indexBuffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates a requested number of indices if possible.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>num</em> </td><td>Number of indices that should be allocated. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>indexBuffer</em> </td><td>Strided data to which allocated indices are written. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>PxU32. Number of indices that where allocated by the operation. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c8c3dd06ac3fdf8129d1f32f763c99d7"></a><!-- doxytag: member="PxParticleExt::IndexPool::freeIndices" ref="c8c3dd06ac3fdf8129d1f32f763c99d7" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deallocates all previously allocated indices.
<p>
</div>
</div><p>
<a class="anchor" name="337a192c7148f0065865809e27797def"></a><!-- doxytag: member="PxParticleExt::IndexPool::freeIndices" ref="337a192c7148f0065865809e27797def" args="(PxU32 num, const PxStrideIterator< const PxU32 > &indexBuffer)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::freeIndices </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td>
<td class="paramname"> <em>indexBuffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deallocates a requested number of indices.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>num</em> </td><td>Number of indices that should be freed. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>indexBuffer</em> </td><td>Strided data describing the indices that need to be freed. It's a requirement to specify unique indices, that where previously allocated by PxParticlesExt::allocateIndices() </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0f3a38f3fa80a619cdf934349b4d2f79"></a><!-- doxytag: member="PxParticleExt::IndexPool::release" ref="0f3a38f3fa80a619cdf934349b4d2f79" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxParticleExt::PxParticleExt::IndexPool::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases <a class="el" href="classPxParticleExt_1_1IndexPool.html" title="Class to manage particle indices. Extension particle index management can be useful...">IndexPool</a> instance.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxParticleExt_8h-source.html">PxParticleExt.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>
|