diff options
| author | Andrew Reidmeyer <[email protected]> | 2017-03-15 09:28:59 -0600 |
|---|---|---|
| committer | Andrew Reidmeyer <[email protected]> | 2017-03-15 09:28:59 -0600 |
| commit | f5f6a899903a309f1fc93b31c0297fc7b3b5cf46 (patch) | |
| tree | ed3dece338b579d5b51af494b2d543fb46c43fa3 /docs/api/files/group___nv_flow_grid_proxy.html | |
| download | flow-f5f6a899903a309f1fc93b31c0297fc7b3b5cf46.tar.xz flow-f5f6a899903a309f1fc93b31c0297fc7b3b5cf46.zip | |
Initial 1.0.0 binary releasev1.0.0
Diffstat (limited to 'docs/api/files/group___nv_flow_grid_proxy.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_grid_proxy.html | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_grid_proxy.html b/docs/api/files/group___nv_flow_grid_proxy.html new file mode 100644 index 0000000..cdba262 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_proxy.html @@ -0,0 +1,258 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridProxy</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>NvFlowGridProxy</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_proxy_desc.html">NvFlowGridProxyDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters need to create a grid proxy. <a href="struct_nv_flow_grid_proxy_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_grid_proxy_flush_params.html">NvFlowGridProxyFlushParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters need to create a multi-GPU proxy. <a href="struct_nv_flow_grid_proxy_flush_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_proxy.html#gd49c07926e022ba8ee4397db5ff03577">NvFlowGridProxyType</a> { <a class="el" href="group___nv_flow_grid_proxy.html#ggd49c07926e022ba8ee4397db5ff03577ba63eead41bba89a6b6594612c0b4730">eNvFlowGridProxyTypePassThrough</a> = 0, +<a class="el" href="group___nv_flow_grid_proxy.html#ggd49c07926e022ba8ee4397db5ff03577a2742f14c8a312e8e1ad5f88357bba39">eNvFlowGridProxyTypeMultiGPU</a> = 1, +<a class="el" href="group___nv_flow_grid_proxy.html#ggd49c07926e022ba8ee4397db5ff035771bb82e135d6fc72a92b66e0910123102">eNvFlowGridProxyTypeInterQueue</a> = 2 + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Proxy types. <a href="group___nv_flow_grid_proxy.html#gd49c07926e022ba8ee4397db5ff03577">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowGridProxy * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_proxy.html#gb83baa8533f982c3a9226091a687c9ae">NvFlowCreateGridProxy</a> (const <a class="el" href="struct_nv_flow_grid_proxy_desc.html">NvFlowGridProxyDesc</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_grid_proxy.html#gba62825ed98f5e8b0150caff9df1bed3">NvFlowGridProxyFlush</a> (NvFlowGridProxy *proxy, const <a class="el" href="struct_nv_flow_grid_proxy_flush_params.html">NvFlowGridProxyFlushParams</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_grid_proxy.html#g755a90ed03e901322fff12a23a5b9bf8">NvFlowGridProxyGetGridExport</a> (NvFlowGridProxy *proxy, NvFlowContext *renderContext)</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_proxy.html#gad1e7d715f4dde72c8cd114e9935b5f5">NvFlowGridProxyPush</a> (NvFlowGridProxy *proxy, NvFlowGridExport *gridExport, const <a class="el" href="struct_nv_flow_grid_proxy_flush_params.html">NvFlowGridProxyFlushParams</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_proxy.html#gd4a4abce1f387e892e350162577fdecc">NvFlowReleaseGridProxy</a> (NvFlowGridProxy *proxy)</td></tr> + +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="gd49c07926e022ba8ee4397db5ff03577"></a><!-- doxytag: member="NvFlow.h::NvFlowGridProxyType" ref="gd49c07926e022ba8ee4397db5ff03577" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_grid_proxy.html#gd49c07926e022ba8ee4397db5ff03577">NvFlowGridProxyType</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Proxy types. +<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="ggd49c07926e022ba8ee4397db5ff03577ba63eead41bba89a6b6594612c0b4730"></a><!-- doxytag: member="eNvFlowGridProxyTypePassThrough" ref="ggd49c07926e022ba8ee4397db5ff03577ba63eead41bba89a6b6594612c0b4730" args="" -->eNvFlowGridProxyTypePassThrough</em> </td><td> +No operation, allows common code path for single versus multiple GPUs in the application. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggd49c07926e022ba8ee4397db5ff03577a2742f14c8a312e8e1ad5f88357bba39"></a><!-- doxytag: member="eNvFlowGridProxyTypeMultiGPU" ref="ggd49c07926e022ba8ee4397db5ff03577a2742f14c8a312e8e1ad5f88357bba39" args="" -->eNvFlowGridProxyTypeMultiGPU</em> </td><td> +Transports render data between GPUs. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggd49c07926e022ba8ee4397db5ff035771bb82e135d6fc72a92b66e0910123102"></a><!-- doxytag: member="eNvFlowGridProxyTypeInterQueue" ref="ggd49c07926e022ba8ee4397db5ff035771bb82e135d6fc72a92b66e0910123102" args="" -->eNvFlowGridProxyTypeInterQueue</em> </td><td> +Versions grid export data for safe async compute. </td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="gb83baa8533f982c3a9226091a687c9ae"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateGridProxy" ref="gb83baa8533f982c3a9226091a687c9ae" args="(const NvFlowGridProxyDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridProxy* NvFlowCreateGridProxy </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_proxy_desc.html">NvFlowGridProxyDesc</a> * </td> + <td class="paramname"> <em>desc</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a grid proxy.<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>desc</em> </td><td>Description required to create grid proxy.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created grid proxy. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gba62825ed98f5e8b0150caff9df1bed3"></a><!-- doxytag: member="NvFlow.h::NvFlowGridProxyFlush" ref="gba62825ed98f5e8b0150caff9df1bed3" args="(NvFlowGridProxy *proxy, const NvFlowGridProxyFlushParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridProxyFlush </td> + <td>(</td> + <td class="paramtype">NvFlowGridProxy * </td> + <td class="paramname"> <em>proxy</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_proxy_flush_params.html">NvFlowGridProxyFlushParams</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> +Helps simulation results move faster between GPUs, should be called before each render.<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>proxy</em> </td><td>The grid proxy to be flushed. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters needed to flush the data. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g755a90ed03e901322fff12a23a5b9bf8"></a><!-- doxytag: member="NvFlow.h::NvFlowGridProxyGetGridExport" ref="g755a90ed03e901322fff12a23a5b9bf8" args="(NvFlowGridProxy *proxy, NvFlowContext *renderContext)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridExport* NvFlowGridProxyGetGridExport </td> + <td>(</td> + <td class="paramtype">NvFlowGridProxy * </td> + <td class="paramname"> <em>proxy</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">NvFlowContext * </td> + <td class="paramname"> <em>renderContext</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the latest grid export available on the render GPU.<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>proxy</em> </td><td>The grid proxy supplying the grid export. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>renderContext</em> </td><td>The context that will render the grid export.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The latest grid export available from the proxy. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gad1e7d715f4dde72c8cd114e9935b5f5"></a><!-- doxytag: member="NvFlow.h::NvFlowGridProxyPush" ref="gad1e7d715f4dde72c8cd114e9935b5f5" args="(NvFlowGridProxy *proxy, NvFlowGridExport *gridExport, const NvFlowGridProxyFlushParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridProxyPush </td> + <td>(</td> + <td class="paramtype">NvFlowGridProxy * </td> + <td class="paramname"> <em>proxy</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_grid_proxy_flush_params.html">NvFlowGridProxyFlushParams</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> +Pushes simulation results to the proxy, should be updated after each simulation 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>proxy</em> </td><td>The grid proxy to be updated. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>gridExport</em> </td><td>The grid export with latest simulation results. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters needed to flush the data. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="gd4a4abce1f387e892e350162577fdecc"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseGridProxy" ref="gd4a4abce1f387e892e350162577fdecc" args="(NvFlowGridProxy *proxy)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseGridProxy </td> + <td>(</td> + <td class="paramtype">NvFlowGridProxy * </td> + <td class="paramname"> <em>proxy</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a grid proxy.<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>proxy</em> </td><td>The grid proxy to be released. </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> |