iindex_direct.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IINDEX_DIRECT_H
#define NVIDIA_INDEX_IINDEX_DIRECT_H
 
#include <nv/index/idistributed_data_import_callback.h>
#include <nv/index/idistributed_data_subset.h>
#include <nv/index/iindex_direct_vulkan.h>
 
// CUDA forward declarations required for the interfaces below
struct cudaArray;
struct cudaChannelFormatDesc;
 
namespace nv {
namespace index {
 
enum Volume_direct_type
{
    VOLUME_DIRECT_TYPE_INVALID          = 0x00u,
 
    VOLUME_DIRECT_TYPE_SPARSE_VOLUME,   
    VOLUME_DIRECT_TYPE_NANOVDB          
};
 
struct Volume_direct_data;
 
typedef const Volume_direct_data* Volume_direct_data_handle;
 
class IVolume_direct_host :
    public mi::base::Interface_declare<0x99cd79a5,0x3ad,0x4a93,0x8c,0xca,0xd8,0x8e,0x2b,0xf1,0x19,0xc2,
                                       mi::neuraylib::IElement>
{
public:
    virtual mi::math::Bbox_struct<mi::Float32, 3>       get_bounding_box() const = 0;
 
    virtual mi::math::Matrix_struct<mi::Float32, 4, 4>  get_transform() const = 0;
 
    virtual Distributed_data_attribute_format           get_voxel_format() const = 0;
 
    virtual Volume_direct_data_handle                   get_direct_handle() const = 0;
 
    virtual IDistributed_data_subset*                   get_data_subset() const = 0;
};
 
class IVolume_direct_resources_device :
    public mi::base::Interface_declare<0x35b08e00,0xce92,0x41bb,0x9f,0xad,0x54,0x8,0x70,0x48,0x42,0x1d>
{
public:
    struct Buffer
    {
        mi::Sint32      device_id;              // = -1
 
        void*           device_data;            // = nullptr;
        mi::Size        device_data_size;       // = 0ull
 
        const void*     allocation_user_data;   // = nullptr (optional, based on registered ICuda_memory_allocator implementation)
    };
 
    struct Array
    {
        mi::Sint32      device_id;              // = -1
 
        cudaArray*                              device_array;           // = nullptr;
        const cudaChannelFormatDesc*            device_array_format;
        mi::math::Vector_struct<mi::Uint32, 3>  device_array_extent;
 
        const void*     allocation_user_data;   // = nullptr (optional, based on registered ICuda_memory_allocator implementation)
    };
};
 
class IVolume_direct_resources_device_sparse_volume :
    public mi::base::Interface_declare<0x56677429,0xc0c6,0x4db7,0xb6,0x5c,0x40,0x8d,0xf8,0x38,0xd7,0x20,
                                       IVolume_direct_resources_device>
{
public:
    virtual Buffer      get_octree_serialization_buffer() const = 0;
    virtual Buffer      get_octree_node_data_buffer() const = 0;
    virtual Buffer      get_uniform_buffer() const = 0;
 
    virtual Array*      get_brick_atlas_textures() const = 0;
    virtual mi::Uint32  get_brick_atlas_textures_count() const = 0;
};
 
class IVolume_direct_resources_device_NanoVDB :
    public mi::base::Interface_declare<0xbfc8514b,0xa153,0x48a5,0x97,0x19,0xe3,0xe9,0xfa,0x1b,0xa5,0x3e,
                                       IVolume_direct_resources_device>
{
public:
    virtual Buffer      get_nanovdb_buffer() const = 0;
};
 
class IVolume_direct_cuda :
    public mi::base::Interface_declare<0xb12ed2be,0x80bf,0x4fc8,0xba,0xb9,0x46,0x37,0x81,0x48,0x88,0xc>
{
public:
    virtual mi::math::Bbox_struct<mi::Float32, 3>       get_bounding_box() const = 0;
 
    virtual mi::math::Matrix_struct<mi::Float32, 4, 4>  get_transform() const = 0;
 
    virtual Distributed_data_attribute_format           get_voxel_format() const = 0;
 
    virtual mi::Uint32                                  get_device_id() const = 0;
 
    virtual Volume_direct_data_handle                   get_direct_handle() const = 0;
 
    virtual Volume_direct_type                          get_volume_type() const = 0;
    virtual IVolume_direct_resources_device*            get_resources() const = 0;
};
 
class IIndex_direct_config :
    public mi::base::Interface_declare<0x72acbf4a,0x9abc,0x4e6d,0x8c,0xd3,0xe1,0x8e,0xc0,0x66,0xc3,0x7e>
{
public:
    struct Sparse_volume_config
    {
        mi::math::Vector_struct<mi::Uint32, 3>  brick_size;     
        mi::Uint32                              brick_border;   
    };
 
    struct Vulkan_config
    {
        VkInstance                              vk_instance;    
        // ...
    };
 
    virtual Sparse_volume_config        default_volume_config() const = 0;
 
    virtual void                        set_sparse_volume_config(const Sparse_volume_config& vol_cfg) = 0;
    virtual Sparse_volume_config        get_sparse_volume_config() const = 0;
 
    virtual void                        set_vulkan_config(const Vulkan_config& vk_cfg) = 0;
    virtual Vulkan_config               get_vulkan_config() const = 0;
 
};
 
class IIndex_direct :
    public mi::base::Interface_declare<0x62216bae,0xf97e,0x4dda,0xaa,0xfa,0xe5,0x70,0x14,0xec,0xc0,0x67>
{
public:
    virtual bool                        initialize(
                                            const IIndex_direct_config* idx_direct_config) = 0;
 
    virtual const IIndex_direct_config* get_config() const = 0;
 
    virtual const char*                 get_product_name() const = 0;
 
    virtual const char*                 get_version() const = 0;
 
    virtual const char*                 get_revision() const = 0;
 
    virtual IVolume_direct_host*        load_volume(
                                            nv::index::IDistributed_data_import_callback* volume_importer) = 0;
 
    virtual bool                        free_volume(
                                            IVolume_direct_host* volume_direct_inst) = 0;
 
    virtual bool                        free_volume(
                                            IVolume_direct_cuda* volume_direct_inst) = 0;
 
    virtual IVolume_direct_cuda*        upload_volume_to_device(
                                            const IVolume_direct_host*  volume_direct,
                                            mi::Uint32                  cuda_device_id) = 0;
 
    virtual IVolume_direct_vulkan*      upload_volume_to_vulkan(
                                            VkPhysicalDevice            vk_phys_device,
                                            VkDevice                    vk_device,
                                            const IVolume_direct_host*  volume_direct) = 0;
 
    virtual mi::IString*                get_memory_usage_info() const = 0;
};
 
} // namespace index
} // namespace nv
 
#endif // NVIDIA_INDEX_IINDEX_DIRECT_H