blender
/
blender
129
397
Fork 571
Code Issues 6.2k Pull Requests 750 Projects 19 Wiki Activity

Fix T77126: Documented frame_change_pre and frame_change_post handlers 

The documentation for the `frame_change_pre` and `frame_change_post`
handlers was really sparse, and suggested that `frame_change_pre` is
called before the frame changes. This is not the case; it's called after
the frame has changed, but before the dependency graph has been updated
for it.

No functional changes, just updated documentation.

Differential Revision: https://developer.blender.org/D7905

Reviewed by: sergey
This commit is contained in:
Sybren A. Stüvel 2020-06-02 16:33:35 +02:00
parent 6a70d7e09f
commit cdf0d95a50
Notes: blender-bot 2023-02-14 09:48:25 +01:00 
Referenced by issue #77126, Depsgraph not updating properly for `frame_change_pre` handler
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/blender/python/intern/bpy_app_handlers.c
View File

@ -44,8 +44,16 @@ void bpy_app_generic_callback(struct Main *main,
static PyTypeObject BlenderAppCbType;
static PyStructSequence_Field app_cb_info_fields[] = {
{"frame_change_pre", "on frame change for playback and rendering (before)"},
{"frame_change_post", "on frame change for playback and rendering (after)"},
{"frame_change_pre",
"Called after frame change for playback and rendering, before any data is evaluated for the "
"new frame. This makes it possible to change data and relations (for example swap an object "
"to another mesh) for the new frame. Note that this handler is **not** to be used as 'before "
"the frame changes' event. The dependency graph is not available in this handler, as data "
"and relations may have been altered and the dependency graph has not yet been updated for "
"that."},
{"frame_change_post",
"Called after frame change for playback and rendering, after the data has been evaluated "
"for the new frame."},
{"render_pre", "on render (before)"},
{"render_post", "on render (after)"},
{"render_write", "on writing a render frame (directly after the frame is written)"},