render_to_canvases
Renders a scene to multiple neuray canvases, where each canvas can contain a different result. See the Iray documentation for supported canvases and per-renderer limitations.
arguments
- "canvas_resolution_x" : Uint32
Horizontal render resolution.
- "canvas_resolution_y" : Uint32
Vertical render resolution.
- "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.
- "render_context_name" : String (default: null)
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
Canvas[]Returns a array of the rendered canvases which can be used directly if calling from a V8 command. Alternatively the canvases can be retrieved as encoded images using the get_canvas command.