#include <cstdio>
#include <string>
#include "BLI_string_ref.hh"

Functions
void	DEG_debug_flags_set (Depsgraph *depsgraph, int flags)
int	DEG_debug_flags_get (const Depsgraph *depsgraph)
void	DEG_debug_name_set (Depsgraph depsgraph, const char name)
const char *	DEG_debug_name_get (Depsgraph *depsgraph)
void	DEG_stats_simple (const Depsgraph graph, size_t r_outer, size_t r_operations, size_t r_relations)
std::string	DEG_debug_graph_to_dot (const Depsgraph &graph, blender::StringRef label)
void	DEG_debug_stats_gnuplot (const Depsgraph graph, FILE fp, const char label, const char output_filename)
bool	DEG_debug_compare (const Depsgraph graph1, const Depsgraph graph2)
bool	DEG_debug_graph_relations_validate (Depsgraph graph, Main bmain, Scene scene, ViewLayer view_layer)
bool	DEG_debug_consistency_check (Depsgraph *graph)
std::string	DEG_stringify_recalc_flags (unsigned int flags)

Detailed Description

Public API for Querying and Filtering Depsgraph

Definition in file DEG_depsgraph_debug.hh.

Function Documentation

◆ DEG_debug_compare()

bool DEG_debug_compare	(	const Depsgraph *	graph1,
		const Depsgraph *	graph2 )

Compare two dependency graphs.

Definition at line 55 of file depsgraph_debug.cc.

References BLI_assert, blender::deg::Depsgraph::operations, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

Referenced by DEG_debug_graph_relations_validate().

◆ DEG_debug_consistency_check()

bool DEG_debug_consistency_check ( Depsgraph * graph )

Perform consistency check on the graph.

Definition at line 90 of file depsgraph_debug.cc.

References BLI_assert, blender::deg::Node::custom_flags, blender::deg::Relation::from, blender::deg::OperationNode::identifier(), blender::deg::Node::inlinks, blender::deg::OperationNode::num_links_pending, blender::deg::OPERATION, blender::deg::Depsgraph::operations, blender::deg::Node::outlinks, printf, blender::Vector< T, InlineBufferCapacity, Allocator >::size(), blender::deg::Relation::to, and blender::deg::Node::type.

Referenced by blender::deg::AbstractBuilderPipeline::build_step_finalize().

◆ DEG_debug_flags_get()

int DEG_debug_flags_get ( const Depsgraph * depsgraph )

Definition at line 37 of file depsgraph_debug.cc.

References blender::deg::Depsgraph::debug, depsgraph, and blender::deg::DepsgraphDebug::flags.

Referenced by DEG_debug_print_eval(), DEG_debug_print_eval_parent_typed(), DEG_debug_print_eval_subdata(), DEG_debug_print_eval_subdata_index(), DEG_debug_print_eval_time(), and blender::deg::graph_id_tag_update().

◆ DEG_debug_flags_set()

void DEG_debug_flags_set	(	Depsgraph *	depsgraph,
		int	flags )

Definition at line 31 of file depsgraph_debug.cc.

References blender::deg::Depsgraph::debug, depsgraph, and blender::deg::DepsgraphDebug::flags.

◆ DEG_debug_graph_relations_validate()

bool DEG_debug_graph_relations_validate	(	Depsgraph *	graph,
		Main *	bmain,
		Scene *	scene,
		ViewLayer *	view_layer )

Check that dependencies in the graph are really up to date.

Definition at line 73 of file depsgraph_debug.cc.

References BLI_assert_msg, DEG_debug_compare(), DEG_get_mode(), DEG_graph_build_from_view_layer(), DEG_graph_free(), and DEG_graph_new().

◆ DEG_debug_graph_to_dot()

std::string DEG_debug_graph_to_dot	(	const Depsgraph &	graph,
		blender::StringRef	label )

Definition at line 505 of file deg_debug_relations_graphviz.cc.

References blender::dot_export::Graph::attributes, blender::deg::deg_debug_graphviz_fontname, blender::deg::deg_debug_graphviz_graph_label_size, blender::deg::deg_debug_graphviz_graph_nodes(), blender::deg::deg_debug_graphviz_graph_relations(), blender::deg::deg_debug_graphviz_legend(), blender::dot_export::LeftToRight, blender::dot_export::Attributes::set(), blender::dot_export::Graph::set_rankdir(), and blender::dot_export::DirectedGraph::to_dot_string().

◆ DEG_debug_name_get()

const char * DEG_debug_name_get ( Depsgraph * depsgraph )

Definition at line 49 of file depsgraph_debug.cc.

References blender::deg::Depsgraph::debug, depsgraph, and blender::deg::DepsgraphDebug::name.

Referenced by depsgraph_name_for_logging().

◆ DEG_debug_name_set()

void DEG_debug_name_set	(	Depsgraph *	depsgraph,
		const char *	name )

Definition at line 43 of file depsgraph_debug.cc.

References blender::deg::Depsgraph::debug, depsgraph, blender::deg::DepsgraphDebug::name, and name.

Referenced by blender::ed::space_node::compo_initjob(), engine_depsgraph_init(), blender::seq::get_depsgraph_for_scene_strip(), render_init_depsgraph(), scene_ensure_depsgraph_p(), and blender::seq::seq_prefetch_init_depsgraph().

◆ DEG_debug_stats_gnuplot()

void DEG_debug_stats_gnuplot	(	const Depsgraph *	graph,
		FILE *	fp,
		const char *	label,
		const char *	output_filename )

Definition at line 138 of file deg_debug_stats_gnuplot.cc.

References depsgraph.

◆ DEG_stats_simple()

void DEG_stats_simple	(	const Depsgraph *	graph,
		size_t *	r_outer,
		size_t *	r_operations,
		size_t *	r_relations )

Obtain simple statistics about the complexity of the depsgraph.

Parameters

[out]	r_outer	The number of outer nodes in the graph.
[out]	r_operations	The number of operation nodes in the graph.
[out]	r_relations	The number of relations between (executable) nodes in the graph.

Definition at line 183 of file depsgraph_debug.cc.

References blender::deg::IDNode::components, blender::deg::Depsgraph::find_time_source(), blender::deg::Depsgraph::id_nodes, blender::deg::Node::inlinks, blender::deg::Depsgraph::operations, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

◆ DEG_stringify_recalc_flags()

std::string DEG_stringify_recalc_flags ( unsigned int flags )

Convert bit-flag representation of recalculation flags to string that consists of human-readable names of recalculation bits that are set in the given mask.

If flags == 0 the result is "NONE".

Example: DEG_stringify_recalc_flags(ID_RECALC_GEOMETRY | ID_RECALC_SHADING) -> "GEOMETRY, SHADING".

Definition at line 377 of file depsgraph_debug.cc.

References bitscan_forward_clear_uint(), ID_RECALC_PSYS_ALL, result, and stringify_append_bit().

Functions