diff options
Diffstat (limited to 'source/blender/depsgraph/DEG_depsgraph_build.h')
| -rw-r--r-- | source/blender/depsgraph/DEG_depsgraph_build.h | 43 |
1 files changed, 27 insertions, 16 deletions
diff --git a/source/blender/depsgraph/DEG_depsgraph_build.h b/source/blender/depsgraph/DEG_depsgraph_build.h index c029d203574..94cba833096 100644 --- a/source/blender/depsgraph/DEG_depsgraph_build.h +++ b/source/blender/depsgraph/DEG_depsgraph_build.h @@ -50,17 +50,22 @@ extern "C" { /* Graph Building -------------------------------- */ -/* Build depsgraph for the given scene, and dump results in given graph container. */ +/** Build depsgraph for the given scene layer, and dump results in given graph container. */ void DEG_graph_build_from_view_layer(struct Depsgraph *graph); -/* Build depsgraph for all objects (so also invisible ones) in the given view layer. */ +/** + * Build depsgraph for all objects (so also invisible ones) in the given view layer. + */ void DEG_graph_build_for_all_objects(struct Depsgraph *graph); -/* Special version of builder which produces dependency graph suitable for the render pipeline. - * It will contain sequencer and compositor (if needed) and all their dependencies. */ +/** + * Special version of builder which produces dependency graph suitable for the render pipeline. + * It will contain sequencer and compositor (if needed) and all their dependencies. + */ void DEG_graph_build_for_render_pipeline(struct Depsgraph *graph); -/* Builds minimal dependency graph for compositor preview. +/** + * Builds minimal dependency graph for compositor preview. * * Note that compositor editor might have pinned node tree, which is different from scene's node * tree. @@ -69,18 +74,19 @@ void DEG_graph_build_for_compositor_preview(struct Depsgraph *graph, struct bNod void DEG_graph_build_from_ids(struct Depsgraph *graph, struct ID **ids, const int num_ids); -/* Tag relations from the given graph for update. */ +/** Tag relations from the given graph for update. */ void DEG_graph_tag_relations_update(struct Depsgraph *graph); -/* Create or update relations in the specified graph. */ +/** Create or update relations in the specified graph. */ void DEG_graph_relations_update(struct Depsgraph *graph); -/* Tag all relations in the database for update. */ +/** Tag all relations in the database for update. */ void DEG_relations_tag_update(struct Main *bmain); /* Add Dependencies ----------------------------- */ -/* Handle for components to define their dependencies from callbacks. +/** + * Handle for components to define their dependencies from callbacks. * This is generated by the depsgraph and passed to dependency callbacks * as a symbolic reference to the current DepsNode. * All relations will be defined in reference to that node. @@ -159,23 +165,28 @@ void DEG_add_object_cache_relation(struct DepsNodeHandle *handle, struct CacheFile *cache_file, eDepsObjectComponentType component, const char *description); -/* Adds relation from DEG_OPCODE_GENERIC_DATABLOCK_UPDATE of a given ID. - * Is used for such entities as textures and images. */ +/** + * Adds relation from #DEG_OPCODE_GENERIC_DATABLOCK_UPDATE of a given ID. + * Is used for such entities as textures and images. + */ void DEG_add_generic_id_relation(struct DepsNodeHandle *node_handle, struct ID *id, const char *description); -/* Special function which is used from modifiers' updateDepsgraph() callback +/** + * Special function which is used from modifiers' #updateDepsgraph() callback * to indicate that the modifier needs to know transformation of the object * which that modifier belongs to. * This function will take care of checking which operation is required to - * have transformation for the modifier, taking into account possible simulation - * solvers. */ + * have transformation for the modifier, taking into account possible simulation solvers. + */ void DEG_add_modifier_to_transform_relation(struct DepsNodeHandle *node_handle, const char *description); -/* Adds relations from the given component of a given object to the given node - * handle AND the component to the point cache component of the node's ID. */ +/** + * Adds relations from the given component of a given object to the given node + * handle AND the component to the point cache component of the node's ID. + */ void DEG_add_object_pointcache_relation(struct DepsNodeHandle *node_handle, struct Object *object, eDepsObjectComponentType component, |