From f5f6a899903a309f1fc93b31c0297fc7b3b5cf46 Mon Sep 17 00:00:00 2001 From: Andrew Reidmeyer Date: Wed, 15 Mar 2017 09:28:59 -0600 Subject: Initial 1.0.0 binary release --- docs/api/files/group___nv_flow_grid_proxy.html | 258 +++++++++++++++++++++++++ 1 file changed, 258 insertions(+) create mode 100644 docs/api/files/group___nv_flow_grid_proxy.html (limited to 'docs/api/files/group___nv_flow_grid_proxy.html') 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 @@ + + + NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridProxy + + + + + + + + +
+

NvFlowGridProxy

+ + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  NvFlowGridProxyDesc
 Parameters need to create a grid proxy. More...
struct  NvFlowGridProxyFlushParams
 Parameters need to create a multi-GPU proxy. More...

Enumerations

enum  NvFlowGridProxyType { eNvFlowGridProxyTypePassThrough = 0, +eNvFlowGridProxyTypeMultiGPU = 1, +eNvFlowGridProxyTypeInterQueue = 2 + }
 Proxy types. More...

Functions

NvFlowGridProxy * NvFlowCreateGridProxy (const NvFlowGridProxyDesc *desc)
void NvFlowGridProxyFlush (NvFlowGridProxy *proxy, const NvFlowGridProxyFlushParams *params)
NvFlowGridExport * NvFlowGridProxyGetGridExport (NvFlowGridProxy *proxy, NvFlowContext *renderContext)
void NvFlowGridProxyPush (NvFlowGridProxy *proxy, NvFlowGridExport *gridExport, const NvFlowGridProxyFlushParams *params)
void NvFlowReleaseGridProxy (NvFlowGridProxy *proxy)
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum NvFlowGridProxyType
+
+
+ +

+Proxy types. +

+

Enumerator:
+ + + + +
eNvFlowGridProxyTypePassThrough  +No operation, allows common code path for single versus multiple GPUs in the application.
eNvFlowGridProxyTypeMultiGPU  +Transports render data between GPUs.
eNvFlowGridProxyTypeInterQueue  +Versions grid export data for safe async compute.
+
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + +
NvFlowGridProxy* NvFlowCreateGridProxy (const NvFlowGridProxyDesc *  desc  ) 
+
+
+ +

+Creates a grid proxy.

+

Parameters:
+ + +
[in] desc Description required to create grid proxy.
+
+
Returns:
The created grid proxy.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void NvFlowGridProxyFlush (NvFlowGridProxy *  proxy,
const NvFlowGridProxyFlushParams *  params 
)
+
+
+ +

+Helps simulation results move faster between GPUs, should be called before each render.

+

Parameters:
+ + + +
[in] proxy The grid proxy to be flushed.
[in] params Parameters needed to flush the data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
NvFlowGridExport* NvFlowGridProxyGetGridExport (NvFlowGridProxy *  proxy,
NvFlowContext *  renderContext 
)
+
+
+ +

+Returns the latest grid export available on the render GPU.

+

Parameters:
+ + + +
[in] proxy The grid proxy supplying the grid export.
[in] renderContext The context that will render the grid export.
+
+
Returns:
The latest grid export available from the proxy.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void NvFlowGridProxyPush (NvFlowGridProxy *  proxy,
NvFlowGridExport *  gridExport,
const NvFlowGridProxyFlushParams *  params 
)
+
+
+ +

+Pushes simulation results to the proxy, should be updated after each simulation update.

+

Parameters:
+ + + + +
[in] proxy The grid proxy to be updated.
[in] gridExport The grid export with latest simulation results.
[in] params Parameters needed to flush the data.
+
+ +
+

+ +

+
+ + + + + + + + + +
void NvFlowReleaseGridProxy (NvFlowGridProxy *  proxy  ) 
+
+
+ +

+Releases a grid proxy.

+

Parameters:
+ + +
[in] proxy The grid proxy to be released.
+
+ +
+

+

+ +
+Copyright © 2014-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com +
+ + -- cgit v1.2.3