1/**************************************************************************/
2/* editor_performance_profiler.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef EDITOR_PERFORMANCE_PROFILER_H
32#define EDITOR_PERFORMANCE_PROFILER_H
33
34#include "core/templates/hash_map.h"
35#include "core/templates/rb_map.h"
36#include "main/performance.h"
37#include "scene/gui/control.h"
38#include "scene/gui/label.h"
39#include "scene/gui/split_container.h"
40#include "scene/gui/tree.h"
41
42class EditorPerformanceProfiler : public HSplitContainer {
43 GDCLASS(EditorPerformanceProfiler, HSplitContainer);
44
45private:
46 class Monitor {
47 public:
48 String name;
49 String base;
50 List<float> history;
51 float max = 0.0f;
52 TreeItem *item = nullptr;
53 Performance::MonitorType type = Performance::MONITOR_TYPE_QUANTITY;
54 int frame_index = 0;
55
56 Monitor();
57 Monitor(String p_name, String p_base, int p_frame_index, Performance::MonitorType p_type, TreeItem *p_item);
58 void update_value(float p_value);
59 void reset();
60 };
61
62 HashMap<StringName, Monitor> monitors;
63
64 HashMap<StringName, TreeItem *> base_map;
65 Tree *monitor_tree = nullptr;
66 Control *monitor_draw = nullptr;
67 Label *info_message = nullptr;
68 StringName marker_key;
69 int marker_frame = 0;
70 const int MARGIN = 4;
71 const int POINT_SEPARATION = 5;
72 const int MARKER_MARGIN = 2;
73
74 static String _create_label(float p_value, Performance::MonitorType p_type);
75 void _monitor_select();
76 void _monitor_draw();
77 void _build_monitor_tree();
78 TreeItem *_get_monitor_base(const StringName &p_base_name);
79 TreeItem *_create_monitor_item(const StringName &p_monitor_name, TreeItem *p_base);
80 void _marker_input(const Ref<InputEvent> &p_event);
81
82protected:
83 void _notification(int p_what);
84
85public:
86 void reset();
87 void update_monitors(const Vector<StringName> &p_names);
88 void add_profile_frame(const Vector<float> &p_values);
89 List<float> *get_monitor_data(const StringName &p_name);
90 EditorPerformanceProfiler();
91};
92
93#endif // EDITOR_PERFORMANCE_PROFILER_H
94