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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
<html>
<head>
<title>NVIDIA(R) Flow(R) 1.0.1 API Reference: NvFlowVolumeShadow</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>NvFlowVolumeShadow</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_volume_shadow_debug_render_params.html">NvFlowVolumeShadowDebugRenderParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters required to visualize shadow block allocation. <a href="struct_nv_flow_volume_shadow_debug_render_params.html#_details">More...</a><br></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_volume_shadow_desc.html">NvFlowVolumeShadowDesc</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Description required to create volume shadow object. <a href="struct_nv_flow_volume_shadow_desc.html#_details">More...</a><br></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_volume_shadow_params.html">NvFlowVolumeShadowParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters required to update volume shadows. <a href="struct_nv_flow_volume_shadow_params.html#_details">More...</a><br></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_volume_shadow_stats.html">NvFlowVolumeShadowStats</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stats on currently active volume shadow. <a href="struct_nv_flow_volume_shadow_stats.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowVolumeShadow * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_volume_shadow.html#gd05cf3042cf664ee335d766ae4383bdb">NvFlowCreateVolumeShadow</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_volume_shadow_desc.html">NvFlowVolumeShadowDesc</a> *desc)</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_volume_shadow.html#g3b11a8e736d1cd4cc674a8737067adbb">NvFlowReleaseVolumeShadow</a> (NvFlowVolumeShadow *volumeShadow)</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_volume_shadow.html#gdb4ed8583577e3499f03042cf925b418">NvFlowVolumeShadowDebugRender</a> (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, const <a class="el" href="struct_nv_flow_volume_shadow_debug_render_params.html">NvFlowVolumeShadowDebugRenderParams</a> *params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowGridExport * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_volume_shadow.html#gd3f1d44c0e39e8fb02963cfa7ba4e210">NvFlowVolumeShadowGetGridExport</a> (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context)</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_volume_shadow.html#g71c0805f7802f52b25087ec490360ac3">NvFlowVolumeShadowGetStats</a> (NvFlowVolumeShadow *volumeShadow, <a class="el" href="struct_nv_flow_volume_shadow_stats.html">NvFlowVolumeShadowStats</a> *stats)</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_volume_shadow.html#g7362cf24bde42a6f27c74d2c7720a38e">NvFlowVolumeShadowUpdate</a> (NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, NvFlowGridExport *gridExport, const <a class="el" href="struct_nv_flow_volume_shadow_params.html">NvFlowVolumeShadowParams</a> *params)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gd05cf3042cf664ee335d766ae4383bdb"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateVolumeShadow" ref="gd05cf3042cf664ee335d766ae4383bdb" args="(NvFlowContext *context, const NvFlowVolumeShadowDesc *desc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NvFlowVolumeShadow* NvFlowCreateVolumeShadow </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_nv_flow_volume_shadow_desc.html">NvFlowVolumeShadowDesc</a> * </td>
<td class="paramname"> <em>desc</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a volume shadow object.<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>context</em> </td><td>The context for GPU resource allocation. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>Description for memory allocation.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created volume shadow object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3b11a8e736d1cd4cc674a8737067adbb"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseVolumeShadow" ref="g3b11a8e736d1cd4cc674a8737067adbb" args="(NvFlowVolumeShadow *volumeShadow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowReleaseVolumeShadow </td>
<td>(</td>
<td class="paramtype">NvFlowVolumeShadow * </td>
<td class="paramname"> <em>volumeShadow</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases a volume shadow object.<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>volumeShadow</em> </td><td>The volume shadow object to be released. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gdb4ed8583577e3499f03042cf925b418"></a><!-- doxytag: member="NvFlow.h::NvFlowVolumeShadowDebugRender" ref="gdb4ed8583577e3499f03042cf925b418" args="(NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, const NvFlowVolumeShadowDebugRenderParams *params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowVolumeShadowDebugRender </td>
<td>(</td>
<td class="paramtype">NvFlowVolumeShadow * </td>
<td class="paramname"> <em>volumeShadow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_nv_flow_volume_shadow_debug_render_params.html">NvFlowVolumeShadowDebugRenderParams</a> * </td>
<td class="paramname"> <em>params</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw debug visualization of sparse volume shadow structure.<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>volumeShadow</em> </td><td>The volume shadow object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context that created the volume shadow object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for debug visualization. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gd3f1d44c0e39e8fb02963cfa7ba4e210"></a><!-- doxytag: member="NvFlow.h::NvFlowVolumeShadowGetGridExport" ref="gd3f1d44c0e39e8fb02963cfa7ba4e210" args="(NvFlowVolumeShadow *volumeShadow, NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NvFlowGridExport* NvFlowVolumeShadowGetGridExport </td>
<td>(</td>
<td class="paramtype">NvFlowVolumeShadow * </td>
<td class="paramname"> <em>volumeShadow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get grid export with shadow results. Currently, shadow results are placed in z component (the burn component).<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>volumeShadow</em> </td><td>The volume shadow object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context that created the volume shadow object.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns grid export with shadow results. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g71c0805f7802f52b25087ec490360ac3"></a><!-- doxytag: member="NvFlow.h::NvFlowVolumeShadowGetStats" ref="g71c0805f7802f52b25087ec490360ac3" args="(NvFlowVolumeShadow *volumeShadow, NvFlowVolumeShadowStats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowVolumeShadowGetStats </td>
<td>(</td>
<td class="paramtype">NvFlowVolumeShadow * </td>
<td class="paramname"> <em>volumeShadow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_nv_flow_volume_shadow_stats.html">NvFlowVolumeShadowStats</a> * </td>
<td class="paramname"> <em>stats</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get stats for latest shadow computation.<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>volumeShadow</em> </td><td>The volume shadow object. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>stats</em> </td><td>Destination for shadow computation stats. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g7362cf24bde42a6f27c74d2c7720a38e"></a><!-- doxytag: member="NvFlow.h::NvFlowVolumeShadowUpdate" ref="g7362cf24bde42a6f27c74d2c7720a38e" args="(NvFlowVolumeShadow *volumeShadow, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeShadowParams *params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowVolumeShadowUpdate </td>
<td>(</td>
<td class="paramtype">NvFlowVolumeShadow * </td>
<td class="paramname"> <em>volumeShadow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NvFlowGridExport * </td>
<td class="paramname"> <em>gridExport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_nv_flow_volume_shadow_params.html">NvFlowVolumeShadowParams</a> * </td>
<td class="paramname"> <em>params</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generate shadows from provided grid export.<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>volumeShadow</em> </td><td>The volume shadow object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context that created the volume shadow object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>gridExport</em> </td><td>The grid export to use for generating shadows. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for shadow generation. </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>
|