nv::index::Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode> Class Template Reference

Sparse volume sampler for retrieving filtered and optionally classified volume samples. More...

#include <xac_interface_scene_elements_sparse_volume_doc.h>

Public Member Functions
SVOL_attrib_type	fetch_sample (const float3 &sample_position) const
	Sample a sparse volume attribute at the provided sample location. More...
float4	fetch_sample_classify (const float3 &sample_position, const xac::Colormap &color_map) const
	Sample a sparse volume attribute at the provided sample location. More...

Detailed Description

template<typename SVOL_attrib_type, Volume_filter_mode SVOL_filter_mode, Volume_classification_mode SVOL_classify_mode>
class nv::index::Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode>

Sparse volume sampler for retrieving filtered and optionally classified volume samples.

Member Function Documentation

fetch_sample()

template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode, Volume_classification_mode SVOL_classify_mode>

SVOL_attrib_type nv::index::Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode>::fetch_sample

(

const float3 &

sample_position

)

const

Sample a sparse volume attribute at the provided sample location.

This method always returns a filtered volume sample without classifying it using a colormap.

Parameters

[in]

sample_position

Sample position defined in volume local/object space.

Returns

Filtered volume sample according to the selected volume filter mode.

fetch_sample_classify()

template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode, Volume_classification_mode SVOL_classify_mode>

float4 nv::index::Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode>::fetch_sample_classify	(	const float3 &	sample_position,
		const xac::Colormap &	color_map
	)		const

Sample a sparse volume attribute at the provided sample location.

This method always returns a filtered and classified volume sample using the provided colormap.

Parameters

[in]	sample_position	Sample position defined in volume local/object space.
[in]	color_map	Colormap for classification of volume sample.

Returns

Filtered and classified volume sample according to the selected volume filter mode and volume classification mode.

---

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

• xac_interface_scene_elements_sparse_volume_doc.h