blob: d774b52630d57d5c6cd22d262efc174a0082d398 (
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
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
<html>
<head>
<title>NVIDIA(R) Flow(R) 1.0.1 API Reference: NvFlowContext</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>NvFlowContext</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_shader_linear_params.html">NvFlowShaderLinearParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters for shaders using the linear format (linear interpolation). <a href="struct_nv_flow_shader_linear_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_shader_point_params.html">NvFlowShaderPointParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters for shaders using the point format (no linear interpolation). <a href="struct_nv_flow_shader_point_params.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_context.html#g5bb6acbdf2ac3214caf8ca60881e26a1">NvFlowContextFlushRequestPop</a> (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_context.html#g8e2605cf5ec210124dcf27e26cf9f02a">NvFlowContextFlushRequestPush</a> (NvFlowContext *context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_nv_flow_context_8h.html#f91c3ee4e8314810817e74a5f475aaeb">NvFlowContextAPI</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_context.html#g60d2e5dc07b58f9739978fc3b27f356d">NvFlowContextGetContextType</a> (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_context.html#g1ebbfe787f5f38b302e680af1e33bcfc">NvFlowContextPop</a> (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_context.html#g819dc2d09e8dbcbf7f05d6b796c21224">NvFlowContextProcessFenceSignal</a> (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_context.html#gbd723f0b143237ac632f116abaf31796">NvFlowContextProcessFenceWait</a> (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_context.html#g47a623ed59cd2982a266cae7b8c29962">NvFlowContextPush</a> (NvFlowContext *context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_context.html#g305f05bb4c684aef4e044645d25700db">NvFlowDeferredRelease</a> (float timeoutMS)</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_context.html#g850e4590982357e445d80c73f7ddbe72">NvFlowReleaseContext</a> (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_context.html#gb3103fc7e218477f79abddb6ded20998">NvFlowReleaseDepthStencilView</a> (NvFlowDepthStencilView *view)</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_context.html#ga7abe1a0dd70ad503f876d0e4c782b45">NvFlowReleaseRenderTargetView</a> (NvFlowRenderTargetView *view)</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_context.html#g34f2b17db1b2f9a3f4fc5785609519cf">NvFlowSetFreeFunc</a> (void(*free)(void *ptr))</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_context.html#g0eb4f881729fa14e52ee8d03d4d13960">NvFlowSetMallocFunc</a> (void *(*malloc)(size_t size))</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g5bb6acbdf2ac3214caf8ca60881e26a1"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextFlushRequestPop" ref="g5bb6acbdf2ac3214caf8ca60881e26a1" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NvFlowContextFlushRequestPop </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pop any pending requests for the Flow context to flush to queue, resets the request state<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 Flow context to check for requests on.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a flush is requested </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8e2605cf5ec210124dcf27e26cf9f02a"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextFlushRequestPush" ref="g8e2605cf5ec210124dcf27e26cf9f02a" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowContextFlushRequestPush </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Push a request for the Flow context to request a flush to queue<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 Flow context to make the request on. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g60d2e5dc07b58f9739978fc3b27f356d"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextGetContextType" ref="g60d2e5dc07b58f9739978fc3b27f356d" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_nv_flow_context_8h.html#f91c3ee4e8314810817e74a5f475aaeb">NvFlowContextAPI</a> NvFlowContextGetContextType </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the API type of the current context<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 Flow context to get the type of.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>context The Flow context to be released. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1ebbfe787f5f38b302e680af1e33bcfc"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextPop" ref="g1ebbfe787f5f38b302e680af1e33bcfc" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowContextPop </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Restores graphics/compute pipeline state pushed by NvFlowContextPush.<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 Flow context to restore. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g819dc2d09e8dbcbf7f05d6b796c21224"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextProcessFenceSignal" ref="g819dc2d09e8dbcbf7f05d6b796c21224" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowContextProcessFenceSignal </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process pending GPU fence signals, on deviceQueue associated with this context<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 Flow context to submit fence signals on. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gbd723f0b143237ac632f116abaf31796"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextProcessFenceWait" ref="gbd723f0b143237ac632f116abaf31796" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowContextProcessFenceWait </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process pending GPU wait on fence, on deviceQueue associated with this context<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 Flow context to submit fence waits on. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g47a623ed59cd2982a266cae7b8c29962"></a><!-- doxytag: member="NvFlowContext.h::NvFlowContextPush" ref="g47a623ed59cd2982a266cae7b8c29962" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowContextPush </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pushes graphics/compute pipeline state for later restoration by NvFlowContextPop.<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 Flow context to push. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g305f05bb4c684aef4e044645d25700db"></a><!-- doxytag: member="NvFlowContext.h::NvFlowDeferredRelease" ref="g305f05bb4c684aef4e044645d25700db" args="(float timeoutMS)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> NvFlowDeferredRelease </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>timeoutMS</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Should be called before DLL unload, to ensure complete cleanup.<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>timeoutMS</em> </td><td>Wait timeout, in milliseconds</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current number of active deferred release units. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g850e4590982357e445d80c73f7ddbe72"></a><!-- doxytag: member="NvFlowContext.h::NvFlowReleaseContext" ref="g850e4590982357e445d80c73f7ddbe72" args="(NvFlowContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowReleaseContext </td>
<td>(</td>
<td class="paramtype">NvFlowContext * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases a Flow context.<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 Flow context to be released. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gb3103fc7e218477f79abddb6ded20998"></a><!-- doxytag: member="NvFlowContext.h::NvFlowReleaseDepthStencilView" ref="gb3103fc7e218477f79abddb6ded20998" args="(NvFlowDepthStencilView *view)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowReleaseDepthStencilView </td>
<td>(</td>
<td class="paramtype">NvFlowDepthStencilView * </td>
<td class="paramname"> <em>view</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases a Flow depth stencil view.<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>view</em> </td><td>The Flow depth stencil view to be released. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ga7abe1a0dd70ad503f876d0e4c782b45"></a><!-- doxytag: member="NvFlowContext.h::NvFlowReleaseRenderTargetView" ref="ga7abe1a0dd70ad503f876d0e4c782b45" args="(NvFlowRenderTargetView *view)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowReleaseRenderTargetView </td>
<td>(</td>
<td class="paramtype">NvFlowRenderTargetView * </td>
<td class="paramname"> <em>view</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases a Flow render target view.<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>view</em> </td><td>The Flow render target view to be released. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g34f2b17db1b2f9a3f4fc5785609519cf"></a><!-- doxytag: member="NvFlowContext.h::NvFlowSetFreeFunc" ref="g34f2b17db1b2f9a3f4fc5785609519cf" args="(void(*free)(void *ptr))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowSetFreeFunc </td>
<td>(</td>
<td class="paramtype">void(*)(void *ptr) </td>
<td class="paramname"> <em>free</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An optional callback to allow the application to control how Flow releases CPU memory.<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>free</em> </td><td>The free function for Flow to use. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g0eb4f881729fa14e52ee8d03d4d13960"></a><!-- doxytag: member="NvFlowContext.h::NvFlowSetMallocFunc" ref="g0eb4f881729fa14e52ee8d03d4d13960" args="(void *(*malloc)(size_t size))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NvFlowSetMallocFunc </td>
<td>(</td>
<td class="paramtype">void *(*)(size_t size) </td>
<td class="paramname"> <em>malloc</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An optional callback to allow the application to control how Flow allocates CPU memory.<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>malloc</em> </td><td>The allocation function for Flow to use. </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>
|