RealityServer® 6.4

queue_to_iray_server

Submits a scene to Iray Server for rendering.

arguments

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

  If the root element is a scene then also include the scene options in the root element.

• "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.

• "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.

• "render_targets" : Iray_server_render_target[]

  The render target definitions to render. 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 result_name will be substituted with this.

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

  The renderer to use for the render. If not provided then either the renderer specified in the render context, the renderer specified in the scene options or the default renderer is used.

• "result_name" : String

  The resulting rendered image name. 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_targets parameter.

• "scene_name" : String

  The name of the scene to render.

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

  The stereo mode used for rendering.

return value

groups

• iray_server
• javascript