godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EngineProfiler.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

40 lines
1.7 KiB
XML
Raw Normal View History

[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="EngineProfiler" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
<brief_description>
Base class for creating custom profilers.
</brief_description>
<description>
This class can be used to implement custom profilers that are able to interact with the engine and editor debugger.
Fix typos with codespell Using codespell 2.2-dev from current git. Added `misc/scripts/codespell.sh` to make it easier to run it once in a while and update the skip and ignore lists.
2022-02-10 11:00:11 +00:00
See [EngineDebugger] and [EditorDebuggerPlugin] for more information.
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_frame" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data" type="Array" />
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
<description>
Called when data is added to profiler using [method EngineDebugger.profiler_add_frame_data].
</description>
</method>
<method name="_tick" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="frame_time" type="float" />
<param index="1" name="process_time" type="float" />
<param index="2" name="physics_time" type="float" />
<param index="3" name="physics_frame_time" type="float" />
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
<description>
Rename profiler "Idle Time" to "Process Time" References to "idle time" are progressively being replaced by "process time" throughout the engine to avoid confusion.
2022-05-05 18:23:47 +00:00
Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better.
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
</description>
</method>
<method name="_toggle" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="enable" type="bool" />
<param index="1" name="options" type="Array" />
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 16:07:53 +00:00
Called when the profiler is enabled/disabled, along with a set of [param options].
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally.
2022-02-06 00:55:58 +00:00
</description>
</method>
</methods>
</class>