Iray SDK API nvidia_logo_transpbg.gif Up
iqueue_manager_api.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_IQUEUE_MANAGER_API_H
8#define MI_NEURAYLIB_IQUEUE_MANAGER_API_H
9
11
12namespace mi {
13
14class IArray;
15
16namespace neuraylib {
17
22{
33 // Undocumented, for alignment only
34 STEREO_PAIRING_FORCE_32_BIT = 0xffffffffU
35};
36
37mi_static_assert( sizeof( Stereo_pairing_mode)== sizeof( Uint32));
38
43
52 base::Interface_declare<0x5b40bd6e,0x8596,0x43aa,0x83,0x64,0x4d,0x0c,0xd9,0xf6,0x96,0xaf>
53{
54public:
135 const char* project,
136 const IArray* snapshots,
137 const IArray* render_target,
138 Uint32 resolution_x,
139 Uint32 resolution_y,
140 Uint32 max_samples,
141 Uint32 max_time,
142 Float32 quality,
143 const char* image_format,
144 Uint32 priority,
145 const char* render_mode = "iray",
146 Stereo_pairing_mode stereo_pairing_mode = STEREO_PAIRING_NONE,
147 Float32 stereo_eye_separation_distance = 0) = 0;
148
152 virtual const char* get_compatible_snapshot_bridge_url() = 0;
153
157 virtual const char* get_authentication_token() = 0;
158};
159
161class IQueue_manager_api : public
162 base::Interface_declare<0x2bdfce73,0x762c,0x4b15,0x94,0xdf,0x4e,0xec,0xc5,0x7d,0xbf,0x88>
163{
164public:
192 const char* address, const char* user_name, const char* password, Sint32* errors = 0) = 0;
193};
194 // end group mi_neuray_queue_manager
196
197} // namespace neuraylib
198
199} // namespace mi
200
201#endif // MI_NEURAYLIB_IQUEUE_MANAGER_API_H
This interface represents static arrays, i.e., arrays with a fixed number of elements.
Definition: iarray.h:37
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
An API component which can be used to create a connection to a queue manager.
Definition: iqueue_manager_api.h:163
virtual IQueue_manager_connection * connect(const char *address, const char *user_name, const char *password, Sint32 *errors=0)=0
Creates a connection to a queue manager server.
Represents a connection to a queue manager server.
Definition: iqueue_manager_api.h:53
virtual const char * get_compatible_snapshot_bridge_url()=0
Looks for a compatible bridge application on the server-side which can be used to upload snapshots.
virtual const char * get_authentication_token()=0
Returns an authentication token which has to be provided to the Bridge client to upload snapshots.
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
Submits a job to the queue manager server.
#define mi_static_assert(expr)
Compile time assertion that raises a compilation error if the constant expression expr evaluates to f...
Definition: assert.h:65
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
float Float32
32-bit float.
Definition: types.h:51
signed int Sint32
32-bit signed integer.
Definition: types.h:46
Mixin class template for deriving new interface declarations.
Stereo_pairing_mode
Constants for the stereo pairing mode.
Definition: iqueue_manager_api.h:22
@ STEREO_PAIRING_NONE
Disable stereo rendering.
Definition: iqueue_manager_api.h:24
@ STEREO_PAIRING_SEPARATE
Stereo images are exported in separate files.
Definition: iqueue_manager_api.h:26
@ STEREO_PAIRING_TOP_TO_BOTTOM
The image of the left eye is rendered above the image of the right eye.
Definition: iqueue_manager_api.h:32
@ STEREO_PAIRING_LEFT_TO_RIGHT
The image of the left eye is rendered beside (left side of) the image of the right eye.
Definition: iqueue_manager_api.h:29
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: neuraylib.h:179