RealityServer® 6.4

render_loop_get_render_progress

Returns a value indicating progressive render progress for the given render loop, or a Map containing all progress.

Currently only the iray and hybrid renderers are supported.

arguments

• "area" : String (default: null)

  The area of progression to return progress for. If not given then a map containing all progress values is returned.

  Possible Values:

  • "progression" (iray/hybrid) - Estimated progression between 0 and 1, indicating progress until error threshold is reached.
  • "error" (iray/hybrid) - Current estimate of per-pixel error.
  • "iteration" (iray/hybrid) - Number of iterations accumulated in the current progression.

• "render_loop_name" : String

  The name of the render loop.

return value

Some value which gives information about how much work has progressed. The interpretation depends on the area argument. In some areas it might be a percentage, in some it might be an absolute value. The value will be -1 if an unsupported area is requested or no progress data is available yet. If no area argument is provided thena map of all progress is returned.

groups

• render
• scene
• render loop