RealityServer® 6.4

render_to_canvas

Renders a scene to a neuray canvas

arguments

• "canvas_content" : Data (default: "result")

  The string identifier of data to render into the image. May also be 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.

  Possible Values:

  • result
  • alpha
  • depth
  • distance
  • normal
  • texture_coordinate[n] - n is the texture coordinate index to return.
  • object_id
  • material_id
  • diffuse
  • specular
  • glossy
  • emission
  • shadow
  • ambient_occlusion
  • lpexpr=lp-expression
  • irradiance
  • irradiance_probe
  • convergence_heatmap[i] - i is the index of a previous canvas to apply the effect to
  • toon[i] - i is the index of a previous canvas to apply the effect to

• "canvas_name" : String (default: null)

  The name of the canvas to use. If the canvas exists in the render context (and its resolution/pixel type matches) then the render will target this canvas. Otherwise a new canvas is created. The result will also be stored in the render context under this name.

• "canvas_pixel_type" : String (default: "Rgba")

  The pixel type of the canvas used for the render.

  Web Services Notes:

  • See the "Render target canvases" section of the "Iray Programmers Manual" for a detailed description of supported canvas_content values and the canvas_pixel_type values required by them.

  Possible Values:

  • Rgb
  • Rgba
  • Rgb_fp
  • Color
  • Rgbe
  • Rgbea
  • Rgba_16
  • Rgb_16
  • Sint8
  • Sint32 - eg: for object_id canvas_content.
  • Float32 - eg: for depth canvas_content.
  • Float32<2>
  • Float32<3> - eg: for normal (or any 3D space related) canvas_content.
  • Float32<4> - eg: for texture_coordinate[n] canvas_content.

• "canvas_resolution_x" : Uint32

  Horizontal render resolution.

• "canvas_resolution_y" : Uint32

  Vertical render resolution.

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

A canvas containing the rendered image.

groups

• render
• scene