iqueue_manager_api.h

Go to the documentation of this file.

/***************************************************************************************************
 * Copyright 2025 NVIDIA Corporation. All rights reserved.
 **************************************************************************************************/
 
#ifndef MI_NEURAYLIB_IQUEUE_MANAGER_API_H
#define MI_NEURAYLIB_IQUEUE_MANAGER_API_H
 
#include <mi/base/interface_declare.h>
#include <mi/neuraylib/version.h> // for MI_NEURAYLIB_DEPRECATED_ENUM_VALUE
 
namespace mi {
 
class IArray;
 
namespace neuraylib {
 
enum Stereo_pairing_mode : Uint32
{
    STEREO_PAIRING_NONE = 0,
    STEREO_PAIRING_SEPARATE = 1,
    STEREO_PAIRING_LEFT_TO_RIGHT = 2,
    STEREO_PAIRING_TOP_TO_BOTTOM = 3
    MI_NEURAYLIB_DEPRECATED_ENUM_VALUE(STEREO_PAIRING_FORCE_32_BIT, 0xffffffffU)
};
 
 
class IQueue_manager_connection : public
    base::Interface_declare<0x5b40bd6e,0x8596,0x43aa,0x83,0x64,0x4d,0x0c,0xd9,0xf6,0x96,0xaf>
{
public:
    virtual Sint32 submit_job(
        const char* project,
        const IArray* snapshots,
        const IArray* render_target,
        Uint32 resolution_x,
        Uint32 resolution_y,
        Uint32 max_samples,
        Uint32 max_time,
        Float32 quality,
        const char* image_format,
        Uint32 priority,
        const char* render_mode = "iray",
        Stereo_pairing_mode stereo_pairing_mode = STEREO_PAIRING_NONE,
        Float32 stereo_eye_separation_distance = 0) = 0;
 
    virtual const char* get_compatible_snapshot_bridge_url() = 0;
 
    virtual const char* get_authentication_token() = 0;
};
 
class IQueue_manager_api : public
    base::Interface_declare<0x2bdfce73,0x762c,0x4b15,0x94,0xdf,0x4e,0xec,0xc5,0x7d,0xbf,0x88>
{
public:
    virtual IQueue_manager_connection* connect(
        const char* address,
        const char* user_name,
        const char* password,
        Sint32* errors = nullptr) = 0;
};
 // end group mi_neuray_queue_manager
 
} // namespace neuraylib
 
} // namespace mi
 
#endif // MI_NEURAYLIB_IQUEUE_MANAGER_API_H