diff options
Diffstat (limited to 'docs/api/files/group___nv_flow_shape.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_shape.html | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_shape.html b/docs/api/files/group___nv_flow_shape.html new file mode 100644 index 0000000..7d38520 --- /dev/null +++ b/docs/api/files/group___nv_flow_shape.html @@ -0,0 +1,317 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowShape</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>NvFlowShape</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">union </td><td class="memItemRight" valign="bottom"><a class="el" href="union_nv_flow_shape_desc.html">NvFlowShapeDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shared type for shape descriptions. <a href="union_nv_flow_shape_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_shape_desc_box.html">NvFlowShapeDescBox</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of a box. <a href="struct_nv_flow_shape_desc_box.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_shape_desc_capsule.html">NvFlowShapeDescCapsule</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of a capsule. <a href="struct_nv_flow_shape_desc_capsule.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_shape_desc_plane.html">NvFlowShapeDescPlane</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of a plane. <a href="struct_nv_flow_shape_desc_plane.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_shape_desc_s_d_f.html">NvFlowShapeDescSDF</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of a signed distance field shape. <a href="struct_nv_flow_shape_desc_s_d_f.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_shape_desc_sphere.html">NvFlowShapeDescSphere</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Desription of a sphere. <a href="struct_nv_flow_shape_desc_sphere.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_shape_s_d_f_data.html">NvFlowShapeSDFData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Required information for writing to a CPU mapped signed distance field. <a href="struct_nv_flow_shape_s_d_f_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_shape_s_d_f_desc.html">NvFlowShapeSDFDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description required to create a signed distance field object. <a href="struct_nv_flow_shape_s_d_f_desc.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_shape.html#g463cc4d47b761fcac664190593845434">NvFlowShapeType</a> { <br> + <a class="el" href="group___nv_flow_shape.html#gg463cc4d47b761fcac6641905938454346347fe66fb723fc400d697dbcc3536b0">eNvFlowShapeTypeSDF</a> = 0, +<a class="el" href="group___nv_flow_shape.html#gg463cc4d47b761fcac664190593845434613acee6f4a290fbe71e4d68069bd941">eNvFlowShapeTypeSphere</a> = 1, +<a class="el" href="group___nv_flow_shape.html#gg463cc4d47b761fcac6641905938454340eb05c3a341a4d899f8f752e0a313036">eNvFlowShapeTypeBox</a> = 2, +<a class="el" href="group___nv_flow_shape.html#gg463cc4d47b761fcac664190593845434af5230e3034d0aacf869ce466b68d999">eNvFlowShapeTypeCapsule</a> = 3, +<br> + <a class="el" href="group___nv_flow_shape.html#gg463cc4d47b761fcac6641905938454348bcd988e4936637e3db8ae86b8f93e1f">eNvFlowShapeTypePlane</a> = 4 +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Types of shapes for emit/collide behavior. <a href="group___nv_flow_shape.html#g463cc4d47b761fcac664190593845434">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowShapeSDF * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_shape.html#g70fdfc0c12191ca9021680b3acd8db9f">NvFlowCreateShapeSDF</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_shape_s_d_f_desc.html">NvFlowShapeSDFDesc</a> *desc)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowShapeSDF * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_shape.html#g00c7d783cbb474a2ed6b8b424a657697">NvFlowCreateShapeSDFFromTexture3D</a> (NvFlowContext *context, NvFlowTexture3D *texture)</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_shape.html#g5331956d51d61f55ee5147bef2eb993c">NvFlowReleaseShapeSDF</a> (NvFlowShapeSDF *shape)</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_shape.html#gda661689e449ded027828bf7c01085cb">NvFlowShapeSDFDescDefaults</a> (<a class="el" href="struct_nv_flow_shape_s_d_f_desc.html">NvFlowShapeSDFDesc</a> *desc)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_nv_flow_shape_s_d_f_data.html">NvFlowShapeSDFData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_shape.html#g93ffdb10ed63fcbaeabbe56da9241f42">NvFlowShapeSDFMap</a> (NvFlowShapeSDF *shape, 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_shape.html#g7ea7231d8170803230f086f53af26fbb">NvFlowShapeSDFUnmap</a> (NvFlowShapeSDF *shape, NvFlowContext *context)</td></tr> + +</table> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="g463cc4d47b761fcac664190593845434"></a><!-- doxytag: member="NvFlow.h::NvFlowShapeType" ref="g463cc4d47b761fcac664190593845434" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="group___nv_flow_shape.html#g463cc4d47b761fcac664190593845434">NvFlowShapeType</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Types of shapes for emit/collide behavior. +<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="gg463cc4d47b761fcac6641905938454346347fe66fb723fc400d697dbcc3536b0"></a><!-- doxytag: member="eNvFlowShapeTypeSDF" ref="gg463cc4d47b761fcac6641905938454346347fe66fb723fc400d697dbcc3536b0" args="" -->eNvFlowShapeTypeSDF</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg463cc4d47b761fcac664190593845434613acee6f4a290fbe71e4d68069bd941"></a><!-- doxytag: member="eNvFlowShapeTypeSphere" ref="gg463cc4d47b761fcac664190593845434613acee6f4a290fbe71e4d68069bd941" args="" -->eNvFlowShapeTypeSphere</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg463cc4d47b761fcac6641905938454340eb05c3a341a4d899f8f752e0a313036"></a><!-- doxytag: member="eNvFlowShapeTypeBox" ref="gg463cc4d47b761fcac6641905938454340eb05c3a341a4d899f8f752e0a313036" args="" -->eNvFlowShapeTypeBox</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg463cc4d47b761fcac664190593845434af5230e3034d0aacf869ce466b68d999"></a><!-- doxytag: member="eNvFlowShapeTypeCapsule" ref="gg463cc4d47b761fcac664190593845434af5230e3034d0aacf869ce466b68d999" args="" -->eNvFlowShapeTypeCapsule</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="gg463cc4d47b761fcac6641905938454348bcd988e4936637e3db8ae86b8f93e1f"></a><!-- doxytag: member="eNvFlowShapeTypePlane" ref="gg463cc4d47b761fcac6641905938454348bcd988e4936637e3db8ae86b8f93e1f" args="" -->eNvFlowShapeTypePlane</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g70fdfc0c12191ca9021680b3acd8db9f"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateShapeSDF" ref="g70fdfc0c12191ca9021680b3acd8db9f" args="(NvFlowContext *context, const NvFlowShapeSDFDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowShapeSDF* NvFlowCreateShapeSDF </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_shape_s_d_f_desc.html">NvFlowShapeSDFDesc</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 signed distance field object with no initial 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>context</em> </td><td>The context to use for creation. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>A description needed for memory allocation.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created signed distance field object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g00c7d783cbb474a2ed6b8b424a657697"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateShapeSDFFromTexture3D" ref="g00c7d783cbb474a2ed6b8b424a657697" args="(NvFlowContext *context, NvFlowTexture3D *texture)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowShapeSDF* NvFlowCreateShapeSDFFromTexture3D </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">NvFlowTexture3D * </td> + <td class="paramname"> <em>texture</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 signed distance field object with data from a 3D texture.<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 for creation. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>texture</em> </td><td>The 3D texture containing the signed distance field to use.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created signed distance field object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g5331956d51d61f55ee5147bef2eb993c"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseShapeSDF" ref="g5331956d51d61f55ee5147bef2eb993c" args="(NvFlowShapeSDF *shape)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseShapeSDF </td> + <td>(</td> + <td class="paramtype">NvFlowShapeSDF * </td> + <td class="paramname"> <em>shape</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a signed distance field 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>shape</em> </td><td>The signed distance field to be released. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="gda661689e449ded027828bf7c01085cb"></a><!-- doxytag: member="NvFlow.h::NvFlowShapeSDFDescDefaults" ref="gda661689e449ded027828bf7c01085cb" args="(NvFlowShapeSDFDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowShapeSDFDescDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_shape_s_d_f_desc.html">NvFlowShapeSDFDesc</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 signed distance field object 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="g93ffdb10ed63fcbaeabbe56da9241f42"></a><!-- doxytag: member="NvFlow.h::NvFlowShapeSDFMap" ref="g93ffdb10ed63fcbaeabbe56da9241f42" args="(NvFlowShapeSDF *shape, NvFlowContext *context)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_nv_flow_shape_s_d_f_data.html">NvFlowShapeSDFData</a> NvFlowShapeSDFMap </td> + <td>(</td> + <td class="paramtype">NvFlowShapeSDF * </td> + <td class="paramname"> <em>shape</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> +Maps a signed distance field object for CPU write access.<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>shape</em> </td><td>The signed distance field object to map. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the Flow signed distance field.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the information needed to properly write to the mapped signed distance field object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g7ea7231d8170803230f086f53af26fbb"></a><!-- doxytag: member="NvFlow.h::NvFlowShapeSDFUnmap" ref="g7ea7231d8170803230f086f53af26fbb" args="(NvFlowShapeSDF *shape, NvFlowContext *context)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowShapeSDFUnmap </td> + <td>(</td> + <td class="paramtype">NvFlowShapeSDF * </td> + <td class="paramname"> <em>shape</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> +Unmaps a signed distance field object from CPU write access, uploads update field to 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>shape</em> </td><td>The signed distance field object to unmap. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context used to create the Flow signed distance field. </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> |