NvFlowGridSummary


Data Structures
struct	NvFlowGridSummaryDebugRenderParams
	Parameters to debug render the grid summary data. More...
struct	NvFlowGridSummaryDesc
	Description necessary to create grid summary. More...
struct	NvFlowGridSummaryResult
	Summary results. More...
struct	NvFlowGridSummaryUpdateParams
	Parameters required to update summary CPU state. More...
Functions
NvFlowGridSummary *	NvFlowCreateGridSummary (NvFlowContext context, const NvFlowGridSummaryDesc desc)
NvFlowGridSummaryStateCPU *	NvFlowCreateGridSummaryStateCPU (NvFlowGridSummary *gridSummary)
void	NvFlowGridSummaryDebugRender (NvFlowGridSummary gridSummary, NvFlowContext context, const NvFlowGridSummaryDebugRenderParams *params)
NvFlowGridMaterialHandle	NvFlowGridSummaryGetLayerMaterial (NvFlowGridSummaryStateCPU *stateCPU, NvFlowUint layerIdx)
NvFlowUint	NvFlowGridSummaryGetNumLayers (NvFlowGridSummaryStateCPU *stateCPU)
void	NvFlowGridSummaryGetSummaries (NvFlowGridSummaryStateCPU stateCPU, NvFlowGridSummaryResult results, NvFlowUint numResults, NvFlowUint layerIdx)
void	NvFlowGridSummaryUpdate (NvFlowGridSummary gridSummary, NvFlowContext context, const NvFlowGridSummaryUpdateParams *params)
void	NvFlowReleaseGridSummary (NvFlowGridSummary *gridSummary)
void	NvFlowReleaseGridSummaryStateCPU (NvFlowGridSummaryStateCPU *stateCPU)

Function Documentation

NvFlowGridSummary* NvFlowCreateGridSummary	(	NvFlowContext *	context,
		const NvFlowGridSummaryDesc *	desc
	)

Creates a grid summary object.

Parameters:

`[in]`	context	The context for GPU resource allocation.
`[in]`	desc	Description for memory allocation.

NvFlowGridSummaryStateCPU* NvFlowCreateGridSummaryStateCPU ( NvFlowGridSummary * gridSummary )

Creates a grid summary CPU state object.

Parameters:

[in] gridSummary The grid summary this CPU state will hold data from.

void NvFlowGridSummaryDebugRender	(	NvFlowGridSummary *	gridSummary,
		NvFlowContext *	context,
		const NvFlowGridSummaryDebugRenderParams *	params
	)

Renders a visualization of the specified stateCPU.

Parameters:

`[in]`	gridSummary	The grid summary operator to perform the debug render.
`[in]`	context	The render context.
`[in]`	params	Parameters required to render the CPU state.

NvFlowGridMaterialHandle NvFlowGridSummaryGetLayerMaterial	(	NvFlowGridSummaryStateCPU *	stateCPU,
		NvFlowUint	layerIdx
	)

Returns grid material mapped to specied layerIdx.

Parameters:

`[in]`	stateCPU	The grid summary cpu state.
`[in]`	layerIdx	The layer index to get the material mapping of.

NvFlowUint NvFlowGridSummaryGetNumLayers ( NvFlowGridSummaryStateCPU * stateCPU )

Returns the number of layers for the grid summary. This establishes the maximum number of results for a given world location.

Parameters:

[in] stateCPU The grid summary cpu state.

void NvFlowGridSummaryGetSummaries	(	NvFlowGridSummaryStateCPU *	stateCPU,
		NvFlowGridSummaryResult **	results,
		NvFlowUint *	numResults,
		NvFlowUint	layerIdx
	)

Returns pointer to array of summary results for the specified layer.

Parameters:

`[in]`	stateCPU	The grid summary state to sample.
`[out]`	results	Pointer to array pointer.
`[out]`	numResults	Pointer to array size.
`[in]`	layerIdx	Layer index to return summary results array from.

void NvFlowGridSummaryUpdate	(	NvFlowGridSummary *	gridSummary,
		NvFlowContext *	context,
		const NvFlowGridSummaryUpdateParams *	params
	)

Updates the specified stateCPU with the latest available summary data.

Parameters:

`[in]`	gridSummary	The grid summary operator to perform the update.
`[in]`	context	The context the gridExport is valid on.
`[in]`	params	Parameters required to update CPU state.

void NvFlowReleaseGridSummary ( NvFlowGridSummary * gridSummary )

Releases a grid summary object.

Parameters:

[in] gridSummary The grid summary object to be released.

void NvFlowReleaseGridSummaryStateCPU ( NvFlowGridSummaryStateCPU * stateCPU )

Releases a grid summary CPU state object.

Parameters:

[in] stateCPU The grid summary CPU state object to be released.