NvFlowCrossSectionParams Struct Reference
[NvFlowCrossSection]

Parameters needed to render cross section. More...

#include <NvFlow.h>

Data Fields
NvFlowFloat4	backgroundColor
	Background color.
NvFlowFloat4	cellColor
	Color for cell outline.
NvFlowUint	crossSectionAxis
	Cross section to visualize, 0 to 2 range.
NvFlowFloat3	crossSectionPosition
	Offset in grid NDC for view.
float	crossSectionScale
	Scale on cross section to allow zooming.
NvFlowDepthStencilView *	depthStencilView
	Depth stencil view for depth testing with ray march.
bool	fullscreen
	If true, covers entire viewport, if false, top right corner.
NvFlowGridExport *	gridExport
	gridExport used for final rendering
NvFlowGridExport *	gridExportDebugVis
	gridExport direct from simulation
float	intensityScale
	scales the visualization intensity
NvFlowFloat4	lineColor
	Color to use for any lines drawn.
NvFlowRenderMaterialPool *	materialPool
	Pool of materials to look for matches to GridMaterials.
bool	outlineCells
	Draw lines around cell boundaries.
bool	pointFilter
	If true, point filter so the cells are easy to see.
NvFlowFloat4x4	projectionMatrix
	Projection matrix, row major.
NvFlowGridTextureChannel	renderChannel
	GridExport channel to render.
NvFlowVolumeRenderMode	renderMode
	Render mode, see NvFlowVolumeRenderMode.
NvFlowRenderTargetView *	renderTargetView
	Render target view to composite ray marched result against.
float	vectorLengthScale
	Controls maximum velocity vector line length.
float	velocityScale
	Scale to adjust vector length as a function of velocity.
bool	velocityVectors
	If true, overlay geometric velocity vectors.
NvFlowFloat4x4	viewMatrix
	View matrix, row major.

---

Detailed Description

Parameters needed to render cross section.

---

Field Documentation

NvFlowFloat4 NvFlowCrossSectionParams::backgroundColor

Background color.

NvFlowFloat4 NvFlowCrossSectionParams::cellColor

Color for cell outline.

NvFlowUint NvFlowCrossSectionParams::crossSectionAxis

Cross section to visualize, 0 to 2 range.

NvFlowFloat3 NvFlowCrossSectionParams::crossSectionPosition

Offset in grid NDC for view.

float NvFlowCrossSectionParams::crossSectionScale

Scale on cross section to allow zooming.

NvFlowDepthStencilView* NvFlowCrossSectionParams::depthStencilView

Depth stencil view for depth testing with ray march.

bool NvFlowCrossSectionParams::fullscreen

If true, covers entire viewport, if false, top right corner.

NvFlowGridExport* NvFlowCrossSectionParams::gridExport

gridExport used for final rendering

NvFlowGridExport* NvFlowCrossSectionParams::gridExportDebugVis

gridExport direct from simulation

float NvFlowCrossSectionParams::intensityScale

scales the visualization intensity

NvFlowFloat4 NvFlowCrossSectionParams::lineColor

Color to use for any lines drawn.

NvFlowRenderMaterialPool* NvFlowCrossSectionParams::materialPool

Pool of materials to look for matches to GridMaterials.

bool NvFlowCrossSectionParams::outlineCells

Draw lines around cell boundaries.

bool NvFlowCrossSectionParams::pointFilter

If true, point filter so the cells are easy to see.

NvFlowFloat4x4 NvFlowCrossSectionParams::projectionMatrix

Projection matrix, row major.

NvFlowGridTextureChannel NvFlowCrossSectionParams::renderChannel

GridExport channel to render.

NvFlowVolumeRenderMode NvFlowCrossSectionParams::renderMode

Render mode, see NvFlowVolumeRenderMode.

NvFlowRenderTargetView* NvFlowCrossSectionParams::renderTargetView

Render target view to composite ray marched result against.

float NvFlowCrossSectionParams::vectorLengthScale

Controls maximum velocity vector line length.

float NvFlowCrossSectionParams::velocityScale

Scale to adjust vector length as a function of velocity.

bool NvFlowCrossSectionParams::velocityVectors

If true, overlay geometric velocity vectors.

NvFlowFloat4x4 NvFlowCrossSectionParams::viewMatrix

View matrix, row major.

---

The documentation for this struct was generated from the following file:

• NvFlow.h