DEG_depsgraph_debug.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2014 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <cstdio>
 
#include "BLI_string_ref.hh"
 
struct Depsgraph;
struct Main;
struct Scene;
struct ViewLayer;
 
/* ------------------------------------------------ */
 
/* NOTE: Those flags are same bit-mask as #G.debug_flags */
 
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);
 
/* ************************************************ */
/* Diagram-Based Graph Debugging */
 
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);