Depsgraph: Make it more clear that we dump relations into graphviz
[blender.git] / source / blender / depsgraph / DEG_depsgraph_debug.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2014 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Lukas Toenne
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/DEG_depsgraph_debug.h
28  *  \ingroup depsgraph
29  *
30  * Public API for Querying and Filtering Depsgraph
31  */
32
33 #ifndef __DEG_DEPSGRAPH_DEBUG_H__
34 #define __DEG_DEPSGRAPH_DEBUG_H__
35
36 #include <stdio.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Depsgraph;
43
44 /* ------------------------------------------------ */
45
46 void DEG_stats_simple(const struct Depsgraph *graph,
47                       size_t *r_outer,
48                       size_t *r_operations,
49                       size_t *r_relations);
50
51 /* ************************************************ */
52 /* Diagram-Based Graph Debugging */
53
54 void DEG_debug_relations_graphviz(const struct Depsgraph *graph,
55                                   FILE *stream,
56                                   const char *label);
57
58 /* ************************************************ */
59
60 /* Compare two dependency graphs. */
61 bool DEG_debug_compare(const struct Depsgraph *graph1,
62                        const struct Depsgraph *graph2);
63
64 /* Check that dependnecies in the graph are really up to date. */
65 bool DEG_debug_scene_relations_validate(struct Main *bmain,
66                                         struct Scene *scene);
67
68
69 /* Perform consistency check on the graph. */
70 bool DEG_debug_consistency_check(struct Depsgraph *graph);
71
72 #ifdef __cplusplus
73 } /* extern "C" */
74 #endif
75
76 #endif  /* __DEG_DEPSGRAPH_DEBUG_H__ */