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

doc: Proofread and complete various nodes

Browse Source 
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.

Also fixed some en_GB occurrences as the reference spelling is en_US.
This commit is contained in:
Rémi Verschelde
2019-06-26 15:57:13 +02:00
parent 43a6969470
commit 867dda1124
24 changed files with 301 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/classes/Performance.xml
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Performance" inherits="Object" category="Core" version="3.2">
<brief_description>
Exposes performance related data.
Exposes performance-related data.
</brief_description>
<description>
This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the [i]Monitor[/i] tab in the editor's [i]Debugger[/i] panel. By using the [method get_monitor] method of this class, you can access this data from your code. Note that a few of these monitors are only available in debug mode and will always return 0 when used in a release build.
@@ -16,7 +16,7 @@
<argument index="0" name="monitor" type="int" enum="Performance.Monitor">
</argument>
<description>
Returns the value of one of the available monitors. You should provide one of this class's constants as the argument, like this:
Returns the value of one of the available monitors. You should provide one of the [enum Monitor] constants as the argument, like this:
[codeblock]
print(Performance.get_monitor(Performance.TIME_FPS)) # Prints the FPS to the console
[/codeblock]
@@ -25,13 +25,13 @@
</methods>
<constants>
<constant name="TIME_FPS" value="0" enum="Monitor">
Frames per second.
Number of frames per second.
</constant>
<constant name="TIME_PROCESS" value="1" enum="Monitor">
Time it took to complete one frame.
Time it took to complete one frame, in seconds.
</constant>
<constant name="TIME_PHYSICS_PROCESS" value="2" enum="Monitor">
Time it took to complete one physics frame.
Time it took to complete one physics frame, in seconds.
</constant>
<constant name="MEMORY_STATIC" value="3" enum="Monitor">
Static memory currently used, in bytes. Not available in release builds.
@@ -58,6 +58,7 @@
Number of nodes currently instanced in the scene tree. This also includes the root node.
</constant>
<constant name="OBJECT_ORPHAN_NODE_COUNT" value="11" enum="Monitor">
Number of orphan nodes, i.e. nodes which are not parented to a node of the scene tree.
</constant>
<constant name="RENDER_OBJECTS_IN_FRAME" value="12" enum="Monitor">
3D objects drawn per frame.
@@ -78,15 +79,16 @@
Draw calls per frame. 3D only.
</constant>
<constant name="RENDER_VIDEO_MEM_USED" value="18" enum="Monitor">
Video memory used. Includes both texture and vertex memory.
The amount of video memory used, i.e. texture and vertex memory combined.
</constant>
<constant name="RENDER_TEXTURE_MEM_USED" value="19" enum="Monitor">
Texture memory used.
The amount of texture memory used.
</constant>
<constant name="RENDER_VERTEX_MEM_USED" value="20" enum="Monitor">
Vertex memory used.
The amount of vertex memory used.
</constant>
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="21" enum="Monitor">
Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0.
</constant>
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="22" enum="Monitor">
Number of active [RigidBody2D] nodes in the game.
@@ -107,8 +109,10 @@
Number of islands in the 3D physics engine.
</constant>
<constant name="AUDIO_OUTPUT_LATENCY" value="28" enum="Monitor">
Output latency of the [AudioServer].
</constant>
<constant name="MONITOR_MAX" value="29" enum="Monitor">
Represents the size of the [enum Monitor] enum.
</constant>
</constants>
</class>