BKE_callbacks.h File Reference

Go to the source code of this file.

Classes
struct	bCallbackFuncStore

Typedefs
typedef struct bCallbackFuncStore	bCallbackFuncStore

Enumerations
enum	eCbEvent {   BKE_CB_EVT_FRAME_CHANGE_PRE , BKE_CB_EVT_FRAME_CHANGE_POST , BKE_CB_EVT_RENDER_PRE , BKE_CB_EVT_RENDER_POST ,   BKE_CB_EVT_RENDER_WRITE , BKE_CB_EVT_RENDER_STATS , BKE_CB_EVT_RENDER_INIT , BKE_CB_EVT_RENDER_COMPLETE ,   BKE_CB_EVT_RENDER_CANCEL , BKE_CB_EVT_LOAD_PRE , BKE_CB_EVT_LOAD_POST , BKE_CB_EVT_SAVE_PRE ,   BKE_CB_EVT_SAVE_POST , BKE_CB_EVT_UNDO_PRE , BKE_CB_EVT_UNDO_POST , BKE_CB_EVT_REDO_PRE ,   BKE_CB_EVT_REDO_POST , BKE_CB_EVT_DEPSGRAPH_UPDATE_PRE , BKE_CB_EVT_DEPSGRAPH_UPDATE_POST , BKE_CB_EVT_VERSION_UPDATE ,   BKE_CB_EVT_LOAD_FACTORY_USERDEF_POST , BKE_CB_EVT_LOAD_FACTORY_STARTUP_POST , BKE_CB_EVT_TOT }

Functions
void	BKE_callback_exec (struct Main *bmain, struct PointerRNA **pointers, const int num_pointers, eCbEvent evt)
void	BKE_callback_exec_null (struct Main *bmain, eCbEvent evt)
void	BKE_callback_exec_id (struct Main *bmain, struct ID *id, eCbEvent evt)
void	BKE_callback_exec_id_depsgraph (struct Main *bmain, struct ID *id, struct Depsgraph *depsgraph, eCbEvent evt)
void	BKE_callback_add (bCallbackFuncStore *funcstore, eCbEvent evt)
void	BKE_callback_global_init (void)
void	BKE_callback_global_finalize (void)

Typedef Documentation

bCallbackFuncStore

typedef struct bCallbackFuncStore bCallbackFuncStore

Enumeration Type Documentation

eCbEvent

enum eCbEvent

Common suffix uses:

• _PRE/_POST: For handling discrete non-interactive events.
• _INIT/_COMPLETE/_CANCEL: For handling jobs (which may in turn cause other handlers to be called).

Enumerator
BKE_CB_EVT_FRAME_CHANGE_PRE
BKE_CB_EVT_FRAME_CHANGE_POST
BKE_CB_EVT_RENDER_PRE
BKE_CB_EVT_RENDER_POST
BKE_CB_EVT_RENDER_WRITE
BKE_CB_EVT_RENDER_STATS
BKE_CB_EVT_RENDER_INIT
BKE_CB_EVT_RENDER_COMPLETE
BKE_CB_EVT_RENDER_CANCEL
BKE_CB_EVT_LOAD_PRE
BKE_CB_EVT_LOAD_POST
BKE_CB_EVT_SAVE_PRE
BKE_CB_EVT_SAVE_POST
BKE_CB_EVT_UNDO_PRE
BKE_CB_EVT_UNDO_POST
BKE_CB_EVT_REDO_PRE
BKE_CB_EVT_REDO_POST
BKE_CB_EVT_DEPSGRAPH_UPDATE_PRE
BKE_CB_EVT_DEPSGRAPH_UPDATE_POST
BKE_CB_EVT_VERSION_UPDATE
BKE_CB_EVT_LOAD_FACTORY_USERDEF_POST
BKE_CB_EVT_LOAD_FACTORY_STARTUP_POST
BKE_CB_EVT_TOT

Definition at line 39 of file BKE_callbacks.h.

Function Documentation

BKE_callback_add()

void BKE_callback_add	(	bCallbackFuncStore *	funcstore,
		eCbEvent	evt
	)

Definition at line 77 of file callbacks.c.

References BLI_addtail(), and callback_slots.

Referenced by BPY_app_handlers_struct(), and FRS_init().

BKE_callback_exec()

void BKE_callback_exec	(	struct Main *	bmain,
		struct PointerRNA **	pointers,
		const int	num_pointers,
		eCbEvent	evt
	)

Definition at line 33 of file callbacks.c.

References bCallbackFuncStore::arg, callback_slots, ListBase::first, bCallbackFuncStore::func, and bCallbackFuncStore::next.

Referenced by BKE_callback_exec_id(), BKE_callback_exec_id_depsgraph(), and BKE_callback_exec_null().

BKE_callback_exec_id()

void BKE_callback_exec_id	(	struct Main *	bmain,
		struct ID *	id,
		eCbEvent	evt
	)

Definition at line 51 of file callbacks.c.

References BKE_callback_exec(), and RNA_id_pointer_create().

Referenced by BKE_scene_graph_update_for_newframe_ex(), ed_undo_step_post(), ed_undo_step_pre(), render_callback_exec_id(), and scene_graph_update_tagged().

BKE_callback_exec_id_depsgraph()

void BKE_callback_exec_id_depsgraph	(	struct Main *	bmain,
		struct ID *	id,
		struct Depsgraph *	depsgraph,
		eCbEvent	evt
	)

Definition at line 61 of file callbacks.c.

References BKE_callback_exec(), depsgraph, NULL, RNA_Depsgraph, RNA_id_pointer_create(), and RNA_pointer_create().

Referenced by BKE_scene_graph_update_for_newframe_ex(), and scene_graph_update_tagged().

BKE_callback_exec_null()

void BKE_callback_exec_null	(	struct Main *	bmain,
		eCbEvent	evt
	)

Definition at line 46 of file callbacks.c.

References BKE_callback_exec(), and NULL.

Referenced by render_callback_exec_null(), stats_background(), wm_file_read_post(), wm_file_read_pre(), wm_file_write(), wm_homefile_write_exec(), and WM_init().

BKE_callback_global_finalize()

void BKE_callback_global_finalize

(

void

)

Definition at line 89 of file callbacks.c.

References bCallbackFuncStore::alloc, BKE_CB_EVT_TOT, BLI_remlink(), callback_slots, ListBase::first, MEM_freeN, and bCallbackFuncStore::next.

Referenced by BKE_blender_free().

BKE_callback_global_init()

void BKE_callback_global_init

(

void

)

Definition at line 83 of file callbacks.c.

Referenced by main().