diff options
Diffstat (limited to 'docs/api/files/group___nv_flow_cross_section.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_cross_section.html | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_cross_section.html b/docs/api/files/group___nv_flow_cross_section.html new file mode 100644 index 0000000..4d72ae5 --- /dev/null +++ b/docs/api/files/group___nv_flow_cross_section.html @@ -0,0 +1,184 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.0 API Reference: NvFlowCrossSection</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>NvFlowCrossSection</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_cross_section_desc.html">NvFlowCrossSectionDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description required to create cross section object. <a href="struct_nv_flow_cross_section_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_cross_section_params.html">NvFlowCrossSectionParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters needed to render cross section. <a href="struct_nv_flow_cross_section_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">NvFlowCrossSection * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_cross_section.html#g01e77a679f29b771439274d9e818fa1b">NvFlowCreateCrossSection</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_cross_section_desc.html">NvFlowCrossSectionDesc</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_cross_section.html#gfe60238065d87bf15cf6aff8fa2a6255">NvFlowCrossSectionParamsDefaults</a> (<a class="el" href="struct_nv_flow_cross_section_params.html">NvFlowCrossSectionParams</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_cross_section.html#g697fd0442e285c25388297167ffdbf5d">NvFlowCrossSectionRender</a> (NvFlowCrossSection *crossSection, NvFlowContext *context, const <a class="el" href="struct_nv_flow_cross_section_params.html">NvFlowCrossSectionParams</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_cross_section.html#g04c8de7d399c30d18c67c6c809b85f12">NvFlowReleaseCrossSection</a> (NvFlowCrossSection *crossSection)</td></tr> + +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g01e77a679f29b771439274d9e818fa1b"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateCrossSection" ref="g01e77a679f29b771439274d9e818fa1b" args="(NvFlowContext *context, const NvFlowCrossSectionDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowCrossSection* NvFlowCreateCrossSection </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_cross_section_desc.html">NvFlowCrossSectionDesc</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 cross section 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 for GPU resource allocation. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>desc</em> </td><td>Description for memory allocation.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created cross section object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gfe60238065d87bf15cf6aff8fa2a6255"></a><!-- doxytag: member="NvFlow.h::NvFlowCrossSectionParamsDefaults" ref="gfe60238065d87bf15cf6aff8fa2a6255" args="(NvFlowCrossSectionParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowCrossSectionParamsDefaults </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_nv_flow_cross_section_params.html">NvFlowCrossSectionParams</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 cross section 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="g697fd0442e285c25388297167ffdbf5d"></a><!-- doxytag: member="NvFlow.h::NvFlowCrossSectionRender" ref="g697fd0442e285c25388297167ffdbf5d" args="(NvFlowCrossSection *crossSection, NvFlowContext *context, const NvFlowCrossSectionParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowCrossSectionRender </td> + <td>(</td> + <td class="paramtype">NvFlowCrossSection * </td> + <td class="paramname"> <em>crossSection</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_cross_section_params.html">NvFlowCrossSectionParams</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> +Renders a cross section of a grid export.<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>crossSection</em> </td><td>The cross section object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context that allocated the cross section object. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters for cross section rendering. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g04c8de7d399c30d18c67c6c809b85f12"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseCrossSection" ref="g04c8de7d399c30d18c67c6c809b85f12" args="(NvFlowCrossSection *crossSection)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseCrossSection </td> + <td>(</td> + <td class="paramtype">NvFlowCrossSection * </td> + <td class="paramname"> <em>crossSection</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a cross section 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>crossSection</em> </td><td>The cross section 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> |