1/**************************************************************************/
2/* engine_profiler.cpp */
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#include "engine_profiler.h"
32
33#include "core/debugger/engine_debugger.h"
34
35void EngineProfiler::_bind_methods() {
36 GDVIRTUAL_BIND(_toggle, "enable", "options");
37 GDVIRTUAL_BIND(_add_frame, "data");
38 GDVIRTUAL_BIND(_tick, "frame_time", "process_time", "physics_time", "physics_frame_time");
39}
40
41void EngineProfiler::toggle(bool p_enable, const Array &p_array) {
42 GDVIRTUAL_CALL(_toggle, p_enable, p_array);
43}
44
45void EngineProfiler::add(const Array &p_data) {
46 GDVIRTUAL_CALL(_add_frame, p_data);
47}
48
49void EngineProfiler::tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) {
50 GDVIRTUAL_CALL(_tick, p_frame_time, p_process_time, p_physics_time, p_physics_frame_time);
51}
52
53Error EngineProfiler::bind(const String &p_name) {
54 ERR_FAIL_COND_V(is_bound(), ERR_ALREADY_IN_USE);
55 EngineDebugger::Profiler prof(
56 this,
57 [](void *p_user, bool p_enable, const Array &p_opts) {
58 static_cast<EngineProfiler *>(p_user)->toggle(p_enable, p_opts);
59 },
60 [](void *p_user, const Array &p_data) {
61 static_cast<EngineProfiler *>(p_user)->add(p_data);
62 },
63 [](void *p_user, double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) {
64 static_cast<EngineProfiler *>(p_user)->tick(p_frame_time, p_process_time, p_physics_time, p_physics_frame_time);
65 });
66 registration = p_name;
67 EngineDebugger::register_profiler(p_name, prof);
68 return OK;
69}
70
71Error EngineProfiler::unbind() {
72 ERR_FAIL_COND_V(!is_bound(), ERR_UNCONFIGURED);
73 EngineDebugger::unregister_profiler(registration);
74 registration.clear();
75 return OK;
76}
77
78EngineProfiler::~EngineProfiler() {
79 if (is_bound()) {
80 unbind();
81 }
82}
83