diff options
Diffstat (limited to 'docs/api/files/group___nv_flow_context.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_context.html | 411 |
1 files changed, 411 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_context.html b/docs/api/files/group___nv_flow_context.html new file mode 100644 index 0000000..23daddd --- /dev/null +++ b/docs/api/files/group___nv_flow_context.html @@ -0,0 +1,411 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 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> |