godot/doc/classes/EngineProfiler.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EngineProfiler" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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.
		See [EngineDebugger] and [EditorDebuggerPlugin] for more information.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_add_frame" qualifiers="virtual">
			<return type="void" />
			<param index="0" name="data" type="Array" />
			<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" />
			<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" />
			<description>
				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.
			</description>
		</method>
		<method name="_toggle" qualifiers="virtual">
			<return type="void" />
			<param index="0" name="enable" type="bool" />
			<param index="1" name="options" type="Array" />
			<description>
				Called when the profiler is enabled/disabled, along with a set of [param options].
			</description>
		</method>
	</methods>
</class>
[Debugger] New extensible EngineProfiler class. Uses GDExtension, replaces old Callable system for profilers, and is also used internally. 2022-02-06 08:55:58 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="EngineProfiler" inherits="RefCounted" 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 08:55:58 +08: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 19:00:11 +08: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 08:55:58 +08: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-07 02:11:48 +08: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 08:55:58 +08: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-07 02:11:48 +08: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 08:55:58 +08: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-06 02:23:47 +08: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 08:55:58 +08:00			`</description>`
			`</method>`
			`<method name="_toggle" qualifiers="virtual">`
			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08: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 08:55:58 +08:00			`<description>`
[doc] Use "param" instead of "code" to refer to parameters (6) 2022-08-13 00:07:53 +08: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 08:55:58 +08:00			`</description>`
			`</method>`
			`</methods>`
			`</class>`