1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50    <title>nw::demo::ParticleEffect</title>
51  </head>
52  <body>
53    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/demo/Overview.html">demo</a>::ParticleEffect</CODE> Class</h1>
54    <h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class ParticleEffect</pre>
57    </div>
58    <h2>Description</h2>
59    <div class="section">
60      <p>Particle set for a single expression.</p>
61    </div>
62    <a name="function" id="function">
63      <h2>Member Functions</h2>
64      <div class="section">
65        <table class="members">
66          <tr>
67            <th class="category" colspan="3">Initialization/Shutdown</th>
68          </tr>
69          <tr>
70            <td width="100">
71              <span class="static_style" title="static">S</span> </td>
72            <th>
73              <a href="../../../nw/demo/ParticleEffect/Create.html"><CODE>Create</CODE></a>
74            </th>
75            <td>Creates a <CODE>ParticleEffect</CODE> class.</td>
76          </tr>
77          <tr>
78            <td width="100">  </td>
79            <th>
80              <a href="../../../nw/demo/ParticleEffect/Destroy.html"><CODE>Destroy</CODE></a>
81            </th>
82            <td>Destroys a <CODE>ParticleEffect</CODE> class.</td>
83          </tr>
84          <tr>
85            <td width="100">  </td>
86            <th>
87              <a href="../../../nw/demo/ParticleEffect/Setup.html"><CODE>Setup</CODE></a>
88            </th>
89            <td>Sets up a resource.</td>
90          </tr>
91          <tr>
92            <td width="100">  </td>
93            <th>
94              <a href="../../../nw/demo/ParticleEffect/Register.html"><CODE>Register</CODE></a>
95            </th>
96            <td>Registers nodes with the names specified by the resource as management targets.</td>
97          </tr>
98          <tr>
99            <td width="100">  </td>
100            <th>
101              <a href="../../../nw/demo/ParticleEffect/ParticleEffect.html"><CODE>ParticleEffect</CODE></a>
102            </th>
103            <td>Constructor.</td>
104          </tr>
105          <tr>
106            <td width="100">  </td>
107            <th>
108              <a href="../../../nw/demo/ParticleEffect/~ParticleEffect.html"><CODE>~ParticleEffect</CODE></a>
109            </th>
110            <td>Destructor.</td>
111          </tr>
112          <tr>
113            <th class="category" colspan="3">Shader Binary Management</th>
114          </tr>
115          <tr>
116            <td width="100">
117              <span class="static_style" title="static">S</span> </td>
118            <th>
119              <a href="../../../nw/demo/ParticleEffect/InitializeShaderBinary.html"><CODE>InitializeShaderBinary</CODE></a>
120            </th>
121            <td>Loads an external shader file.</td>
122          </tr>
123          <tr>
124            <td width="100">
125              <span class="static_style" title="static">S</span> </td>
126            <th>
127              <a href="../../../nw/demo/ParticleEffect/FinalizeShaderBinary.html"><CODE>FinalizeShaderBinary</CODE></a>
128            </th>
129            <td>Destroys a loaded external shader file.</td>
130          </tr>
131          <tr>
132            <th class="category" colspan="3">Generating/Destroying</th>
133          </tr>
134          <tr>
135            <td width="100">  </td>
136            <th>
137              <a href="../../../nw/demo/ParticleEffect/CreateMultiEmitterParticleHandle.html"><CODE>CreateMultiEmitterParticleHandle</CODE></a>
138            </th>
139            <td>Generates a <CODE>ParticleHandle</CODE>.</td>
140          </tr>
141          <tr>
142            <td width="100">  </td>
143            <th>
144              <a href="../../../nw/demo/ParticleEffect/LeaseInstance.html"><CODE>LeaseInstance</CODE></a>
145            </th>
146            <td>Leases (rents) an already created <CODE>ParticleHandle</CODE> instance.</td>
147          </tr>
148          <tr>
149            <td width="100">  </td>
150            <th>
151              <a href="../../../nw/demo/ParticleEffect/ReleaseInstance.html"><CODE>ReleaseInstance</CODE></a>
152            </th>
153            <td>Returns the leased <CODE>ParticleHandle</CODE>.</td>
154          </tr>
155          <tr>
156            <td width="100">  </td>
157            <th>
158              <a href="../../../nw/demo/ParticleEffect/DestroyParticleNode.html"><CODE>DestroyParticleNode</CODE></a>
159            </th>
160            <td>
161        </td>
162          </tr>
163          <tr>
164            <th class="category" colspan="3">Get</th>
165          </tr>
166          <tr>
167            <td width="100">  </td>
168            <th>
169              <a href="../../../nw/demo/ParticleEffect/GetActiveEffect.html"><CODE>GetActiveEffect</CODE></a>
170            </th>
171            <td>Gets an effect leased by index.</td>
172          </tr>
173          <tr>
174            <td width="100">  </td>
175            <th>
176              <a href="../../../nw/demo/ParticleEffect/ResetParticle.html"><CODE>ResetParticle</CODE></a>
177            </th>
178            <td>Initializes a node.</td>
179          </tr>
180          <tr>
181            <th class="category" colspan="3">Instance Pool</th>
182          </tr>
183          <tr>
184            <td width="100">  </td>
185            <th>
186              <a href="../../../nw/demo/ParticleEffect/GetPoolSize.html"><CODE>GetPoolSize</CODE></a>
187            </th>
188            <td>Gets the total number of instances already allocated including those being leased.</td>
189          </tr>
190          <tr>
191            <td width="100">  </td>
192            <th>
193              <a href="../../../nw/demo/ParticleEffect/GetFreeSize.html"><CODE>GetFreeSize</CODE></a>
194            </th>
195            <td>Gets the number of free instances not being leased.</td>
196          </tr>
197          <tr>
198            <td width="100">  </td>
199            <th>
200              <a href="../../../nw/demo/ParticleEffect/GetActiveSize.html"><CODE>GetActiveSize</CODE></a>
201            </th>
202            <td>Gets the number of instances being leased.</td>
203          </tr>
204          <tr>
205            <td width="100">  </td>
206            <th>
207              <a href="../../../nw/demo/ParticleEffect/AddPool.html"><CODE>AddPool</CODE></a>
208            </th>
209            <td>Newly pools the specified number of instances.</td>
210          </tr>
211          <tr>
212            <td width="100">  </td>
213            <th>
214              <a href="../../../nw/demo/ParticleEffect/FreePool.html"><CODE>FreePool</CODE></a>
215            </th>
216            <td>Destroys all instances other than those being leased.</td>
217          </tr> </table>
218      </div>
219    </a>
220  <hr><p>CONFIDENTIAL</p></body>
221</html>