RealityServer® 6.4

render_to_images

Renders a scene to multiple images, where each image can contain a different result. See the Iray documentation for supported canvases and per-renderer limitations.

arguments

• "canvases" : Interface[]

  An array of Canvas_definition canvases to render to. The Canvas_definition "content" field may be either a simplified canvas content string ("result", "normal" etc) or a Canvas_parameters object where "type" is a mi::neuraylib::Canvas_type string ("result" for TYPE_RESULT, "post_toon" for TYPE_POST_TOON, etc), and "params" is a map keyed by mi::neuraylib::Canvas_parameter strings ("color_lpe" for PARAM_COLOR_LPE, "index" for PARAM_INDEX, etc).

  Web Services Notes:

  • See the "Canvas names" section of the "Iray Programmers Manual" for a detailed description of supported canvas_content string values and the canvas_pixel_type values required by them. Also see the "Render target canvases" section for a list of canvas type identifiers and their supported parameters when using the extended Canvas_parameters structure.

• "formats" : Data

  The image formats to return. This can be a string (eg: "jpg") in which case all images are returned in that format, an object with string properties "format", "pixel_type" and "quality" used for image encoding (latter two are optional) or an array of such objects specifying differing encodings for each image. If the array is shorter than the number of canvases supplied then the last value will be used for subsequent canvases

• "render_context_name" : String (default: null)

  The name of the render context to use.
  Defaults to a random uuid.

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

• "render_context_timeout" : Uint32 (default: 10)

  The timeout for the named render context.

• "renderer" : String

  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.

• "scene_name" : String

  The name of the scene to render.

return value

Returns a array of the rendered images which can be used directly if calling from a V8 command or returned via the WebSocket based client library. Results of this command cannot be returned via JSON-RPC HTTP requests.

groups

• javascript
• render