NvFlowRenderMaterial

Data Structures
struct	NvFlowColorMapData
	Required information for writing to a CPU mapped color map. More...
struct	NvFlowRenderMaterialHandle
	A handle to a volume render material. More...
struct	NvFlowRenderMaterialParams
	Per material parameters for Flow grid rendering. More...
struct	NvFlowRenderMaterialPoolDesc
	Description necessary to create render material. More...
Enumerations
enum	NvFlowVolumeRenderMode {   eNvFlowVolumeRenderMode_colormap = 0, eNvFlowVolumeRenderMode_raw = 1, eNvFlowVolumeRenderMode_rainbow = 2, eNvFlowVolumeRenderMode_debug = 3,   eNvFlowVolumeRenderModeCount }
	Render modes. More...
Functions
NvFlowRenderMaterialHandle	NvFlowCreateRenderMaterial (NvFlowContext *context, NvFlowRenderMaterialPool *pool, const NvFlowRenderMaterialParams *params)
NvFlowRenderMaterialPool *	NvFlowCreateRenderMaterialPool (NvFlowContext *context, const NvFlowRenderMaterialPoolDesc *desc)
NvFlowRenderMaterialHandle	NvFlowGetDefaultRenderMaterial (NvFlowRenderMaterialPool *pool)
void	NvFlowReleaseRenderMaterial (NvFlowRenderMaterialHandle handle)
void	NvFlowReleaseRenderMaterialPool (NvFlowRenderMaterialPool *pool)
NvFlowColorMapData	NvFlowRenderMaterialColorMap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void	NvFlowRenderMaterialColorUnmap (NvFlowContext *context, NvFlowRenderMaterialHandle handle)
void	NvFlowRenderMaterialParamsDefaults (NvFlowRenderMaterialParams *params)
void	NvFlowRenderMaterialUpdate (NvFlowRenderMaterialHandle handle, const NvFlowRenderMaterialParams *params)

---

Enumeration Type Documentation

enum NvFlowVolumeRenderMode

Render modes.

Enumerator:

eNvFlowVolumeRenderMode_colormap	Uses color map defined in render material.
eNvFlowVolumeRenderMode_raw	Treats sampled value as RGBA.
eNvFlowVolumeRenderMode_rainbow	Visualizes single component with rainbow color, good for density visualization.
eNvFlowVolumeRenderMode_debug	Visualizes xyz components with color, good for velocity visualization.
eNvFlowVolumeRenderModeCount

---

Function Documentation

NvFlowRenderMaterialHandle NvFlowCreateRenderMaterial	(	NvFlowContext *	context,
		NvFlowRenderMaterialPool *	pool,
		const NvFlowRenderMaterialParams *	params
	)

Create a render material.

Parameters:

[in]	context	The context to use for GPU resource creation.
[in]	pool	The pool to create/own the material.
[in]	params	Material parameters.

Returns:

Returns a handle to the material.

NvFlowRenderMaterialPool* NvFlowCreateRenderMaterialPool	(	NvFlowContext *	context,
		const NvFlowRenderMaterialPoolDesc *	desc
	)

Creates a render material pool object.

Parameters:

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

Returns:

The created volume render object.

NvFlowRenderMaterialHandle NvFlowGetDefaultRenderMaterial

(

NvFlowRenderMaterialPool *

pool

)

Get the default render material.

Parameters:

[in]

pool

The pool to create/own the material.

Returns:

Returns a handle to the default material.

void NvFlowReleaseRenderMaterial

(

NvFlowRenderMaterialHandle

handle

)

Release a render material.

Parameters:

[in]

handle

Handle to the material to release.

void NvFlowReleaseRenderMaterialPool

(

NvFlowRenderMaterialPool *

pool

)

Releases a volume render object.

Parameters:

[in]

pool

The volume render object to be released.

NvFlowColorMapData NvFlowRenderMaterialColorMap	(	NvFlowContext *	context,
		NvFlowRenderMaterialHandle	handle
	)

Map the color map associated with the material for write access.

Parameters:

[in]	context	The context to use for mapping.
[in]	handle	Handle to the material to map.

Returns:

Returns a pointer and range of CPU memory for write access.

void NvFlowRenderMaterialColorUnmap	(	NvFlowContext *	context,
		NvFlowRenderMaterialHandle	handle
	)

Unmap the color map associated with the material.

Parameters:

[in]	context	The context to perform unmap.
[in]	handle	Handle to the material to unmap.

void NvFlowRenderMaterialParamsDefaults

(

NvFlowRenderMaterialParams *

params

)

Allows the application to request default volume render material parameters from Flow.

Parameters:

[out]

params

The parameters for Flow to fill out.

void NvFlowRenderMaterialUpdate	(	NvFlowRenderMaterialHandle	handle,
		const NvFlowRenderMaterialParams *	params
	)

Update a render material.

Parameters:

[in]	handle	Handle to the material to update.
[in]	params	Material parameters.