godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-03 16:55:53 +00:00
Code Releases Wiki Activity

Merge pull request #112725 from Ivorforce/profiling-comments

Browse Source 
Add some comments in the profiling.h header.
This commit is contained in:
Thaddeus Crews
2025-11-14 14:22:53 -06:00
parent f66fc72374 9ebe051d5c
commit c52c93e2a2
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
core/profiling/profiling.h
View File

@@ -33,6 +33,16 @@
#include "core/typedefs.h"
#include "profiling.gen.h"
// This header provides profiling primitives (implemented as macros) for various backends.
// See the "No profiling" branch at the bottom for a short description of the functions.
// To configure / use the profiler, use the --profiler_path and other --profiler_* arguments
// when compiling Godot. You can also find details in the SCSub file (in this folder).
// Note: It is highly recommended to avoid including this header in other header files.
// Prefer including it in .cpp files only. The reason is that we want to keep
// the recompile cost of changing the profiler as low as possible.
#if defined(GODOT_USE_TRACY)
// Use the tracy profiler.
@@ -95,10 +105,17 @@ void godot_init_profiler();
void godot_init_profiler();
// Tell the profiling backend that a new frame has started.
#define GodotProfileFrameMark
// Defines a profile zone from here to the end of the scope.
#define GodotProfileZone(m_zone_name)
// Defines a profile zone group. The first profile zone starts immediately,
// and ends either when the next zone starts, or when the scope ends.
#define GodotProfileZoneGroupedFirst(m_group_name, m_zone_name)
// End the profile zone group's current profile zone now.
#define GodotProfileZoneGroupedEndEarly(m_group_name, m_zone_name)
// Replace the profile zone group's current profile zone.
// The new zone ends either when the next zone starts, or when the scope ends.
#define GodotProfileZoneGrouped(m_group_name, m_zone_name)
#endif