Simplified scene management for volumes with direct access to low-level data.
More...
#include <iindex_direct.h>
Inherits mi::base::Interface_declare< 0x62216bae, ... >.
Simplified scene management for volumes with direct access to low-level data.
◆ free_volume() [1/2]
Frees up all resources of a particular device volume instance.
- Parameters
-
| [in] | volume_direct_inst | Instance of volume_direct_inst to free. |
- Returns
- True if resources were freed up successfully, false otherwise.
◆ free_volume() [2/2]
Frees up all resources of a particular host volume instance.
- Parameters
-
| [in] | volume_direct_inst | Instance of IVolume_direct to free. |
- Returns
- True if resources were freed up successfully, false otherwise.
◆ get_config()
| virtual const IIndex_direct_config * nv::index::IIndex_direct::get_config |
( |
| ) |
const |
|
pure virtual |
The current configuration settings.
- Returns
- Returns the configuration settings for the IndeX direct instance.
◆ get_memory_usage_info()
| virtual mi::IString * nv::index::IIndex_direct::get_memory_usage_info |
( |
| ) |
const |
|
pure virtual |
Get an information string containing information about internal memory usage.
- Returns
- An information string containing information about internal memory usage
◆ get_product_name()
| virtual const char * nv::index::IIndex_direct::get_product_name |
( |
| ) |
const |
|
pure virtual |
The NVIDIA IndeX Direct product name.
- Returns
- Returns the NVIDIA IndeX Direct product name as a null-terminated string.
◆ get_revision()
| virtual const char * nv::index::IIndex_direct::get_revision |
( |
| ) |
const |
|
pure virtual |
The NVIDIA IndeX Direct revision number indicates the build.
Please also refer to the product version in support requests.
- Returns
- Returns NVIDIA IndeX Direct product revision number as a null-terminated string.
◆ get_version()
| virtual const char * nv::index::IIndex_direct::get_version |
( |
| ) |
const |
|
pure virtual |
The product version of the NVIDIA IndeX Direct interface.
Please also refer to the product version in support requests.
- Returns
- Returns the NVIDIA IndeX Direct product version as a null-terminated string.
◆ initialize()
| virtual bool nv::index::IIndex_direct::initialize |
( |
const IIndex_direct_config * |
idx_direct_config | ) |
|
|
pure virtual |
Initializes the direct access functionality.
Must be called before load_volume() but after IIndex::start().
- Parameters
-
| [in] | idx_direct_config | Configuration settings for the IndeX direct instance. |
◆ load_volume()
Loads a volume using the given importer.
- Parameters
-
| [in] | volume_importer | Importer that implements the data loading. |
- Returns
- Volume representation that can be used to access the data, or 0 on error.
◆ upload_volume_to_device()
Upload the volume data to a particular CUDA device.
- Parameters
-
| [in] | cuda_device_id | CUDA device where the data resides. |
- Returns
- Handle to device data, or 0 when the data does not exist on the given device.
◆ upload_volume_to_vulkan()
| virtual IVolume_direct_vulkan * nv::index::IIndex_direct::upload_volume_to_vulkan |
( |
VkPhysicalDevice |
vk_phys_device, |
|
|
VkDevice |
vk_device, |
|
|
const IVolume_direct_host * |
volume_direct |
|
) |
| |
|
pure virtual |
Upload the volume data to a particular Vulkan device.
- Parameters
-
| [in] | vk_phys_device | Physical Vulkan device to match to internal CUDA device for the upload. |
| [in] | vk_device | Logical Vulkan device where the data should reside. |
| [in] | volume_direct | Instance of IVolume_direct to upload. |
- Returns
- Handle to device data, or 0 when the data does not exist on the given device.
The documentation for this class was generated from the following file:
