NvFlowVolumeRender


Data Structures

struct  NvFlowVolumeLightingParams
 Parameters for Flow grid lighting. More...
struct  NvFlowVolumeRenderDesc
 Description needed to a create a volume render object. More...
struct  NvFlowVolumeRenderLMSParams
 Parameters for VRWorks lens matched shading rendering. More...
struct  NvFlowVolumeRenderMultiResParams
 Parameters for VRWorks multires rendering. More...
struct  NvFlowVolumeRenderParams
 Parameters for Flow grid rendering. More...
struct  NvFlowVolumeRenderViewport
 Rendering viewport. More...

Enumerations

enum  NvFlowMultiResRayMarch {
  eNvFlowMultiResRayMarchDisabled = 0, eNvFlowMultiResRayMarch2x2 = 1, eNvFlowMultiResRayMarch4x4 = 2, eNvFlowMultiResRayMarch8x8 = 3,
  eNvFlowMultiResRayMarch16x16 = 4
}
 Multiple resolution options for offscreen ray march. More...
enum  NvFlowVolumeRenderDownsample { eNvFlowVolumeRenderDownsampleNone = 0, eNvFlowVolumeRenderDownsample2x2 = 1 }
 Downsample options for offscreen ray march. More...

Functions

NvFlowVolumeRender * NvFlowCreateVolumeRender (NvFlowContext *context, const NvFlowVolumeRenderDesc *desc)
void NvFlowReleaseVolumeRender (NvFlowVolumeRender *volumeRender)
void NvFlowVolumeRenderGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeRenderParams *params)
NvFlowGridExport * NvFlowVolumeRenderLightGridExport (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowGridExport *gridExport, const NvFlowVolumeLightingParams *params)
void NvFlowVolumeRenderParamsDefaults (NvFlowVolumeRenderParams *params)
void NvFlowVolumeRenderTexture3D (NvFlowVolumeRender *volumeRender, NvFlowContext *context, NvFlowTexture3D *density, const NvFlowVolumeRenderParams *params)

Enumeration Type Documentation

Multiple resolution options for offscreen ray march.

Enumerator:
eNvFlowMultiResRayMarchDisabled 
eNvFlowMultiResRayMarch2x2 
eNvFlowMultiResRayMarch4x4 
eNvFlowMultiResRayMarch8x8 
eNvFlowMultiResRayMarch16x16 

Downsample options for offscreen ray march.

Enumerator:
eNvFlowVolumeRenderDownsampleNone 
eNvFlowVolumeRenderDownsample2x2 


Function Documentation

NvFlowVolumeRender* NvFlowCreateVolumeRender ( NvFlowContext *  context,
const NvFlowVolumeRenderDesc desc 
)

Creates a volume render object.

Parameters:
[in] context The context for GPU resource allocation.
[in] desc Description for memory allocation.
Returns:
The created volume render object.

void NvFlowReleaseVolumeRender ( NvFlowVolumeRender *  volumeRender  ) 

Releases a volume render object.

Parameters:
[in] volumeRender The volume render object to be released.

void NvFlowVolumeRenderGridExport ( NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowGridExport *  gridExport,
const NvFlowVolumeRenderParams params 
)

Renders a grid export.

Parameters:
[in] volumeRender The volume render object to perform the rendering.
[in] context The context that created the volume render object.
[in] gridExport The grid export to ray march.
[in] params Parameters for rendering.

NvFlowGridExport* NvFlowVolumeRenderLightGridExport ( NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowGridExport *  gridExport,
const NvFlowVolumeLightingParams params 
)

Lights a grid export to produce another grid export that can be ray marched raw.

Parameters:
[in] volumeRender The volume render object to perform the lighting.
[in] context The context that created the volume render object.
[in] gridExport The grid export to ray march.
[in] params Parameters for lighting.
Returns:
The lit grid view.

void NvFlowVolumeRenderParamsDefaults ( NvFlowVolumeRenderParams params  ) 

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

Parameters:
[out] params The parameters for Flow to fill out.

void NvFlowVolumeRenderTexture3D ( NvFlowVolumeRender *  volumeRender,
NvFlowContext *  context,
NvFlowTexture3D *  density,
const NvFlowVolumeRenderParams params 
)

Renders a 3D texture.

Parameters:
[in] volumeRender The volume render object to perform the rendering.
[in] context The context that created the volume render object.
[in] density The 3D texture to ray march.
[in] params Parameters for rendering.