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.html | |
| download | flow-1.0.0.tar.xz flow-1.0.0.zip | |
Initial 1.0.0 binary releasev1.0.0
Diffstat (limited to 'docs/api/files/group___nv_flow_grid.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_grid.html | 642 |
1 files changed, 642 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_grid.html b/docs/api/files/group___nv_flow_grid.html new file mode 100644 index 0000000..04a6599 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid.html @@ -0,0 +1,642 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGrid</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>NvFlowGrid</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_desc.html">NvFlowGridDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description required to create a grid. <a href="struct_nv_flow_grid_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_params.html">NvFlowGridParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters controlling grid behavior. <a href="struct_nv_flow_grid_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_grid_reset_desc.html">NvFlowGridResetDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description required to reset a NvFlowGrid. <a href="struct_nv_flow_grid_reset_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_query_time.html">NvFlowQueryTime</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">CPU/GPU timing info. <a href="struct_nv_flow_query_time.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_support.html">NvFlowSupport</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of feature support on the queried Flow context GPU. <a href="struct_nv_flow_support.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.html#gc80b2ab87f05c9baa0d655cbee921e09">NvFlowGridDebugVisFlags</a> { <br> + <a class="el" href="group___nv_flow_grid.html#ggc80b2ab87f05c9baa0d655cbee921e09bbbfd41be5b3640adbfb4d4c0fdfcad2">eNvFlowGridDebugVisDisabled</a> = 0x00, +<a class="el" href="group___nv_flow_grid.html#ggc80b2ab87f05c9baa0d655cbee921e0968aef2ccf169dbae4177388b26d8c906">eNvFlowGridDebugVisBlocks</a> = 0x01, +<a class="el" href="group___nv_flow_grid.html#ggc80b2ab87f05c9baa0d655cbee921e0913fc33f98f0b0a385c8e846866731307">eNvFlowGridDebugVisEmitBounds</a> = 0x02, +<a class="el" href="group___nv_flow_grid.html#ggc80b2ab87f05c9baa0d655cbee921e090f2b1bc376b99e0f366f4dc6bef233fa">eNvFlowGridDebugVisShapesSimple</a> = 0x04, +<br> + <a class="el" href="group___nv_flow_grid.html#ggc80b2ab87f05c9baa0d655cbee921e0913f2378aee89c8352f4c45873be0699a">eNvFlowGridDebugVisCount</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags to control grid debug visualization. <a href="group___nv_flow_grid.html#gc80b2ab87f05c9baa0d655cbee921e09">More...</a><br></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.html#gf05b2ac6de5b1cfbe5cdaade35b61d9e">NvFlowGridTextureChannel</a> { <a class="el" href="group___nv_flow_grid.html#ggf05b2ac6de5b1cfbe5cdaade35b61d9e63935f12dba20abedad53147e50567ec">eNvFlowGridTextureChannelVelocity</a> = 0, +<a class="el" href="group___nv_flow_grid.html#ggf05b2ac6de5b1cfbe5cdaade35b61d9e3e0f1212ba502cf3b9c255563f3ad259">eNvFlowGridTextureChannelDensity</a> = 1, +<a class="el" href="group___nv_flow_grid.html#ggf05b2ac6de5b1cfbe5cdaade35b61d9eff88d2fef40f7ab7e9f11d8953b8ca68">eNvFlowGridTextureChannelDensityCoarse</a> = 2, +<a class="el" href="group___nv_flow_grid.html#ggf05b2ac6de5b1cfbe5cdaade35b61d9e562c2937b7d1bac26885ca3842b7a2ba">eNvFlowGridTextureChannelCount</a> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Grid texture channel, four components per channel. <a href="group___nv_flow_grid.html#gf05b2ac6de5b1cfbe5cdaade35b61d9e">More...</a><br></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.html#g00a313410a6143d31892566799baae21">NvFlowMultiRes</a> { <a class="el" href="group___nv_flow_grid.html#gg00a313410a6143d31892566799baae212b731d38252c4ca150ac1595407767a9">eNvFlowMultiRes1x1x1</a> = 0, +<a class="el" href="group___nv_flow_grid.html#gg00a313410a6143d31892566799baae21e6e410777f2e71032e67aef67d69f0fa">eNvFlowMultiRes2x2x2</a> = 1 + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration used to describe density texture channel resolution relative to velocity resolution. <a href="group___nv_flow_grid.html#g00a313410a6143d31892566799baae21">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowGrid * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid.html#g859485a9ef41d39b4224900c8bfb7c55">NvFlowCreateGrid</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_grid_desc.html">NvFlowGridDesc</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.html#gc2f94afda2a317d1c749825f89f7dbee">NvFlowGridDescDefaults</a> (<a class="el" href="struct_nv_flow_grid_desc.html">NvFlowGridDesc</a> *desc)</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.html#g0fd1d83b8a3a07159e1411396572e03f">NvFlowGridGetGridExport</a> (NvFlowContext *context, NvFlowGrid *grid)</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.html#g149feab11239876e5dda82c98be3cffc">NvFlowGridGPUMemUsage</a> (NvFlowGrid *grid, <a class="el" href="_nv_flow_types_8h.html#73bd0925c776bdb174042d94cb8b74e6">NvFlowUint64</a> *numBytes)</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.html#g267df90efdb2feb7a776d4b37a86ae27">NvFlowGridParamsDefaults</a> (<a class="el" href="struct_nv_flow_grid_params.html">NvFlowGridParams</a> *params)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_nv_flow_types_8h.html#aff66c8a98e5ec3fa740bfeeb7361267">NvFlowResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid.html#g2588127b567fa3cf4221a5735a389455">NvFlowGridQuerySupport</a> (NvFlowGrid *grid, NvFlowContext *context, <a class="el" href="struct_nv_flow_support.html">NvFlowSupport</a> *support)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_nv_flow_types_8h.html#aff66c8a98e5ec3fa740bfeeb7361267">NvFlowResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid.html#gae6709cf94fc97676ed16d03b7b28439">NvFlowGridQueryTime</a> (NvFlowGrid *grid, <a class="el" href="struct_nv_flow_query_time.html">NvFlowQueryTime</a> *gpuTime, <a class="el" href="struct_nv_flow_query_time.html">NvFlowQueryTime</a> *cpuTime)</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.html#gb156d6c13bb4a9cd5561c599011f6f20">NvFlowGridReset</a> (NvFlowGrid *grid, const <a class="el" href="struct_nv_flow_grid_reset_desc.html">NvFlowGridResetDesc</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.html#g16acf6756cb77975b5444116a56c612d">NvFlowGridResetDescDefaults</a> (<a class="el" href="struct_nv_flow_grid_reset_desc.html">NvFlowGridResetDesc</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.html#g3c5067eeb166f2c5d43aa707694ff48d">NvFlowGridSetParams</a> (NvFlowGrid *grid, const <a class="el" href="struct_nv_flow_grid_params.html">NvFlowGridParams</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.html#g6c2125dbb24e274634393a6425cffd7d">NvFlowGridSetTargetLocation</a> (NvFlowGrid *grid, <a class="el" href="struct_nv_flow_float3.html">NvFlowFloat3</a> targetLocation)</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.html#g82ef210f6393ee69d3b52a69aa23c910">NvFlowGridUpdate</a> (NvFlowGrid *grid, NvFlowContext *context, float dt)</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.html#gce43153a6206c8f1e095aad7276469d2">NvFlowReleaseGrid</a> (NvFlowGrid *grid)</td></tr> + +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="gc80b2ab87f05c9baa0d655cbee921e09"></a><!-- doxytag: member="NvFlow.h::NvFlowGridDebugVisFlags" ref="gc80b2ab87f05c9baa0d655cbee921e09" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_grid.html#gc80b2ab87f05c9baa0d655cbee921e09">NvFlowGridDebugVisFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Flags to control grid debug visualization. +<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="ggc80b2ab87f05c9baa0d655cbee921e09bbbfd41be5b3640adbfb4d4c0fdfcad2"></a><!-- doxytag: member="eNvFlowGridDebugVisDisabled" ref="ggc80b2ab87f05c9baa0d655cbee921e09bbbfd41be5b3640adbfb4d4c0fdfcad2" args="" -->eNvFlowGridDebugVisDisabled</em> </td><td> +No debug visualization. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggc80b2ab87f05c9baa0d655cbee921e0968aef2ccf169dbae4177388b26d8c906"></a><!-- doxytag: member="eNvFlowGridDebugVisBlocks" ref="ggc80b2ab87f05c9baa0d655cbee921e0968aef2ccf169dbae4177388b26d8c906" args="" -->eNvFlowGridDebugVisBlocks</em> </td><td> +Simulation block visualization, no overhead. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggc80b2ab87f05c9baa0d655cbee921e0913fc33f98f0b0a385c8e846866731307"></a><!-- doxytag: member="eNvFlowGridDebugVisEmitBounds" ref="ggc80b2ab87f05c9baa0d655cbee921e0913fc33f98f0b0a385c8e846866731307" args="" -->eNvFlowGridDebugVisEmitBounds</em> </td><td> +Emitter bounds visualization, adds overhead. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggc80b2ab87f05c9baa0d655cbee921e090f2b1bc376b99e0f366f4dc6bef233fa"></a><!-- doxytag: member="eNvFlowGridDebugVisShapesSimple" ref="ggc80b2ab87f05c9baa0d655cbee921e090f2b1bc376b99e0f366f4dc6bef233fa" args="" -->eNvFlowGridDebugVisShapesSimple</em> </td><td> +Visualize sphere/capsule/box shapes, adds overhead. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggc80b2ab87f05c9baa0d655cbee921e0913f2378aee89c8352f4c45873be0699a"></a><!-- doxytag: member="eNvFlowGridDebugVisCount" ref="ggc80b2ab87f05c9baa0d655cbee921e0913f2378aee89c8352f4c45873be0699a" args="" -->eNvFlowGridDebugVisCount</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="gf05b2ac6de5b1cfbe5cdaade35b61d9e"></a><!-- doxytag: member="NvFlow.h::NvFlowGridTextureChannel" ref="gf05b2ac6de5b1cfbe5cdaade35b61d9e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_grid.html#gf05b2ac6de5b1cfbe5cdaade35b61d9e">NvFlowGridTextureChannel</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Grid texture channel, four components per channel. +<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="ggf05b2ac6de5b1cfbe5cdaade35b61d9e63935f12dba20abedad53147e50567ec"></a><!-- doxytag: member="eNvFlowGridTextureChannelVelocity" ref="ggf05b2ac6de5b1cfbe5cdaade35b61d9e63935f12dba20abedad53147e50567ec" args="" -->eNvFlowGridTextureChannelVelocity</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggf05b2ac6de5b1cfbe5cdaade35b61d9e3e0f1212ba502cf3b9c255563f3ad259"></a><!-- doxytag: member="eNvFlowGridTextureChannelDensity" ref="ggf05b2ac6de5b1cfbe5cdaade35b61d9e3e0f1212ba502cf3b9c255563f3ad259" args="" -->eNvFlowGridTextureChannelDensity</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggf05b2ac6de5b1cfbe5cdaade35b61d9eff88d2fef40f7ab7e9f11d8953b8ca68"></a><!-- doxytag: member="eNvFlowGridTextureChannelDensityCoarse" ref="ggf05b2ac6de5b1cfbe5cdaade35b61d9eff88d2fef40f7ab7e9f11d8953b8ca68" args="" -->eNvFlowGridTextureChannelDensityCoarse</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="ggf05b2ac6de5b1cfbe5cdaade35b61d9e562c2937b7d1bac26885ca3842b7a2ba"></a><!-- doxytag: member="eNvFlowGridTextureChannelCount" ref="ggf05b2ac6de5b1cfbe5cdaade35b61d9e562c2937b7d1bac26885ca3842b7a2ba" args="" -->eNvFlowGridTextureChannelCount</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g00a313410a6143d31892566799baae21"></a><!-- doxytag: member="NvFlow.h::NvFlowMultiRes" ref="g00a313410a6143d31892566799baae21" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_grid.html#g00a313410a6143d31892566799baae21">NvFlowMultiRes</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Enumeration used to describe density texture channel resolution relative to velocity resolution. +<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="gg00a313410a6143d31892566799baae212b731d38252c4ca150ac1595407767a9"></a><!-- doxytag: member="eNvFlowMultiRes1x1x1" ref="gg00a313410a6143d31892566799baae212b731d38252c4ca150ac1595407767a9" args="" -->eNvFlowMultiRes1x1x1</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg00a313410a6143d31892566799baae21e6e410777f2e71032e67aef67d69f0fa"></a><!-- doxytag: member="eNvFlowMultiRes2x2x2" ref="gg00a313410a6143d31892566799baae21e6e410777f2e71032e67aef67d69f0fa" args="" -->eNvFlowMultiRes2x2x2</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g859485a9ef41d39b4224900c8bfb7c55"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateGrid" ref="g859485a9ef41d39b4224900c8bfb7c55" args="(NvFlowContext *context, const NvFlowGridDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGrid* NvFlowCreateGrid </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_grid_desc.html">NvFlowGridDesc</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 grid.<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 to use to create the new grid. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>The grid description.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created grid. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gc2f94afda2a317d1c749825f89f7dbee"></a><!-- doxytag: member="NvFlow.h::NvFlowGridDescDefaults" ref="gc2f94afda2a317d1c749825f89f7dbee" args="(NvFlowGridDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridDescDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_grid_desc.html">NvFlowGridDesc</a> * </td> + <td class="paramname"> <em>desc</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allows the application to request a default grid description from Flow.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>desc</em> </td><td>The description for Flow to fill out. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g0fd1d83b8a3a07159e1411396572e03f"></a><!-- doxytag: member="NvFlow.h::NvFlowGridGetGridExport" ref="g0fd1d83b8a3a07159e1411396572e03f" args="(NvFlowContext *context, NvFlowGrid *grid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridExport* NvFlowGridGetGridExport </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">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get read interface to the grid simulation results<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 the grid was created with. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>grid</em> </td><td>The grid to read.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns gridExport interface. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g149feab11239876e5dda82c98be3cffc"></a><!-- doxytag: member="NvFlow.h::NvFlowGridGPUMemUsage" ref="g149feab11239876e5dda82c98be3cffc" args="(NvFlowGrid *grid, NvFlowUint64 *numBytes)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridGPUMemUsage </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_nv_flow_types_8h.html#73bd0925c776bdb174042d94cb8b74e6">NvFlowUint64</a> * </td> + <td class="paramname"> <em>numBytes</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Queries simulation GPU memory usage.<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>grid</em> </td><td>The grid to query for memory usage. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>numBytes</em> </td><td>GPU memory allocated in bytes. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g267df90efdb2feb7a776d4b37a86ae27"></a><!-- doxytag: member="NvFlow.h::NvFlowGridParamsDefaults" ref="g267df90efdb2feb7a776d4b37a86ae27" args="(NvFlowGridParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridParamsDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_grid_params.html">NvFlowGridParams</a> * </td> + <td class="paramname"> <em>params</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allows the application to request default grid parameters from Flow.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>params</em> </td><td>The parameters for Flow to fill out. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g2588127b567fa3cf4221a5735a389455"></a><!-- doxytag: member="NvFlow.h::NvFlowGridQuerySupport" ref="g2588127b567fa3cf4221a5735a389455" args="(NvFlowGrid *grid, NvFlowContext *context, NvFlowSupport *support)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_nv_flow_types_8h.html#aff66c8a98e5ec3fa740bfeeb7361267">NvFlowResult</a> NvFlowGridQuerySupport </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</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"><a class="el" href="struct_nv_flow_support.html">NvFlowSupport</a> * </td> + <td class="paramname"> <em>support</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Queries support for features that depend on hardware/OS.<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>grid</em> </td><td>The grid to query for support. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context the grid was created against. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>support</em> </td><td>Description of what is supported.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns eNvFlowSuccess if information is available. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gae6709cf94fc97676ed16d03b7b28439"></a><!-- doxytag: member="NvFlow.h::NvFlowGridQueryTime" ref="gae6709cf94fc97676ed16d03b7b28439" args="(NvFlowGrid *grid, NvFlowQueryTime *gpuTime, NvFlowQueryTime *cpuTime)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_nv_flow_types_8h.html#aff66c8a98e5ec3fa740bfeeb7361267">NvFlowResult</a> NvFlowGridQueryTime </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_nv_flow_query_time.html">NvFlowQueryTime</a> * </td> + <td class="paramname"> <em>gpuTime</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_nv_flow_query_time.html">NvFlowQueryTime</a> * </td> + <td class="paramname"> <em>cpuTime</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Queries simulation timing data.<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>grid</em> </td><td>The grid to query for timing. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>gpuTime</em> </td><td>Simulation overhead on GPU. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>cpuTime</em> </td><td>Simulation overhead on CPU.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns eNvFlowSuccess if information is available. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gb156d6c13bb4a9cd5561c599011f6f20"></a><!-- doxytag: member="NvFlow.h::NvFlowGridReset" ref="gb156d6c13bb4a9cd5561c599011f6f20" args="(NvFlowGrid *grid, const NvFlowGridResetDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridReset </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_reset_desc.html">NvFlowGridResetDesc</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> +Submits a request to reset a grid, preserving memory allocations<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>grid</em> </td><td>The grid to reset. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>The grid reset description. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g16acf6756cb77975b5444116a56c612d"></a><!-- doxytag: member="NvFlow.h::NvFlowGridResetDescDefaults" ref="g16acf6756cb77975b5444116a56c612d" args="(NvFlowGridResetDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridResetDescDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_grid_reset_desc.html">NvFlowGridResetDesc</a> * </td> + <td class="paramname"> <em>desc</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allows the application to request a default grid reset description from Flow.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>desc</em> </td><td>The description for Flow to fill out. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g3c5067eeb166f2c5d43aa707694ff48d"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSetParams" ref="g3c5067eeb166f2c5d43aa707694ff48d" args="(NvFlowGrid *grid, const NvFlowGridParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSetParams </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_params.html">NvFlowGridParams</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> +Sets grid simulation parameters, persistent over multiple grid updates.<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>grid</em> </td><td>The grid to set parameters on. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>The new parameter values. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g6c2125dbb24e274634393a6425cffd7d"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSetTargetLocation" ref="g6c2125dbb24e274634393a6425cffd7d" args="(NvFlowGrid *grid, NvFlowFloat3 targetLocation)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSetTargetLocation </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_nv_flow_float3.html">NvFlowFloat3</a> </td> + <td class="paramname"> <em>targetLocation</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Not fully supported yet. Allows the application to request the grid move to a new location.<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>grid</em> </td><td>The grid to move. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>targetLocation</em> </td><td>The location the center of the grid should make a best effort attempt to reach. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g82ef210f6393ee69d3b52a69aa23c910"></a><!-- doxytag: member="NvFlow.h::NvFlowGridUpdate" ref="g82ef210f6393ee69d3b52a69aa23c910" args="(NvFlowGrid *grid, NvFlowContext *context, float dt)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridUpdate </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</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">float </td> + <td class="paramname"> <em>dt</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Steps the simulation dt forward in time.<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>grid</em> </td><td>The grid to update. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context to perform the update. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dt</em> </td><td>The time step, typically in seconds. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="gce43153a6206c8f1e095aad7276469d2"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseGrid" ref="gce43153a6206c8f1e095aad7276469d2" args="(NvFlowGrid *grid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseGrid </td> + <td>(</td> + <td class="paramtype">NvFlowGrid * </td> + <td class="paramname"> <em>grid</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a grid.<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>grid</em> </td><td>The grid 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> |