2017-01-16 08:04:19 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* editor_profiler.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2017-01-16 08:04:19 +01:00
|
|
|
/*************************************************************************/
|
2020-01-01 11:16:22 +01:00
|
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
2017-01-16 08:04:19 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2016-05-22 02:18:16 +02:00
|
|
|
#ifndef EDITORPROFILER_H
|
|
|
|
#define EDITORPROFILER_H
|
|
|
|
|
|
|
|
#include "scene/gui/box_container.h"
|
|
|
|
#include "scene/gui/button.h"
|
|
|
|
#include "scene/gui/label.h"
|
|
|
|
#include "scene/gui/option_button.h"
|
|
|
|
#include "scene/gui/spin_box.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "scene/gui/split_container.h"
|
|
|
|
#include "scene/gui/texture_rect.h"
|
|
|
|
#include "scene/gui/tree.h"
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
class EditorProfiler : public VBoxContainer {
|
2019-03-19 19:35:57 +01:00
|
|
|
GDCLASS(EditorProfiler, VBoxContainer);
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
public:
|
|
|
|
struct Metric {
|
2020-11-24 10:12:55 +01:00
|
|
|
bool valid = false;
|
2016-05-22 02:18:16 +02:00
|
|
|
|
2020-11-24 10:12:55 +01:00
|
|
|
int frame_number = 0;
|
|
|
|
float frame_time = 0;
|
|
|
|
float idle_time = 0;
|
|
|
|
float physics_time = 0;
|
|
|
|
float physics_frame_time = 0;
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
struct Category {
|
|
|
|
StringName signature;
|
|
|
|
String name;
|
2020-11-24 10:12:55 +01:00
|
|
|
float total_time = 0; //total for category
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
struct Item {
|
|
|
|
StringName signature;
|
|
|
|
String name;
|
|
|
|
String script;
|
2020-11-24 10:12:55 +01:00
|
|
|
int line = 0;
|
|
|
|
float self = 0;
|
|
|
|
float total = 0;
|
|
|
|
int calls = 0;
|
2016-05-22 02:18:16 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
Vector<Item> items;
|
|
|
|
};
|
|
|
|
|
|
|
|
Vector<Category> categories;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Map<StringName, Category *> category_ptrs;
|
|
|
|
Map<StringName, Category::Item *> item_ptrs;
|
2016-05-22 02:18:16 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
enum DisplayMode {
|
|
|
|
DISPLAY_FRAME_TIME,
|
|
|
|
DISPLAY_AVERAGE_TIME,
|
|
|
|
DISPLAY_FRAME_PERCENT,
|
2017-09-30 16:19:07 +02:00
|
|
|
DISPLAY_PHYSICS_FRAME_PERCENT,
|
2016-05-22 02:18:16 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
enum DisplayTime {
|
|
|
|
DISPLAY_TOTAL_TIME,
|
|
|
|
DISPLAY_SELF_TIME,
|
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
|
|
|
Button *activate;
|
2018-06-24 03:15:10 +02:00
|
|
|
Button *clear_button;
|
2017-01-12 22:27:27 +01:00
|
|
|
TextureRect *graph;
|
2016-05-22 02:18:16 +02:00
|
|
|
Ref<ImageTexture> graph_texture;
|
2020-02-17 22:06:54 +01:00
|
|
|
Vector<uint8_t> graph_image;
|
2016-05-22 02:18:16 +02:00
|
|
|
Tree *variables;
|
|
|
|
HSplitContainer *h_split;
|
|
|
|
|
|
|
|
Set<StringName> plot_sigs;
|
|
|
|
|
|
|
|
OptionButton *display_mode;
|
|
|
|
OptionButton *display_time;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
SpinBox *cursor_metric_edit;
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
Vector<Metric> frame_metrics;
|
|
|
|
int last_metric;
|
|
|
|
|
|
|
|
int max_functions;
|
|
|
|
|
|
|
|
bool updating_frame;
|
|
|
|
|
|
|
|
//int cursor_metric;
|
|
|
|
int hover_metric;
|
|
|
|
|
2016-05-22 04:20:49 +02:00
|
|
|
float graph_height;
|
|
|
|
|
2016-05-22 02:18:16 +02:00
|
|
|
bool seeking;
|
|
|
|
|
|
|
|
Timer *frame_delay;
|
|
|
|
Timer *plot_delay;
|
|
|
|
|
|
|
|
void _update_frame();
|
|
|
|
|
|
|
|
void _activate_pressed();
|
2018-06-24 03:15:10 +02:00
|
|
|
void _clear_pressed();
|
2016-05-22 02:18:16 +02:00
|
|
|
|
2018-07-25 03:11:03 +02:00
|
|
|
String _get_time_as_text(const Metric &m, float p_time, int p_calls);
|
2016-05-22 02:18:16 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void _make_metric_ptrs(Metric &m);
|
2016-05-22 02:18:16 +02:00
|
|
|
void _item_edited();
|
|
|
|
|
|
|
|
void _update_plot();
|
|
|
|
|
|
|
|
void _graph_tex_mouse_exit();
|
|
|
|
|
|
|
|
void _graph_tex_draw();
|
2017-05-20 17:38:03 +02:00
|
|
|
void _graph_tex_input(const Ref<InputEvent> &p_ev);
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
int _get_cursor_index() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Color _get_color_from_signature(const StringName &p_signature) const;
|
2016-05-22 02:18:16 +02:00
|
|
|
|
|
|
|
void _cursor_metric_changed(double);
|
|
|
|
|
|
|
|
void _combo_changed(int);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
|
|
|
void add_frame_metric(const Metric &p_metric, bool p_final = false);
|
2016-05-22 02:18:16 +02:00
|
|
|
void set_enabled(bool p_enable);
|
|
|
|
bool is_profiling();
|
|
|
|
bool is_seeking() { return seeking; }
|
|
|
|
void disable_seeking();
|
|
|
|
|
|
|
|
void clear();
|
|
|
|
|
2020-03-17 07:33:00 +01:00
|
|
|
Vector<Vector<String>> get_data_as_csv() const;
|
2019-02-18 01:25:26 +01:00
|
|
|
|
2016-05-22 02:18:16 +02:00
|
|
|
EditorProfiler();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // EDITORPROFILER_H
|