neuray API Programmer's Manual

mi::neuraylib::IQueue_manager_connection Class Reference

[Queue manager]

Description

Represents a connection to a queue manager server.

See also:

mi::neuraylib::IQueue_manager_api::connect()

Public Member Functions

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) =0
Submits a job to the queue manager server. More...

Member Functions

virtual Sint32 mi::​neuraylib::​IQueue_manager_connection::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) [pure virtual]

Submits a job to the queue manager server. In order to submit a job to the queue manager server the snapshot names specified in the snapshots parameter must have been uploaded to the server first. See the mi::bridge::IIray_bridge_snapshot_context for details.

Parameters

project
The name of the project this job belongs to. Rendering results are aggregated per project name. Later jobs of the same project might overwrite rendering results of earlier jobs of that project.
snapshots
A static or dynamic array of structures describing the snapshots of the job. These structures of type Snapshot_data have two string members "snapshot_name" and "result_name". The "snapshot_name" describes the name of the snapshot file which has been uploaded to the server before with the mi::bridge::IIray_bridge_snapshot_context. The "result_name" member defines the name of the result file on the server. It must contain a placeholder "%B" which will be replaced by the buffer output name on the server. The buffer output name is defined in the render_target parameter.
render_target
A static or dynamic array of structures describing the render target to be used for rendering. These structures of type Canvas_type have three string members "name", "pixel_type", and "output_name". The first two describe the name and the pixel type of a canvas in the render target (see mi::neuraylib::IRender_target for details). The last one is used to construct the name of the result file on the server, e.g. "Beauty" (see also the snapshots parameter).
resolution_x
The resolution of the camera in X direction.
resolution_y
The resolution of the camera in Y direction.
max_samples
The value of the attribute progressive_rendering_max_samples.
max_time
The value of the attribute progressive_rendering_max_time.
quality
The value of the attribute progressive_rendering_quality.
image_format
The image format to be used for saving the rendered images, e.g., "jpg". Note that support for a given image format requires an image plugin capable of handling that format.
priority
The priority of the job. The smaller the value the higher the priority. The highest priority is 0.

Returns

  • 0: Success.
  • -1: Invalid arguments (NULL pointer).
  • -2: Invalid element type or NULL pointer in snapshots.
  • -3: Invalid element type or NULL pointer in render_target.
  • -4: Connection error.
  • -5: Invalid server response.
  • -6: The job was rejected by the server.