neuray API Programmer's Manual

iqueue_manager_api.h File Reference

Description

API component to interact with the queue manager.

Code Example

iqueue_manager_api.h

‎/***************************************************************************************************
 * Copyright 2023 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>

namespace mi {

class IArray;

namespace neuraylib {

enum Stereo_pairing_mode
{
    STEREO_PAIRING_NONE = 0,
    STEREO_PAIRING_SEPARATE = 1,
    STEREO_PAIRING_LEFT_TO_RIGHT = 2,
    STEREO_PAIRING_TOP_TO_BOTTOM = 3,
    //  Undocumented, for alignment only
    STEREO_PAIRING_FORCE_32_BIT = 0xffffffffU
};

mi_static_assert( sizeof( Stereo_pairing_mode)== sizeof( Uint32));





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 = 0) = 0;
};
 // end group mi_neuray_queue_manager

} // namespace neuraylib

} // namespace mi

#endif // MI_NEURAYLIB_IQUEUE_MANAGER_API_H

Namespaces

namespace 
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH. More...
namespace 
Namespace for the neuray API. More...

Classes

class 
An API component which can be used to create a connection to a queue manager. More...
class 
Represents a connection to a queue manager server. More...

Enumerations

enum  {STEREO_PAIRING_NONE = 0, STEREO_PAIRING_SEPARATE = 1, STEREO_PAIRING_LEFT_TO_RIGHT = 2, STEREO_PAIRING_TOP_TO_BOTTOM = 3, STEREO_PAIRING_FORCE_32_BIT = 0xffffffffU }
Constants for the stereo pairing mode. More...