RealityServer® Web Services 4.4

render_loop_get_render_progress

Returns a value indicating progressive render progress for the given render loop.

Currently only the iray, hybrid and rt_bsp renderers are supported.

arguments

• "area" : String

  The area of progression to return progress for.

  Possible Values:

  • "progression" (iray/hybrid/rt_bsp in progressive rendering mode) - Estimated progression between 0 and 1, indicating progress until error threshold is reached.
  • "error" (iray/hybrid/rt_bsp in progressive rendering mode) - 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.

groups

• render
• scene
• render loop