diff options
Diffstat (limited to 'docs/api/files/group___nv_flow_grid_summary.html')
| -rw-r--r-- | docs/api/files/group___nv_flow_grid_summary.html | 384 |
1 files changed, 384 insertions, 0 deletions
diff --git a/docs/api/files/group___nv_flow_grid_summary.html b/docs/api/files/group___nv_flow_grid_summary.html new file mode 100644 index 0000000..84ac616 --- /dev/null +++ b/docs/api/files/group___nv_flow_grid_summary.html @@ -0,0 +1,384 @@ +<html> + <head> + <title>NVIDIA(R) Flow(R) 1.0.1 API Reference: NvFlowGridSummary</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>NvFlowGridSummary</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_summary_debug_render_params.html">NvFlowGridSummaryDebugRenderParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters to debug render the grid summary data. <a href="struct_nv_flow_grid_summary_debug_render_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_summary_desc.html">NvFlowGridSummaryDesc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Description necessary to create grid summary. <a href="struct_nv_flow_grid_summary_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_summary_result.html">NvFlowGridSummaryResult</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Summary results. <a href="struct_nv_flow_grid_summary_result.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_summary_update_params.html">NvFlowGridSummaryUpdateParams</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters required to update summary CPU state. <a href="struct_nv_flow_grid_summary_update_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">NvFlowGridSummary * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_summary.html#g35c662e82a1a5222f03b1b09095e2014">NvFlowCreateGridSummary</a> (NvFlowContext *context, const <a class="el" href="struct_nv_flow_grid_summary_desc.html">NvFlowGridSummaryDesc</a> *desc)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">NvFlowGridSummaryStateCPU * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_summary.html#g775d6b1cff54a74674db00a402c3b69e">NvFlowCreateGridSummaryStateCPU</a> (NvFlowGridSummary *gridSummary)</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_summary.html#g854cc478898075d60a446f16084acd61">NvFlowGridSummaryDebugRender</a> (NvFlowGridSummary *gridSummary, NvFlowContext *context, const <a class="el" href="struct_nv_flow_grid_summary_debug_render_params.html">NvFlowGridSummaryDebugRenderParams</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_summary.html#g3af5903a3ef8c581fb5de07d7f0b2199">NvFlowGridSummaryGetLayerMaterial</a> (NvFlowGridSummaryStateCPU *stateCPU, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> layerIdx)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___nv_flow_grid_summary.html#gd058f792d0b24a4bb45bc40841e1c005">NvFlowGridSummaryGetNumLayers</a> (NvFlowGridSummaryStateCPU *stateCPU)</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_summary.html#gff0c194b0b1b58a81754454da9e13fed">NvFlowGridSummaryGetSummaries</a> (NvFlowGridSummaryStateCPU *stateCPU, <a class="el" href="struct_nv_flow_grid_summary_result.html">NvFlowGridSummaryResult</a> **results, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> *numResults, <a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> layerIdx)</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_summary.html#g5d5c0f0676d02aa90c498ec95289a7c5">NvFlowGridSummaryUpdate</a> (NvFlowGridSummary *gridSummary, NvFlowContext *context, const <a class="el" href="struct_nv_flow_grid_summary_update_params.html">NvFlowGridSummaryUpdateParams</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_summary.html#g3bbb63e4c151359255bdf6edc7adbaa8">NvFlowReleaseGridSummary</a> (NvFlowGridSummary *gridSummary)</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_summary.html#ga3cb94df0f16a0cc7b5cd467c6e489b5">NvFlowReleaseGridSummaryStateCPU</a> (NvFlowGridSummaryStateCPU *stateCPU)</td></tr> + +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g35c662e82a1a5222f03b1b09095e2014"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateGridSummary" ref="g35c662e82a1a5222f03b1b09095e2014" args="(NvFlowContext *context, const NvFlowGridSummaryDesc *desc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridSummary* NvFlowCreateGridSummary </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_summary_desc.html">NvFlowGridSummaryDesc</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 summary 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 grid summary object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g775d6b1cff54a74674db00a402c3b69e"></a><!-- doxytag: member="NvFlow.h::NvFlowCreateGridSummaryStateCPU" ref="g775d6b1cff54a74674db00a402c3b69e" args="(NvFlowGridSummary *gridSummary)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NvFlowGridSummaryStateCPU* NvFlowCreateGridSummaryStateCPU </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummary * </td> + <td class="paramname"> <em>gridSummary</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a grid summary CPU state 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>gridSummary</em> </td><td>The grid summary this CPU state will hold data from.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The created grid summary CPU state object. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g854cc478898075d60a446f16084acd61"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSummaryDebugRender" ref="g854cc478898075d60a446f16084acd61" args="(NvFlowGridSummary *gridSummary, NvFlowContext *context, const NvFlowGridSummaryDebugRenderParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSummaryDebugRender </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummary * </td> + <td class="paramname"> <em>gridSummary</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_summary_debug_render_params.html">NvFlowGridSummaryDebugRenderParams</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 visualization of the specified stateCPU.<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>gridSummary</em> </td><td>The grid summary operator to perform the debug render. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The render context. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters required to render the CPU state. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g3af5903a3ef8c581fb5de07d7f0b2199"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSummaryGetLayerMaterial" ref="g3af5903a3ef8c581fb5de07d7f0b2199" args="(NvFlowGridSummaryStateCPU *stateCPU, NvFlowUint layerIdx)" --> +<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> NvFlowGridSummaryGetLayerMaterial </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummaryStateCPU * </td> + <td class="paramname"> <em>stateCPU</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>layerIdx</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns grid material mapped to specied layerIdx.<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>stateCPU</em> </td><td>The grid summary cpu state. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>layerIdx</em> </td><td>The layer index to get the material mapping of.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns grid material. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gd058f792d0b24a4bb45bc40841e1c005"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSummaryGetNumLayers" ref="gd058f792d0b24a4bb45bc40841e1c005" args="(NvFlowGridSummaryStateCPU *stateCPU)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_nv_flow_types_8h.html#3ecaefc2ddcf5a935631db32d05226b1">NvFlowUint</a> NvFlowGridSummaryGetNumLayers </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummaryStateCPU * </td> + <td class="paramname"> <em>stateCPU</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the number of layers for the grid summary. This establishes the maximum number of results for a given world 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>stateCPU</em> </td><td>The grid summary cpu state.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the number of layers. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gff0c194b0b1b58a81754454da9e13fed"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSummaryGetSummaries" ref="gff0c194b0b1b58a81754454da9e13fed" args="(NvFlowGridSummaryStateCPU *stateCPU, NvFlowGridSummaryResult **results, NvFlowUint *numResults, NvFlowUint layerIdx)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSummaryGetSummaries </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummaryStateCPU * </td> + <td class="paramname"> <em>stateCPU</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_nv_flow_grid_summary_result.html">NvFlowGridSummaryResult</a> ** </td> + <td class="paramname"> <em>results</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>numResults</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>layerIdx</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns pointer to array of summary results for the specified layer.<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>stateCPU</em> </td><td>The grid summary state to sample. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>results</em> </td><td>Pointer to array pointer. </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>numResults</em> </td><td>Pointer to array size. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>layerIdx</em> </td><td>Layer index to return summary results array from. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g5d5c0f0676d02aa90c498ec95289a7c5"></a><!-- doxytag: member="NvFlow.h::NvFlowGridSummaryUpdate" ref="g5d5c0f0676d02aa90c498ec95289a7c5" args="(NvFlowGridSummary *gridSummary, NvFlowContext *context, const NvFlowGridSummaryUpdateParams *params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowGridSummaryUpdate </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummary * </td> + <td class="paramname"> <em>gridSummary</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_summary_update_params.html">NvFlowGridSummaryUpdateParams</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> +Updates the specified stateCPU with the latest available summary 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>gridSummary</em> </td><td>The grid summary operator to perform the update. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>context</em> </td><td>The context the gridExport is valid on. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>params</em> </td><td>Parameters required to update CPU state. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g3bbb63e4c151359255bdf6edc7adbaa8"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseGridSummary" ref="g3bbb63e4c151359255bdf6edc7adbaa8" args="(NvFlowGridSummary *gridSummary)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseGridSummary </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummary * </td> + <td class="paramname"> <em>gridSummary</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a grid summary 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>gridSummary</em> </td><td>The grid summary object to be released. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ga3cb94df0f16a0cc7b5cd467c6e489b5"></a><!-- doxytag: member="NvFlow.h::NvFlowReleaseGridSummaryStateCPU" ref="ga3cb94df0f16a0cc7b5cd467c6e489b5" args="(NvFlowGridSummaryStateCPU *stateCPU)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void NvFlowReleaseGridSummaryStateCPU </td> + <td>(</td> + <td class="paramtype">NvFlowGridSummaryStateCPU * </td> + <td class="paramname"> <em>stateCPU</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases a grid summary CPU state 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>stateCPU</em> </td><td>The grid summary CPU state 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> |