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_material.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_material.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_grid_material.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_grid_material.html b/docs/api/files/group___nv_flow_grid_material.html new file mode 100644 index 0000000..c3ef9eb --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_material.html @@ -0,0 +1,270 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowGridMaterial</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>NvFlowGridMaterial</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_material_handle.html">NvFlowGridMaterialHandle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle provided by grid to reference materials. <a href="struct_nv_flow_grid_material_handle.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_material_params.html">NvFlowGridMaterialParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Grid material parameters. <a href="struct_nv_flow_grid_material_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_material_per_component.html">NvFlowGridMaterialPerComponent</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Grid material per component parameters. <a href="struct_nv_flow_grid_material_per_component.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_material.html#g26e274e86cb7c993d1bbe0f9abd989ae">NvFlowGridComponent</a> { <br> + <a class="el" href="group___nv_flow_grid_material.html#gg26e274e86cb7c993d1bbe0f9abd989ae499a1a1bdab238b9a7b9de6582b5e7ba">eNvFlowGridComponentVelocity</a> = 0, +<a class="el" href="group___nv_flow_grid_material.html#gg26e274e86cb7c993d1bbe0f9abd989ae2a9d377d95722efa118cec2d7dd96c16">eNvFlowGridComponentSmoke</a> = 1, +<a class="el" href="group___nv_flow_grid_material.html#gg26e274e86cb7c993d1bbe0f9abd989aed8a3516b3ce2ac3b203e32fec7047b26">eNvFlowGridComponentTemperature</a> = 2, +<a class="el" href="group___nv_flow_grid_material.html#gg26e274e86cb7c993d1bbe0f9abd989ae6123f3e829d1a2fa4a20af29a8e14efc">eNvFlowGridComponentFuel</a> = 3, +<br> + <a class="el" href="group___nv_flow_grid_material.html#gg26e274e86cb7c993d1bbe0f9abd989aefb3afe99f8e7f447a52c0e2b6e5c6214">eNvFlowGridNumComponents</a> = 4 +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Grid component IDs. <a href="group___nv_flow_grid_material.html#g26e274e86cb7c993d1bbe0f9abd989ae">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_material.html#g6468af3605351c6d5b0f67bb4281f37d">NvFlowGridCreateMaterial</a> (NvFlowGrid *grid, const <a class="el" href="struct_nv_flow_grid_material_params.html">NvFlowGridMaterialParams</a> *params)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_material.html#g9e20298d09600ef6949d847b9551bf5d">NvFlowGridGetDefaultMaterial</a> (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_material.html#g8effe109701f2bf167ff38ebf04e633b">NvFlowGridMaterialParamsDefaults</a> (<a class="el" href="struct_nv_flow_grid_material_params.html">NvFlowGridMaterialParams</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_material.html#gf76c4f299386693cd19aa55b41cda624">NvFlowGridReleaseMaterial</a> (NvFlowGrid *grid, <a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> material)</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_material.html#ga36f0b4bf3c99acfa24ddd6e0f05da20">NvFlowGridSetMaterialParams</a> (NvFlowGrid *grid, <a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> material, const <a class="el" href="struct_nv_flow_grid_material_params.html">NvFlowGridMaterialParams</a> *params)</td></tr> + +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="g26e274e86cb7c993d1bbe0f9abd989ae"></a><!-- doxytag: member="NvFlow.h::NvFlowGridComponent" ref="g26e274e86cb7c993d1bbe0f9abd989ae" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_grid_material.html#g26e274e86cb7c993d1bbe0f9abd989ae">NvFlowGridComponent</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Grid component IDs. +<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="gg26e274e86cb7c993d1bbe0f9abd989ae499a1a1bdab238b9a7b9de6582b5e7ba"></a><!-- doxytag: member="eNvFlowGridComponentVelocity" ref="gg26e274e86cb7c993d1bbe0f9abd989ae499a1a1bdab238b9a7b9de6582b5e7ba" args="" -->eNvFlowGridComponentVelocity</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg26e274e86cb7c993d1bbe0f9abd989ae2a9d377d95722efa118cec2d7dd96c16"></a><!-- doxytag: member="eNvFlowGridComponentSmoke" ref="gg26e274e86cb7c993d1bbe0f9abd989ae2a9d377d95722efa118cec2d7dd96c16" args="" -->eNvFlowGridComponentSmoke</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg26e274e86cb7c993d1bbe0f9abd989aed8a3516b3ce2ac3b203e32fec7047b26"></a><!-- doxytag: member="eNvFlowGridComponentTemperature" ref="gg26e274e86cb7c993d1bbe0f9abd989aed8a3516b3ce2ac3b203e32fec7047b26" args="" -->eNvFlowGridComponentTemperature</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg26e274e86cb7c993d1bbe0f9abd989ae6123f3e829d1a2fa4a20af29a8e14efc"></a><!-- doxytag: member="eNvFlowGridComponentFuel" ref="gg26e274e86cb7c993d1bbe0f9abd989ae6123f3e829d1a2fa4a20af29a8e14efc" args="" -->eNvFlowGridComponentFuel</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg26e274e86cb7c993d1bbe0f9abd989aefb3afe99f8e7f447a52c0e2b6e5c6214"></a><!-- doxytag: member="eNvFlowGridNumComponents" ref="gg26e274e86cb7c993d1bbe0f9abd989aefb3afe99f8e7f447a52c0e2b6e5c6214" args="" -->eNvFlowGridNumComponents</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g6468af3605351c6d5b0f67bb4281f37d"></a><!-- doxytag: member="NvFlow.h::NvFlowGridCreateMaterial" ref="g6468af3605351c6d5b0f67bb4281f37d" args="(NvFlowGrid *grid, const NvFlowGridMaterialParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> NvFlowGridCreateMaterial </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_material_params.html">NvFlowGridMaterialParams</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> +Creates new grid material, initializes to params.<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 Flow 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> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns handle to newly create grid material. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g9e20298d09600ef6949d847b9551bf5d"></a><!-- doxytag: member="NvFlow.h::NvFlowGridGetDefaultMaterial" ref="g9e20298d09600ef6949d847b9551bf5d" args="(NvFlowGrid *grid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_nv_flow_grid_material_handle.html">NvFlowGridMaterialHandle</a> NvFlowGridGetDefaultMaterial </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> +Gets a handle to the default grid material.<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 return its default grid material.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns default grid material for grid. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g8effe109701f2bf167ff38ebf04e633b"></a><!-- doxytag: member="NvFlow.h::NvFlowGridMaterialParamsDefaults" ref="g8effe109701f2bf167ff38ebf04e633b" args="(NvFlowGridMaterialParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridMaterialParamsDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_grid_material_params.html">NvFlowGridMaterialParams</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 material 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="gf76c4f299386693cd19aa55b41cda624"></a><!-- doxytag: member="NvFlow.h::NvFlowGridReleaseMaterial" ref="gf76c4f299386693cd19aa55b41cda624" args="(NvFlowGrid *grid, NvFlowGridMaterialHandle material)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridReleaseMaterial </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_grid_material_handle.html">NvFlowGridMaterialHandle</a> </td> + <td class="paramname"> <em>material</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Release grid material<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>material</em> </td><td>Handle to material to release. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ga36f0b4bf3c99acfa24ddd6e0f05da20"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSetMaterialParams" ref="ga36f0b4bf3c99acfa24ddd6e0f05da20" args="(NvFlowGrid *grid, NvFlowGridMaterialHandle material, const NvFlowGridMaterialParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSetMaterialParams </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_grid_material_handle.html">NvFlowGridMaterialHandle</a> </td> + <td class="paramname"> <em>material</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_material_params.html">NvFlowGridMaterialParams</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 material 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>material</em> </td><td>Handle to material to update. </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> +</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> |