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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<html>
<head>
<title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridEmit</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="nvflow_logo.png">
<br>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>NvFlowGridEmit</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nv_flow_grid_emit_params.html">NvFlowGridEmitParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters for both emission and collision. <a href="struct_nv_flow_grid_emit_params.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_emit.html#g354e198afb80cbf3a1e354c2f2ed2bf8">NvFlowGridEmitMode</a> { <br>
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf8531673a71b017d3031d5e751091e24d0">eNvFlowGridEmitModeDefault</a> = 0,
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf85ed944114b3ad4115ec9626d2a19dba3">eNvFlowGridEmitModeDisableVelocity</a> = 0x01,
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf82f8e1075ed6a96d3641aa7b2003ba96f">eNvFlowGridEmitModeDisableDensity</a> = 0x02,
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf8236184ac173c1517b190db41ad5eed19">eNvFlowGridEmitModeDisableAlloc</a> = 0x04,
<br>
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf879026fcdaceee9c5ad9a6698733e3400">eNvFlowGridEmitModeAllocShape</a> = 0x08,
<a class="el" href="group___nv_flow_grid_emit.html#gg354e198afb80cbf3a1e354c2f2ed2bf809ae3eeff38d8d0e0869db43b17b30e0">eNvFlowGridEmitModeAllocShapeOnly</a> = 0x0F
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitter modes. <a href="group___nv_flow_grid_emit.html#g354e198afb80cbf3a1e354c2f2ed2bf8">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_emit.html#gfb6ef5fb891dc2759ffe6c9ff835bfdc">NvFlowGridEmit</a> (NvFlowGrid *grid, const <a class="el" href="union_nv_flow_shape_desc.html">NvFlowShapeDesc</a> *shapes, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> numShapes, const <a class="el" href="struct_nv_flow_grid_emit_params.html">NvFlowGridEmitParams</a> *params, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> numParams)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_emit.html#gee91771d7fae19fd3c2bcb58f0cad629">NvFlowGridEmitParamsDefaults</a> (<a class="el" href="struct_nv_flow_grid_emit_params.html">NvFlowGridEmitParams</a> *params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_emit.html#gfafd945646da940a01d2147ffbeb4906">NvFlowGridUpdateEmitSDFs</a> (NvFlowGrid *grid, NvFlowShapeSDF **sdfs, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> numSdfs)</td></tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g354e198afb80cbf3a1e354c2f2ed2bf8"></a><!-- doxytag: member="NvFlow.h::NvFlowGridEmitMode" ref="g354e198afb80cbf3a1e354c2f2ed2bf8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___nv_flow_grid_emit.html#g354e198afb80cbf3a1e354c2f2ed2bf8">NvFlowGridEmitMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emitter modes.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf8531673a71b017d3031d5e751091e24d0"></a><!-- doxytag: member="eNvFlowGridEmitModeDefault" ref="gg354e198afb80cbf3a1e354c2f2ed2bf8531673a71b017d3031d5e751091e24d0" args="" -->eNvFlowGridEmitModeDefault</em> </td><td>
Emitter will influence velocity and density channels, optionally allocate based on bounds. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf85ed944114b3ad4115ec9626d2a19dba3"></a><!-- doxytag: member="eNvFlowGridEmitModeDisableVelocity" ref="gg354e198afb80cbf3a1e354c2f2ed2bf85ed944114b3ad4115ec9626d2a19dba3" args="" -->eNvFlowGridEmitModeDisableVelocity</em> </td><td>
Flag to disable emitter interaction with velocity field. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf82f8e1075ed6a96d3641aa7b2003ba96f"></a><!-- doxytag: member="eNvFlowGridEmitModeDisableDensity" ref="gg354e198afb80cbf3a1e354c2f2ed2bf82f8e1075ed6a96d3641aa7b2003ba96f" args="" -->eNvFlowGridEmitModeDisableDensity</em> </td><td>
Flag to disable emitter interaction with density field. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf8236184ac173c1517b190db41ad5eed19"></a><!-- doxytag: member="eNvFlowGridEmitModeDisableAlloc" ref="gg354e198afb80cbf3a1e354c2f2ed2bf8236184ac173c1517b190db41ad5eed19" args="" -->eNvFlowGridEmitModeDisableAlloc</em> </td><td>
Flag to disable emitter bound allocation. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf879026fcdaceee9c5ad9a6698733e3400"></a><!-- doxytag: member="eNvFlowGridEmitModeAllocShape" ref="gg354e198afb80cbf3a1e354c2f2ed2bf879026fcdaceee9c5ad9a6698733e3400" args="" -->eNvFlowGridEmitModeAllocShape</em> </td><td>
Emitter will allocate using shape to drive allocation instead of only bounds. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg354e198afb80cbf3a1e354c2f2ed2bf809ae3eeff38d8d0e0869db43b17b30e0"></a><!-- doxytag: member="eNvFlowGridEmitModeAllocShapeOnly" ref="gg354e198afb80cbf3a1e354c2f2ed2bf809ae3eeff38d8d0e0869db43b17b30e0" args="" -->eNvFlowGridEmitModeAllocShapeOnly</em> </td><td>
Flags to configure for shape aware allocation only. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gfb6ef5fb891dc2759ffe6c9ff835bfdc"></a><!-- doxytag: member="NvFlow.h::NvFlowGridEmit" ref="gfb6ef5fb891dc2759ffe6c9ff835bfdc" args="(NvFlowGrid *grid, const NvFlowShapeDesc *shapes, NvFlowUint numShapes, const NvFlowGridEmitParams *params, NvFlowUint numParams)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowGridEmit </td>
<td>(</td>
<td class="paramtype">NvFlowGrid * </td>
<td class="paramname"> <em>grid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="union_nv_flow_shape_desc.html">NvFlowShapeDesc</a> * </td>
<td class="paramname"> <em>shapes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> </td>
<td class="paramname"> <em>numShapes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_nv_flow_grid_emit_params.html">NvFlowGridEmitParams</a> * </td>
<td class="paramname"> <em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> </td>
<td class="paramname"> <em>numParams</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds one or more emit events to be applied with the next grid update.<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>grid</em> </td><td>The Flow grid to apply the emit events. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>shapes</em> </td><td>Array of shape data referenced by emit params. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>numShapes</em> </td><td>Number of shapes in the array. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Array of emit event parameters. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>numParams</em> </td><td>Number of emit events in the array. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gee91771d7fae19fd3c2bcb58f0cad629"></a><!-- doxytag: member="NvFlow.h::NvFlowGridEmitParamsDefaults" ref="gee91771d7fae19fd3c2bcb58f0cad629" args="(NvFlowGridEmitParams *params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowGridEmitParamsDefaults </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_nv_flow_grid_emit_params.html">NvFlowGridEmitParams</a> * </td>
<td class="paramname"> <em>params</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allows the application to request default emit parameters from Flow.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>params</em> </td><td>The parameters for Flow to fill out. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gfafd945646da940a01d2147ffbeb4906"></a><!-- doxytag: member="NvFlow.h::NvFlowGridUpdateEmitSDFs" ref="gfafd945646da940a01d2147ffbeb4906" args="(NvFlowGrid *grid, NvFlowShapeSDF **sdfs, NvFlowUint numSdfs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowGridUpdateEmitSDFs </td>
<td>(</td>
<td class="paramtype">NvFlowGrid * </td>
<td class="paramname"> <em>grid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NvFlowShapeSDF ** </td>
<td class="paramname"> <em>sdfs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> </td>
<td class="paramname"> <em>numSdfs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update internal array of SDFs that can be referenced by sdfOffset<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>grid</em> </td><td>The Flow grid to apply the emit events. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sdfs</em> </td><td>Array of shape data referenced by emit params. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>numSdfs</em> </td><td>Number of shapes in the array. </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<!-- start footer part -->
<div class="footer">
Copyright © 2014-2016 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>
</div>
</body>
</html>
|