NvFlowGridImport

Data Structures
struct	NvFlowGridImportDesc
	Description required to create GridImport. More...
struct	NvFlowGridImportHandle
	Texture channel handle. More...
struct	NvFlowGridImportLayeredView
	Description applying to all imported layers. More...
struct	NvFlowGridImportLayerView
	Description of a single imported layer. More...
struct	NvFlowGridImportParams
	Parameters for grabbing import view. More...
struct	NvFlowGridImportStateCPUParams
	Parameters for grabbing import view. More...
Enumerations
enum	NvFlowGridImportMode { eNvFlowGridImportModePoint = 0, eNvFlowGridImportModeLinear = 1 }
	Grid import modes. More...
Functions
NvFlowGridImport *	NvFlowCreateGridImport (NvFlowContext *context, const NvFlowGridImportDesc *desc)
NvFlowGridImportStateCPU *	NvFlowCreateGridImportStateCPU (NvFlowGridImport *gridImport)
NvFlowGridExport *	NvFlowGridImportGetGridExport (NvFlowGridImport *gridImport, NvFlowContext *context)
NvFlowGridImportHandle	NvFlowGridImportGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportParams *params)
void	NvFlowGridImportGetLayeredView (NvFlowGridImportHandle handle, NvFlowGridImportLayeredView *layeredView)
void	NvFlowGridImportGetLayerView (NvFlowGridImportHandle handle, NvFlowUint layerIdx, NvFlowGridImportLayerView *layerView)
void	NvFlowGridImportReleaseChannel (NvFlowGridImport *gridImport, NvFlowContext *context, NvFlowGridTextureChannel channel)
NvFlowGridImportHandle	NvFlowGridImportStateCPUGetHandle (NvFlowGridImport *gridImport, NvFlowContext *context, const NvFlowGridImportStateCPUParams *params)
void	NvFlowGridImportUpdateStateCPU (NvFlowGridImportStateCPU *stateCPU, NvFlowContext *context, NvFlowGridExport *gridExport)
void	NvFlowReleaseGridImport (NvFlowGridImport *gridImport)
void	NvFlowReleaseGridImportStateCPU (NvFlowGridImportStateCPU *stateCPU)

---

Enumeration Type Documentation

enum NvFlowGridImportMode

Grid import modes.

Enumerator:

eNvFlowGridImportModePoint	Non redundant write target, conversion possible for linear sampling.
eNvFlowGridImportModeLinear	Redundant write target, avoids conversion.

---

Function Documentation

NvFlowGridImport* NvFlowCreateGridImport	(	NvFlowContext *	context,
		const NvFlowGridImportDesc *	desc
	)

Create a standalone grid import.

Parameters:

[in]	context	The context to use to create the new grid import.
[in]	desc	Description required to create grid import.

Returns:

Returns new grid import.

NvFlowGridImportStateCPU* NvFlowCreateGridImportStateCPU

(

NvFlowGridImport *

gridImport

)

Create a grid import CPU state object.

Parameters:

[in]

gridImport

The grid import to create the CPU state against.

Returns:

Returns new grid import CPU state.

NvFlowGridExport* NvFlowGridImportGetGridExport	(	NvFlowGridImport *	gridImport,
		NvFlowContext *	context
	)

Get grid export for read access to grid import data.

Parameters:

[in]	gridImport	The grid import.
[in]	context	The context used to create the grid import.

Returns:

Returns grid export.

NvFlowGridImportHandle NvFlowGridImportGetHandle	(	NvFlowGridImport *	gridImport,
		NvFlowContext *	context,
		const NvFlowGridImportParams *	params
	)

Get import handle for the specified grid texture channel and import mode.

Parameters:

[in]	gridImport	The grid import.
[in]	context	The context used to create the grid import.
[in]	params	Parameters for import handle.

Returns:

Returns import handle.

void NvFlowGridImportGetLayeredView	(	NvFlowGridImportHandle	handle,
		NvFlowGridImportLayeredView *	layeredView
	)

Get layeredView data for specified importHandle.

Parameters:

[in]	handle	The grid import handle.
[out]	layeredView	Destination for layeredView data.

void NvFlowGridImportGetLayerView	(	NvFlowGridImportHandle	handle,
		NvFlowUint	layerIdx,
		NvFlowGridImportLayerView *	layerView
	)

Get layerView data for specified importHandle and layer index.

Parameters:

[in]	handle	The grid import handle.
[in]	layerIdx	The layer index to return the layerView of.
[out]	layerView	Destination for layerView data.

void NvFlowGridImportReleaseChannel	(	NvFlowGridImport *	gridImport,
		NvFlowContext *	context,
		NvFlowGridTextureChannel	channel
	)

Release grid texture channel for grid import, allowing for memory recycle.

Parameters:

[in]	gridImport	The grid import.
[in]	context	The context used to create the grid import.
[in]	channel	The grid texture channel to release.

NvFlowGridImportHandle NvFlowGridImportStateCPUGetHandle	(	NvFlowGridImport *	gridImport,
		NvFlowContext *	context,
		const NvFlowGridImportStateCPUParams *	params
	)

Get import handle, using previously captured CPU state to control configuration.

Parameters:

[in]	gridImport	The grid import.
[in]	context	The context used to create the grid import.
[in]	params	Parameters for import handle.

Returns:

Returns import handle.

void NvFlowGridImportUpdateStateCPU	(	NvFlowGridImportStateCPU *	stateCPU,
		NvFlowContext *	context,
		NvFlowGridExport *	gridExport
	)

Capture CPU state from the provided grid export.

Parameters:

[in]	stateCPU	The grid import CPU state to update.
[in]	context	The context used to create the grid export.
[in]	gridExport	The grid export to capture the CPU state of.

void NvFlowReleaseGridImport

(

NvFlowGridImport *

gridImport

)

Release a standalone grid import.

Parameters:

[in]

gridImport

The grid import to release.

void NvFlowReleaseGridImportStateCPU

(

NvFlowGridImportStateCPU *

stateCPU

)

Release a grid import CPU state object.

Parameters:

[in]

stateCPU

The grid import CPU state to release.