Data structures and constant
[VolumeViz Shader API]

VolumeViz VolumeViz GLSL shaders data structures and constants. More...

Classes

struct  VVizVoxelInfo
 Defines voxel state info used with the VolumeViz Shader Library API. More...

Defines

#define VVizDefaultData   VVIZ_DATATYPE(0.0)
#define VVizTileInfo   vec4

Functions

vec3 VVizGetVolumeDimensions (in VVizDataSetId dataset)
vec3 VVizGetTileDimensions (in VVizDataSetId dataset)
vec3 VVizGetVoxelDimensions (in VVizDataSetId dataset)
int VVizGetTileResolution (in VVizTileInfo tileInfo)
VVizTileInfo VVizGetTileInfo (in VVizDataSetId dataset, in vec3 dataCoord)
void VVizGetTileIJKBox (in VVizDataSetId dataset, in vec3 dataCoord, out vec3 tileIJKMin, out vec3 tileIJKMax)

Detailed Description

VolumeViz VolumeViz GLSL shaders data structures and constants.

The following pre-processing directives are dynamically added to the shader pipeline and can be used by application defined shader functions.

- VVIZ_DATARGBA : Is true if VVizData (VolumeViz input data) contains RGBA values.
In this case each value in VVizData is a vec4. Otherwise each value is a float.
(Before Open Inventor 8.5 only float values were supported.)

- VVIZ_DATATYPE : A string defining the GLSL data type in the volume (VVizData).
If VVIZ_DATARGBA is true, then VVIZ_DATATYPE is defined as "vec4", in all other cases it is defined as "float".
(Before Open Inventor 8.5 only type float was supported.)

- VVIZ_NUM_CLIPPING_PLANES : Defines the current numbers of GL clipping planes to take in account.

- VVIZ_SHAPE_TYPE : Define the shape that is currently rendered.
It can be usefull to specialize shader behavior depending on dhape type. It can be VVIZ_VRENDER, VVIZ_SLICE, VVIZ_OBLSLICE, VVIZ_VGEOM, VVIZ_VSKIN or VVIZ_HEIGHTFIELD.


Define Documentation

#define VVizDefaultData   VVIZ_DATATYPE(0.0)

Default voxel value returned by VolumeViz shaders when no data is available.

#define VVizTileInfo   vec4

Defines internal VolumeViz tile info data storage.

See VVizGetTileResolution, VVizGetTileInfo


Function Documentation

vec3 VVizGetTileDimensions ( in VVizDataSetId  dataset  ) 

Returns volume dataset tile dimensions in voxels.

Parameters:
dataset The dataset to retrieve information from.
Returns:
dataset Tile dimension.
void VVizGetTileIJKBox ( in VVizDataSetId  dataset,
in vec3  dataCoord,
out vec3  tileIJKMin,
out vec3  tileIJKMax 
)

Returns VolumeViz tile IJK box info for a specified voxel.

Parameters:
dataset The dataset to which the tileinfo belongs.
dataCoord Uniform data coordinates in volume space.
tileIJKMin ijk min of the tile in voxels.
tileIJKMax ijk max of the tile in voxels.
VVizTileInfo VVizGetTileInfo ( in VVizDataSetId  dataset,
in vec3  dataCoord 
)

Returns VolumeViz tile info for a specified voxel.

Parameters:
dataset The dataset to retrieve information from.
dataCoord Uniform data coordinates in volume space.
Returns:
The tileInfo of the voxel at position dataCoord.
int VVizGetTileResolution ( in VVizTileInfo  tileInfo  ) 

Returns VolumeViz tile resolution info.

Parameters:
tileInfo The tileInfo to retrieve information from.
Returns:
The LDM resolution level of this tile (zero is full resolution).
vec3 VVizGetVolumeDimensions ( in VVizDataSetId  dataset  ) 

Returns volume dimensions of a dataset in voxels.

Parameters:
dataset The dataset to retrieve information from.
Returns:
dataset Dimension.
vec3 VVizGetVoxelDimensions ( in VVizDataSetId  dataset  ) 

Returns volume dataset uniform voxel dimensions.

Parameters:
dataset The dataset to retrieve information from.
Returns:
dataset Voxel uniform dimension.

Open Inventor Toolkit reference manual, generated on 12 Sep 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/