NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::IVolume_device_data_buffer Class Referenceabstract

Volume device-data accessor interface. More...

#include <isparse_volume_subset.h>

Inherits mi::base::Interface_declare< 0x60d74933, ... >.

Public Member Functions

virtual bool is_valid () const =0
 Verify if a data subset is valid. More...
 
virtual Sparse_volume_voxel_format get_data_format () const =0
 Voxel format of the volume data. More...
 
virtual mi::math::Vector< mi::Sint32, 3 > get_data_position () const =0
 Volume data position in local volume space. More...
 
virtual mi::math::Vector< mi::Uint32, 3 > get_data_extent () const =0
 Volume data extent. More...
 
virtual void * get_device_data () const =0
 Raw memory pointer to internal device-buffer data. More...
 
virtual mi::Size get_data_size () const =0
 The size of the buffer in Bytes. More...
 
virtual mi::Sint32 get_gpu_device_id () const =0
 GPU device id if the buffer is located on a GPU device,. More...
 

Detailed Description

Volume device-data accessor interface.

An instance of this class will hold ownership of the device data. For this reason managing the life-time of an instance is important for when to free up the data.

Note
WORK IN PROGRESS
  • for now uses the Sparse_volume_voxel_format enum to represent volume type

Member Function Documentation

 get_data_extent()

virtual mi::math::Vector< mi::Uint32, 3 > nv::index::IVolume_device_data_buffer::get_data_extent ( ) const
pure virtual

Volume data extent.

 get_data_format()

virtual Sparse_volume_voxel_format nv::index::IVolume_device_data_buffer::get_data_format ( ) const
pure virtual

Voxel format of the volume data.

 get_data_position()

virtual mi::math::Vector< mi::Sint32, 3 > nv::index::IVolume_device_data_buffer::get_data_position ( ) const
pure virtual

Volume data position in local volume space.

 get_data_size()

virtual mi::Size nv::index::IVolume_device_data_buffer::get_data_size ( ) const
pure virtual

The size of the buffer in Bytes.

 get_device_data()

virtual void * nv::index::IVolume_device_data_buffer::get_device_data ( ) const
pure virtual

Raw memory pointer to internal device-buffer data.

 get_gpu_device_id()

virtual mi::Sint32 nv::index::IVolume_device_data_buffer::get_gpu_device_id ( ) const
pure virtual

GPU device id if the buffer is located on a GPU device,.

 is_valid()

virtual bool nv::index::IVolume_device_data_buffer::is_valid ( ) const
pure virtual

Verify if a data subset is valid.


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