Blender V5.3
DEG_depsgraph.hh File Reference
#include "DNA_ID.h"

Go to the source code of this file.

Classes

struct  blender::DEGEditorUpdateContext

Namespaces

namespace  blender
 BMesh Iterators.

Enumerations

enum  blender::eEvaluationMode { blender::DAG_EVAL_VIEWPORT = 0 , blender::DAG_EVAL_RENDER = 1 }
enum  { blender::DAG_EVAL_NEED_CURVE_PATH = (1 << 0) , blender::DAG_EVAL_NEED_SHRINKWRAP_BOUNDARY = (1 << 1) }

Functions

CRUD
Depsgraph * blender::DEG_graph_new (Main *bmain, Scene *scene, ViewLayer *view_layer, eEvaluationMode mode)
void blender::DEG_graph_replace_owners (Depsgraph *depsgraph, Main *bmain, Scene *scene, ViewLayer *view_layer)
void blender::DEG_graph_free (Depsgraph *graph)
Node Types Registry
void blender::DEG_register_node_types ()
void blender::DEG_free_node_types ()
Update Tagging
void blender::DEG_graph_tag_on_visible_update (Depsgraph *depsgraph, bool do_time)
void blender::DEG_tag_on_visible_update (Main *bmain, bool do_time)
const char * blender::DEG_update_tag_as_string (IDRecalcFlag flag)
void blender::DEG_id_tag_update (ID *id, unsigned int flags)
void blender::DEG_id_tag_update_ex (Main *bmain, ID *id, unsigned int flags)
void blender::DEG_graph_id_tag_update (Main *bmain, Depsgraph *depsgraph, ID *id, unsigned int flags)
void blender::DEG_id_tag_update_for_side_effect_request (Depsgraph *depsgraph, ID *id, unsigned int flags)
void blender::DEG_time_tag_update (Main *bmain)
void blender::DEG_graph_time_tag_update (Depsgraph *depsgraph)
void blender::DEG_graph_id_type_tag (Depsgraph *depsgraph, short id_type)
void blender::DEG_id_type_tag (Main *bmain, short id_type)
void blender::DEG_enable_editors_update (Depsgraph *depsgraph)
void blender::DEG_editors_update (Depsgraph *depsgraph, bool time)
void blender::DEG_ids_clear_recalc (Depsgraph *depsgraph, bool backup)
void blender::DEG_ids_restore_recalc (Depsgraph *depsgraph)
Evaluation
bool blender::DEG_is_evaluating (const Depsgraph *depsgraph)
bool blender::DEG_is_active (const Depsgraph *depsgraph)
void blender::DEG_make_active (Depsgraph *depsgraph)
void blender::DEG_make_inactive (Depsgraph *depsgraph)
uint64_t blender::DEG_get_update_count (const Depsgraph *depsgraph)
void blender::DEG_disable_visibility_optimization (Depsgraph *depsgraph)
Evaluation Debug
void blender::DEG_debug_print_begin (Depsgraph *depsgraph)
void blender::DEG_debug_print_eval (Depsgraph *depsgraph, const char *function_name, const char *object_name, const void *object_address)
void blender::DEG_debug_print_eval_subdata (Depsgraph *depsgraph, const char *function_name, const char *object_name, const void *object_address, const char *subdata_comment, const char *subdata_name, const void *subdata_address)
void blender::DEG_debug_print_eval_subdata_index (Depsgraph *depsgraph, const char *function_name, const char *object_name, const void *object_address, const char *subdata_comment, const char *subdata_name, const void *subdata_address, int subdata_index)
void blender::DEG_debug_print_eval_parent_typed (Depsgraph *depsgraph, const char *function_name, const char *object_name, const void *object_address, const char *parent_comment, const char *parent_name, const void *parent_address)
void blender::DEG_debug_print_eval_time (Depsgraph *depsgraph, const char *function_name, const char *object_name, const void *object_address, float time)

Graph Evaluation

enum  blender::DepsgraphEvaluateSyncWriteback { blender::DEG_EVALUATE_SYNC_WRITEBACK_NO , blender::DEG_EVALUATE_SYNC_WRITEBACK_YES }
void blender::DEG_evaluate_on_framechange (Depsgraph *graph, float frame, DepsgraphEvaluateSyncWriteback sync_writeback=DEG_EVALUATE_SYNC_WRITEBACK_NO)
void blender::DEG_evaluate_on_refresh (Depsgraph *graph, DepsgraphEvaluateSyncWriteback sync_writeback=DEG_EVALUATE_SYNC_WRITEBACK_NO)

Editors Integration

Mechanism to allow editors to be informed of depsgraph updates, to do their own updates based on changes.

using blender::DEG_EditorUpdateIDCb = void (*)(const DEGEditorUpdateContext *update_ctx, ID *id)
using blender::DEG_EditorUpdateSceneCb = void (*)(const DEGEditorUpdateContext *update_ctx, bool updated)
void blender::DEG_editors_set_update_cb (DEG_EditorUpdateIDCb id_func, DEG_EditorUpdateSceneCb scene_func)

Detailed Description

Public API for Depsgraph

Dependency Graph

The dependency graph tracks relations between various pieces of data in a Blender file, but mainly just those which make up scene data. It is used to determine the set of operations need to ensure that all data has been correctly evaluated in response to changes, based on dependencies and visibility of affected data.

Evaluation Engine

The evaluation takes the operation-nodes the Depsgraph has tagged for updating, and schedules them up for being evaluated/executed such that the all dependency relationship constraints are satisfied.

Definition in file DEG_depsgraph.hh.