RealityServer® 6.4

iray_server_queue_job

Submit a series of snapshots together as a job to be rendered by an Iray Server instance.

arguments

• "format" : String (default: "jpg")

  The output image format used for all rendered images.

  Possible Values:

  • jpg
  • png
  • tif
  • exr
  • hdr
  • ct

• "iray_server_name" : String

  The name of the preconfigured Iray Server to use.

• "job_name" : String

  The name given to the Iray Server job created.

• "max_samples" : Uint32 (default: 100)

  The maximum samples used for all rendered images.

• "max_time" : Uint32 (default: 3600)

  The maximum rendering time in seconds for each rendered image.

• "priority" : Uint32 (default: 100)

  The priority of the render job in the queue. The smaller the value, the higher the priority, with 0 being the highest.

• "quality" : Float32 (default: 1)

  The convergence quality setting used for all rendered images.

• "render_targets" : Iray_server_render_target[]

  The render target definitions for all snapshots. Each render targets must contain the following properties:
  

  • name: The content name of the canvas to render. This is equivalent to the canvas_content argument in a normal render call.
  • pixel_type: The pixel type to render to.
  • output_name: Name to use for this target in the output filename. The %B in the snapshot result name will be substituted with this.

• "renderer" : String (default: "default")

  The renderer used for the job.

  Possible Values:

  • default
  • iray
  • irt

• "resolution" : Uint32<2>

  The resolution that all images will be rendered at.

• "snapshots" : Iray_server_snapshot[]

  The snapshots to be rendered for this job. Each snapshot must contain the following properties:
  

  • snapshot_name: The name of a previously uploaded snapshot to render.
  • result_name: The output file for this render. This must contain the placeholder %B which will be replaced with the output_name of the corresponding render target.

• "stereo_eye_separation" : Float32 (default: 0)

  Eye separation value for stereo rendering.

• "stereo_mode" : String (default: "none")

  The stereo mode used for rendering.

  Possible Values:

  • none
  • separate
  • horizontal_lr
  • vertical_lr

return value

groups

• iray_server