RealityServer® 6.4

render_batch_irt

Renders using Iray Interactive mode for a fixed number of iterations.

arguments

• "canvas_content" : String (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
  • lpexpr=lp-expression
  • result lpexpr=lp-expression
  • alpha
  • alpha lpexpr=lp-expression
  • depth
  • distance
  • normal
  • texture_coordinate[n] - n is the texture coordinate index to return.
  • object_id
  • material_id
  • generated_material_id
  • diffuse
  • specular
  • glossy
  • emission
  • shadow
  • ambient_occlusion
  • irradiance
  • irradiance lpexpr=lp-expression
  • irradiance probe
  • irradiance probe lpexpr=lp-expression
  • 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.
  Defaults to a random uuid.

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

  The image format to return.
  

  Possible Values:

  • jpg
  • png
  • tif
  • exr
  • hdr
  • ct
  • array

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

  The pixel type of the returned image.
  

  Possible Values:

  • Rgb
  • Rgba
  • Rgb_fp
  • Color
  • Rgbe
  • Rgbea
  • Rgba_16
  • Rgb_16
  • Sint8
  • Sint32
  • Float32
  • Float32<2>
  • Float32<3>
  • Float32<4>

• "quality" : String (default: "90")

  The quality of the returned image.
  

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

• "scene_name" : String

  The name of the scene to render.

return value

The rendered image result.

groups

• javascript
• render