78f1543e35
A new tab is added to the debugger that can help profile a game's memory usage. Specifically, this lets you save a snapshot of all the objects in a running game's ObjectDB to disk. It then lets you view the snapshot and diff two snapshots against each other. This is meant to work similarly to Chrome's heap snapshot tool or Unity's memory profiler.
66 lines
3.2 KiB
C++
66 lines
3.2 KiB
C++
/**************************************************************************/
|
|
/* objectdb_profiler_plugin.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "editor/plugins/editor_debugger_plugin.h"
|
|
#include "editor/plugins/editor_plugin.h"
|
|
|
|
class ObjectDBProfilerPanel;
|
|
class ObjectDBProfilerDebuggerPlugin;
|
|
|
|
// First, ObjectDBProfilerPlugin is loaded. Then it loads ObjectDBProfilerDebuggerPlugin.
|
|
class ObjectDBProfilerPlugin : public EditorPlugin {
|
|
GDCLASS(ObjectDBProfilerPlugin, EditorPlugin);
|
|
|
|
protected:
|
|
Ref<ObjectDBProfilerDebuggerPlugin> debugger;
|
|
void _notification(int p_what);
|
|
|
|
public:
|
|
ObjectDBProfilerPlugin();
|
|
};
|
|
|
|
class ObjectDBProfilerDebuggerPlugin : public EditorDebuggerPlugin {
|
|
GDCLASS(ObjectDBProfilerDebuggerPlugin, EditorDebuggerPlugin);
|
|
|
|
protected:
|
|
ObjectDBProfilerPanel *debugger_panel = nullptr;
|
|
|
|
void _request_object_snapshot(int p_request_id);
|
|
|
|
public:
|
|
ObjectDBProfilerDebuggerPlugin() {}
|
|
|
|
virtual bool has_capture(const String &p_capture) const override;
|
|
virtual bool capture(const String &p_message, const Array &p_data, int p_index) override;
|
|
virtual void setup_session(int p_session_id) override;
|
|
};
|