patch [#28218] During-render callback functionality
authorCampbell Barton <ideasman42@gmail.com>
Wed, 31 Aug 2011 10:43:22 +0000 (10:43 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Wed, 31 Aug 2011 10:43:22 +0000 (10:43 +0000)
commitfde215025eff7f3581435bfdb90fb9d354538d07
tree00769a9db2b382d8ce08e6b622b450bdb5f63d3f
parentd0d82c69e96e96845a59ad625900a94187dac621
patch [#28218] During-render callback functionality
from Jesse Kaukonen (gekko)

--- text from the patch.

Recently Campbell Barton added callback functionality for Python's usage, but this only includes pre- and post-render callbacks. There are no callbacks for the duration of the render. This patch adds the few lines required for executing a callback while Blender Render is working. The callback resides in the rendering pipeline stats function, so whenever statistics are printed, the callback is executed. This functionality is required if one wants to:

1) Observe what is happening while Blender is rendering via the command line
2) Add custom statistics that Blender prints while the renderer works
3) The user wants to continue executing his Python script without the code halting at bpy.ops.render.render()

Personally I'm currently using this for printing out more detailed progress reports at Renderfarm.fi (such as CPU time, time spent rendering, total progress in regards to the entire rendering process). Tested on Windows, Linux and OS X.

Example on how to use the callback:

  def statscall(context): print("Thanks for calling!")
  bpy.app.handlers.render_stats.append(statscall)
  bpy.ops.render.render(animation=False, write_still=True)
source/blender/blenlib/BLI_callbacks.h
source/blender/python/intern/bpy_app_handlers.c
source/blender/render/intern/source/pipeline.c