Rendering properties for VDB data.
More...
#include <ivdb_rendering_properties.h>
Inherits mi::base::Interface_declare< 0xed7b65f1, ... >.
Rendering properties for VDB data.
◆ get_debug_visualization_option()
| virtual mi::Uint32 nv::index::IVDB_rendering_properties::get_debug_visualization_option |
( |
| ) |
const |
|
pure virtual |
Internal debugging options applied to the visualization.
- Returns
- Returns the applied debug option.
◆ get_filter_mode()
| virtual VDB_filter_mode nv::index::IVDB_rendering_properties::get_filter_mode |
( |
| ) |
const |
|
pure virtual |
◆ get_reference_sampling_distance()
| virtual mi::Float32 nv::index::IVDB_rendering_properties::get_reference_sampling_distance |
( |
| ) |
const |
|
pure virtual |
Returns the reference sampling distance used for a VDB scene element (IVDB_scene_element).
◆ get_sampling_distance()
| virtual mi::Float32 nv::index::IVDB_rendering_properties::get_sampling_distance |
( |
| ) |
const |
|
pure virtual |
◆ get_subset_voxel_border()
| virtual mi::Uint32 nv::index::IVDB_rendering_properties::get_subset_voxel_border |
( |
| ) |
const |
|
pure virtual |
Returns the voxel border size used for VDB subset generation.
◆ set_debug_visualization_option()
| virtual void nv::index::IVDB_rendering_properties::set_debug_visualization_option |
( |
mi::Uint32 |
o | ) |
|
|
pure virtual |
Internal debugging options applied to the visualization.
- Parameters
-
| [in] | o | Debug option applied to the visualization.
|
◆ set_filter_mode()
| virtual void nv::index::IVDB_rendering_properties::set_filter_mode |
( |
VDB_filter_mode |
filter_mode | ) |
|
|
pure virtual |
Set the volume filter mode for a VDB scene element (IVDB_scene_element).
The default filter used is VDB_FILTER_NEAREST.
- Parameters
-
| [in] | filter_mode | Filter mode (default value is VDB_FILTER_NEAREST). |
◆ set_reference_sampling_distance()
| virtual void nv::index::IVDB_rendering_properties::set_reference_sampling_distance |
( |
mi::Float32 |
ref_sample_dist | ) |
|
|
pure virtual |
Set the reference sampling distance used for a VDB scene element (IVDB_scene_element).
The default value used is 1.0f. The reference sampling distance is used during the volume rendering to steer the opacity correction and therefore the appearance of the volume display.
- Parameters
-
| [in] | ref_sample_dist | Sampling distance (default value is 1.0f). |
◆ set_sampling_distance()
| virtual void nv::index::IVDB_rendering_properties::set_sampling_distance |
( |
mi::Float32 |
sample_dist | ) |
|
|
pure virtual |
Set the sampling distance used for a VDB scene element (IVDB_scene_element) when using the direct volume rendering mode.
The default value used is 1.0f.
- Parameters
-
| [in] | sample_dist | Sampling distance (default value is 1.0f). |
◆ set_subset_voxel_border()
| virtual void nv::index::IVDB_rendering_properties::set_subset_voxel_border |
( |
mi::Uint32 |
border_size | ) |
|
|
pure virtual |
Set the voxel border that is applied when VDB subsets are created.
SUch a border can be beneficial when using larger sampling kernels in XAC programs (e.g., for gradient generation calculations).
- Note
- This setting is applied when NVIDIA IndeX is creating
IVDB_scene_element subsets and can not be changed once the volume data is loaded.
- Parameters
-
| [in] | border_size | Voxel border size to apply to subsets (default value is 2). |
The documentation for this class was generated from the following file:
