RealityServer® Web Services 4.4

render_to_canvases

Renders a scene to multiple neuray canvases, where each canvas can contain a different result. Currently no more than 8 canvases can be rendered to and anymore than supported will be silently ignored.

arguments

• "canvas_resolution_x" : Uint32

  Horizontal render resolution.

• "canvas_resolution_y" : Uint32

  Vertical render resolution.

• "canvases" : Canvas_definition[]

  An array of canvases to render to.

  Web Services Notes:

  • See the "Result Canvas Names" section of the "Iray Technical Principles" for a detailed description of supported content values and the pixel_type values required by them.
• "render_context_name" : String

  The name of the render context to use.

• "render_context_options" : Map (default: null)

  A map of options to be set onto the render context. The value of each of key needs to be another map that contains The "type" and "value". eg {"type": "Sint32", "value": 32}

• "render_context_timeout" : Uint32 (default: 0)

  The timeout for the named render context.

• "renderer" : String (default: null)

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

  Possible Values:

  • default
  • iray
  • irt
  • ogl
  • blend
• "scene_name" : String

  The name of the scene to render.

return value

Once rendered the canvases can be retrived using the get_canvas command.

groups

• render
• scene