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_particle_surface.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_particle_surface.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_particle_surface.html | 409 |
1 files changed, 409 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_particle_surface.html b/docs/api/files/group___nv_flow_particle_surface.html new file mode 100644 index 0000000..a295df9 --- /dev/null +++ b/docs/api/files/group___nv_flow_particle_surface.html @@ -0,0 +1,409 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowParticleSurface</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>NvFlowParticleSurface</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_particle_surface_data.html">NvFlowParticleSurfaceData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle data. <a href="struct_nv_flow_particle_surface_data.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_particle_surface_desc.html">NvFlowParticleSurfaceDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description for creation. <a href="struct_nv_flow_particle_surface_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_particle_surface_emit_params.html">NvFlowParticleSurfaceEmitParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameter for surface emission. <a href="struct_nv_flow_particle_surface_emit_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_particle_surface_params.html">NvFlowParticleSurfaceParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters for update. <a href="struct_nv_flow_particle_surface_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">NvFlowParticleSurface * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_particle_surface.html#gde566e659c3040ba84e871ba90a51e67">NvFlowCreateParticleSurface</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_particle_surface_desc.html">NvFlowParticleSurfaceDesc</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_particle_surface.html#gb784a11fe38b2090d2daf9e4a34182f0">NvFlowParticleSurfaceAllocFunc</a> (NvFlowParticleSurface *surface, NvFlowContext *context, const <a class="el" href="struct_nv_flow_grid_emit_custom_alloc_params.html">NvFlowGridEmitCustomAllocParams</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_particle_surface.html#g1d307fd65e119d6c6e895dc50ae8f0a6">NvFlowParticleSurfaceDebugGridExport</a> (NvFlowParticleSurface *surface, 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_particle_surface.html#g2c7368c745591989afb0bb0dcfb29542">NvFlowParticleSurfaceEmitDensityFunc</a> (NvFlowParticleSurface *surface, NvFlowContext *context, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> *dataFrontIdx, const <a class="el" href="struct_nv_flow_grid_emit_custom_emit_params.html">NvFlowGridEmitCustomEmitParams</a> *params, const <a class="el" href="struct_nv_flow_particle_surface_emit_params.html">NvFlowParticleSurfaceEmitParams</a> *emitParams)</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_particle_surface.html#g3d4fed08e9776585468db15351f702b6">NvFlowParticleSurfaceEmitVelocityFunc</a> (NvFlowParticleSurface *surface, NvFlowContext *context, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> *dataFrontIdx, const <a class="el" href="struct_nv_flow_grid_emit_custom_emit_params.html">NvFlowGridEmitCustomEmitParams</a> *params, const <a class="el" href="struct_nv_flow_particle_surface_emit_params.html">NvFlowParticleSurfaceEmitParams</a> *emitParams)</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_particle_surface.html#ga7ec21650ddb67a9e492f0720660b0fa">NvFlowParticleSurfaceUpdateParticles</a> (NvFlowParticleSurface *surface, NvFlowContext *context, const <a class="el" href="struct_nv_flow_particle_surface_data.html">NvFlowParticleSurfaceData</a> *data)</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_particle_surface.html#ge0e2f98b4b476b1cb5ceb525aa5474c6">NvFlowParticleSurfaceUpdateSurface</a> (NvFlowParticleSurface *surface, NvFlowContext *context, const <a class="el" href="struct_nv_flow_particle_surface_params.html">NvFlowParticleSurfaceParams</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_particle_surface.html#g4b1cd9056f8bd8f9a8376190bcdc8069">NvFlowReleaseParticleSurface</a> (NvFlowParticleSurface *surface)</td></tr> + +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="gde566e659c3040ba84e871ba90a51e67"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateParticleSurface" ref="gde566e659c3040ba84e871ba90a51e67" args="(NvFlowContext *context, const NvFlowParticleSurfaceDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowParticleSurface* NvFlowCreateParticleSurface </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_particle_surface_desc.html">NvFlowParticleSurfaceDesc</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> +Create a particle surface object.<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 particle surface. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>Description required to create particle surface object.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns created particle surface object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gb784a11fe38b2090d2daf9e4a34182f0"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceAllocFunc" ref="gb784a11fe38b2090d2daf9e4a34182f0" args="(NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowGridEmitCustomAllocParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowParticleSurfaceAllocFunc </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</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">const <a class="el" href="struct_nv_flow_grid_emit_custom_alloc_params.html">NvFlowGridEmitCustomAllocParams</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> +Apply particle surface allocation to 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>surface</em> </td><td>The particle surface object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface and the grid. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for grid custom allocation callback. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g1d307fd65e119d6c6e895dc50ae8f0a6"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceDebugGridExport" ref="g1d307fd65e119d6c6e895dc50ae8f0a6" args="(NvFlowParticleSurface *surface, NvFlowContext *context)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridExport* NvFlowParticleSurfaceDebugGridExport </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">NvFlowContext * </td> + <td class="paramname"> <em>context</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get grid export that can be ray marched to visualize the generated particle surface/volume.<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>surface</em> </td><td>The particle surface object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the grid export. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g2c7368c745591989afb0bb0dcfb29542"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceEmitDensityFunc" ref="g2c7368c745591989afb0bb0dcfb29542" args="(NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowParticleSurfaceEmitDensityFunc </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</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="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> * </td> + <td class="paramname"> <em>dataFrontIdx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_emit_custom_emit_params.html">NvFlowGridEmitCustomEmitParams</a> * </td> + <td class="paramname"> <em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_particle_surface_emit_params.html">NvFlowParticleSurfaceEmitParams</a> * </td> + <td class="paramname"> <em>emitParams</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Apply particle surface emit operation to grid density texture channel.<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>surface</em> </td><td>The particle surface object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface and the grid. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dataFrontIdx</em> </td><td>Pointer to front data index. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for grid custom emit callback. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>emitParams</em> </td><td>Parameters to control surface emit behavior. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g3d4fed08e9776585468db15351f702b6"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceEmitVelocityFunc" ref="g3d4fed08e9776585468db15351f702b6" args="(NvFlowParticleSurface *surface, NvFlowContext *context, NvFlowUint *dataFrontIdx, const NvFlowGridEmitCustomEmitParams *params, const NvFlowParticleSurfaceEmitParams *emitParams)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowParticleSurfaceEmitVelocityFunc </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</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="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> * </td> + <td class="paramname"> <em>dataFrontIdx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_grid_emit_custom_emit_params.html">NvFlowGridEmitCustomEmitParams</a> * </td> + <td class="paramname"> <em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="struct_nv_flow_particle_surface_emit_params.html">NvFlowParticleSurfaceEmitParams</a> * </td> + <td class="paramname"> <em>emitParams</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Apply particle surface emit operation to grid velocity texture channel.<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>surface</em> </td><td>The particle surface object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface and the grid. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dataFrontIdx</em> </td><td>Pointer to front data index. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for grid custom emit callback. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>emitParams</em> </td><td>Parameters to control surface emit behavior. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ga7ec21650ddb67a9e492f0720660b0fa"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceUpdateParticles" ref="ga7ec21650ddb67a9e492f0720660b0fa" args="(NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceData *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowParticleSurfaceUpdateParticles </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</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">const <a class="el" href="struct_nv_flow_particle_surface_data.html">NvFlowParticleSurfaceData</a> * </td> + <td class="paramname"> <em>data</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Update particle data for particle surface.<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>surface</em> </td><td>The particle surface to update. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>data</em> </td><td>Particle data. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ge0e2f98b4b476b1cb5ceb525aa5474c6"></a><!-- doxytag: member="NvFlow.h::NvFlowParticleSurfaceUpdateSurface" ref="ge0e2f98b4b476b1cb5ceb525aa5474c6" args="(NvFlowParticleSurface *surface, NvFlowContext *context, const NvFlowParticleSurfaceParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowParticleSurfaceUpdateSurface </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</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">const <a class="el" href="struct_nv_flow_particle_surface_params.html">NvFlowParticleSurfaceParams</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> +Generate surface using the latest particle 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>surface</em> </td><td>The particle surface to update. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the particle surface. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for surface generation. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g4b1cd9056f8bd8f9a8376190bcdc8069"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseParticleSurface" ref="g4b1cd9056f8bd8f9a8376190bcdc8069" args="(NvFlowParticleSurface *surface)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseParticleSurface </td> + <td>(</td> + <td class="paramtype">NvFlowParticleSurface * </td> + <td class="paramname"> <em>surface</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a particle surface object.<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>surface</em> </td><td>The particle surface object 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> |