icompute.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_ICOMPUTE_H
#define NVIDIA_INDEX_ICOMPUTE_H
 
#include <mi/base/interface_declare.h>
#include <mi/math/bbox.h>
#include <mi/neuraylib/iserializer.h>    // Tag_struct
 
#include <nv/index/iattribute.h>
#include <nv/index/idistributed_data_subset.h>
#include <nv/index/ierror.h>
 
namespace nv {
namespace index {
 
// forward declarations
class ICompute_results;
class ICompute_launch_request;
class IDistributed_data_access;
class IIndex_rendering;
 
class IIndex_compute :
    public mi::base::Interface_declare<0x5aee3342,0x97c2,0x41fc,0xa3,0x40,0x3e,0x1c,0x20,0x87,0x10,0xff>
{
public:
    virtual ICompute_launch_request* create_launch_request() = 0;
 
    virtual const ICompute_results* perform_compute(
        const ICompute_launch_request*      request,
        IIndex_rendering*                   index_rendering,
        mi::neuraylib::Tag_struct           session_tag,
        mi::neuraylib::IDice_transaction*   dice_transaction) = 0;
};
 
class ICompute_launch_request :
    public mi::base::Interface_declare<0x7487d3dd,0x72e3,0x4a9e,0x9e,0x9d,0x1d,0x8b,0xfb,0x96,0xd5,0xa0>
{
public:
    virtual void set_launch(
        mi::neuraylib::Tag_struct xac_compute_program_tag,
        mi::neuraylib::Tag_struct data_write_target_tag) = 0;
 
    virtual void set_launch(
        mi::neuraylib::Tag_struct xac_compute_program_tag,
        mi::neuraylib::Tag_struct xac_compute_target_tag,
        mi::neuraylib::Tag_struct data_write_target_tag) = 0;
 
    virtual void set_region_of_interest(const mi::math::Bbox_struct<mi::Float32, 3>& box) = 0;
 
    virtual bool is_valid() const = 0;
 
    virtual mi::neuraylib::Tag_struct get_compute_program_tag() const = 0;
 
    virtual mi::neuraylib::Tag_struct get_compute_target_tag() const = 0;
 
    virtual mi::neuraylib::Tag_struct get_data_write_target_tag() const = 0;
 
    virtual bool get_region_of_interest(mi::math::Bbox_struct<mi::Float32, 3>& box) const = 0;
};
 
class ICompute_results :
    public mi::base::Interface_declare<0xcb08140d,0x10bc,0x4c8f,0xa0,0xf7,0xe,0x85,0x31,0x21,0xd8,0x6e>
{
public:
    virtual bool is_valid() const = 0;
 
    virtual const IError_set* get_error_set() const = 0;
 
    virtual IDistributed_data_access* access_compute_results() const = 0;
};
 
class ICompute_plane_parameters :
    public mi::base::Interface_declare<0xdaf77e98,0xd880,0x415c,0x86,0x39,0x2d,0x6b,0xee,0x9e,0x5c,0xbe,
                                       nv::index::IAttribute>
{
public:
    virtual void set_resolution(const mi::math::Vector_struct<mi::Uint32, 2>& res) = 0;
 
    virtual bool set_value_sizes(const mi::Uint32* value_sizes, mi::Uint32 nb_values) = 0;
 
    virtual mi::math::Vector_struct<mi::Uint32, 2> get_resolution() const = 0;
 
    virtual mi::Uint32 get_nb_values() const = 0;
 
    virtual mi::Uint32 get_value_size(mi::Uint32 i) const = 0;
};
 
class ICompute_result_buffer_2D :
    public mi::base::Interface_declare<0x8f335887,0x6c3b,0x48be,0xb0,0x55,0x46,0xb0,0xc4,0xdb,0xf4,0xb0,
                                       IDistributed_data_subset>
{
public:
    virtual mi::math::Vector_struct<mi::Uint32, 2> get_resolution() const = 0;
 
    virtual mi::math::Vector_struct<mi::Uint32, 2> get_offset() const = 0;
 
 
    virtual mi::Uint32 get_nb_values() const = 0;
 
    virtual mi::Uint32 get_value_size(mi::Uint32 i) const = 0;
 
    virtual const mi::Uint32* get_value_masks() const = 0;
 
    virtual const void* get_values(mi::Uint32 value_index) const = 0;
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_ICOMPUTE_H