godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Allow custom monitors to select desired type

Browse Source
This commit is contained in:
devloglogan
2025-09-09 21:34:22 -05:00
parent 9cd297b6f2
commit 1a8306bbc1
9 changed files with 151 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/classes/Performance.xml
View File

@@ -18,6 +18,7 @@
<param index="0" name="id" type="StringName" />
<param index="1" name="callable" type="Callable" />
<param index="2" name="arguments" type="Array" default="[]" />
<param index="3" name="type" type="int" enum="Performance.MonitorType" default="0" />
<description>
Adds a custom monitor with the name [param id]. You can specify the category of the monitor using slash delimiters in [param id] (for example: [code]"Game/NumberOfNPCs"[/code]). If there is more than one slash delimiter, then the default category is used. The default category is [code]"Custom"[/code]. Prints an error if given [param id] is already present.
[codeblocks]
@@ -84,6 +85,12 @@
Returns the names of active custom monitors in an [Array].
</description>
</method>
<method name="get_custom_monitor_types">
<return type="PackedInt32Array" />
<description>
Returns the [enum MonitorType] values of active custom monitors in an [Array].
</description>
</method>
<method name="get_monitor" qualifiers="const">
<return type="float" />
<param index="0" name="monitor" type="int" enum="Performance.Monitor" />
@@ -303,5 +310,17 @@
<constant name="MONITOR_MAX" value="59" enum="Monitor">
Represents the size of the [enum Monitor] enum.
</constant>
<constant name="MONITOR_TYPE_QUANTITY" value="0" enum="MonitorType">
Monitor output is formatted as an integer value.
</constant>
<constant name="MONITOR_TYPE_MEMORY" value="1" enum="MonitorType">
Monitor output is formatted as computer memory. Submitted values should represent a number of bytes.
</constant>
<constant name="MONITOR_TYPE_TIME" value="2" enum="MonitorType">
Monitor output is formatted as time in milliseconds. Submitted values should represent a time in seconds (not milliseconds).
</constant>
<constant name="MONITOR_TYPE_PERCENTAGE" value="3" enum="MonitorType">
Monitor output is formatted as a percentage. Submitted values should represent a fractional value rather than the percentage directly, e.g. [code]0.5[/code] for [code]50.00%[/code].
</constant>
</constants>
</class>