Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

Merged
merged 68 commits into from
Jan 17, 2025
Merged
Changes from 1 commit
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
196233b
Clarify documentation for Geometry2D.line_intersects_line
GrahameGW Jun 5, 2024
1569528
Updated TreeItem documentation
apples Sep 7, 2024
ca3f1e0
Document time rollover setting in ProjectSettings.xml
tetrapod00 Aug 11, 2024
1eaae64
Clarify `Timer.start()` documentation to match the current behavior.
sepTN Aug 13, 2024
2e5bb32
Add tutorial link in Compositor and CompositorEffect docs
tetrapod00 Aug 15, 2024
32c6851
docs: highlight lack of joystick info on majority of platforms
Aug 18, 2024
30e6261
Document conversion function needed for normal texture in CompositorE…
tetrapod00 Aug 18, 2024
7af387e
Fix miscellaneous oddities around the class reference
Mickeon Aug 18, 2024
dacb91f
Add descriptions to `PolygonPathFinder` `setup` and `is_point_inside`…
andrei-g99 Aug 18, 2024
2d5fbb6
docs: update UPnP gdscript snippet to latest gdscript
Goutte Aug 20, 2024
83f4d11
Add movement caveats to InputEventMouseMotion docs
jadoc Aug 21, 2024
d636107
In Node.xml mentioned that Node::duplicate also copies children.
vinni-richburgh Aug 22, 2024
07b3d75
[Doc] Clarify `is_null` methods of `Callable` and `Signal`
AThousandShips Aug 25, 2024
b79e061
[Doc] Clarify ProjectSettings hdr_2d description
Wierdox Aug 26, 2024
b364abb
Improve documentation on Node2D transform properties such as Skew
Calinou Sep 5, 2024
764212a
Fix grammar in AudioStreamInteractive.xml
bobby-the-epic Sep 5, 2024
aa02f40
Docs: Add cross-links to antialiasing project settings
tetrapod00 Sep 12, 2024
d2d58fd
Clarify the coordinate space for the bounding rectangle returned by L…
lpenguin Sep 12, 2024
432dabe
Fix typo in RenderingServer docs
Kiisu-Master Sep 13, 2024
d1944f1
Document SceneMultiplayer `auth_timeout` being in seconds
Calinou Sep 15, 2024
22ac0ef
Remove outdated note about `not` operator with String and StringName
iscke Sep 16, 2024
6d67ac7
Warn for potential performance issues with Auto Switch to Remote Scen…
Calinou Sep 16, 2024
69dc2c1
Clarify behavior of InputEvent.is_match and Shortcut.matches_event
SkylerGoh-dev Sep 17, 2024
da3d864
Clarify docs for when toggling `button_pressed` emits `toggled`
Giganzo Sep 21, 2024
b357ff8
Clarify PCK path argument in `PCKPacker.pck_start`
Rynzier Sep 21, 2024
f96544b
Fix a typo in make_rst.py (Packedfloat64Array -> PackedFloat64Array)
Ivorforce Sep 22, 2024
4572f7c
Add descriptions to RDVertexAttribute's properties
DevPoodle Sep 23, 2024
61f907d
Refactor signal documentation to improve clarity
Manik2607 Sep 23, 2024
939dea7
Fix SplitContainer collapsed documentation
kitbdev Sep 23, 2024
9c3af38
Better description for multiplayer spawner signals
CrayolaEater Sep 24, 2024
9ada7bd
Document `Object.has_signal()` in the Signal class reference
Calinou Oct 2, 2024
3c1224c
Clarify that fog_aerial_perspective does not actually use sky color
ttencate Oct 5, 2024
4beb126
Document non-resource file handling in FileAccess and ResourceLoader
Calinou Oct 6, 2024
c070b7e
Clarify SIMPLEX and SIMPLEX_SMOOTH types
squidgyberries Oct 7, 2024
3feaffd
Fixed a documentation typo in Control._drop_data() C#-example.
mh114 Oct 8, 2024
948d57c
Fix documentation tip for network/debug/remote_host editor setting
cadence-s Oct 18, 2024
6ec9a85
Clarify `TextEdit.is_caret_visible()` behavior in the class reference
Calinou Oct 22, 2024
c955e30
Improve documentation on `@GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE`
Calinou Oct 24, 2024
7cbf24c
Remove link to outdated CharFX example project
skyace65 Oct 27, 2024
8bf1b4f
Improve get surrounding cells description
skyace65 Oct 27, 2024
91f7697
Document exporting nested subgroups
dalexeev Oct 28, 2024
b53e0ff
Clarify in default texture repeat and filter docs that they only impa…
clayjohn Nov 1, 2024
8f37698
Docs: Update TileSet to reference TileMapLayer instead of TileMap
tetrapod00 Nov 3, 2024
b9afe69
Clarify `ResourceLoader.load_threaded_get_status()` completion ratio …
Calinou Nov 6, 2024
b4fb036
Add note to `CanvasItem.clip_children` about nesting
Meorge Nov 8, 2024
8ecfc14
Fix engine_type_colors's description
Dr-helicopter Nov 8, 2024
ad3b07c
Docs: Update AStar3D examples
tetrapod00 Nov 8, 2024
59b2501
Fix interactive music docs saying it's "not implemented"
Mickeon Nov 9, 2024
f6ee57c
Add note about LightmapGI only baking nodes under its parent
FlooferLand Nov 11, 2024
1e931c2
Added notes on DirAccess
BrianBHuynh Nov 12, 2024
b5a1095
Update Z Index property location in Node2D class reference
Calinou Nov 14, 2024
cefdb00
Fix TODO comments in class reference
RedMser Nov 14, 2024
c3874f4
Add a code sample that extracts all files to ZIPReader documentation
Calinou Nov 16, 2024
00c73de
Fix incorrect Z direction for AABB's position
Mickeon Nov 17, 2024
3c0dcf4
Rewrite some `@GlobalScope` keys in documentation to use `[code]` tags
Mickeon Nov 17, 2024
b113339
Correct PackedInt64Array comparison in description
mechalynx Nov 22, 2024
bae03fa
Update PackedVector4Array description to include explanation shared b…
mechalynx Nov 22, 2024
9403f65
Fix missing sign in ease function curve description
bruno-brant Nov 24, 2024
e531ad9
Update screen_get_scale documentation.
syntaxerror247 Nov 25, 2024
05b8c88
Update CanvasLayer 'Follow Viewport' documentation to match its behavior
kthang55 Nov 27, 2024
aecb7f6
Remove outdated note about `BaseMaterial3D.billboard_mode` shadow issue
Calinou Nov 29, 2024
5bf1f36
Document `GPUParticles.emit_particle()` only working on Forward+ and …
Calinou Dec 13, 2024
cf3c056
Fix warning in CollisionPolygon2D documentation description
Calinou Jan 3, 2025
e2e01f2
Fix incorrect string escaping in OS.shell_open() method Windows path …
mateuseap Jan 8, 2025
0eb9c1f
Add TileMap tutorials to TileMapLayer class reference
Calinou Jan 8, 2025
b57cda6
Fix typo in Basis get_rotation_quaternion doc
Hakunamawatta Jan 9, 2025
c1758c9
Clarify expected types in RayCast3D documentation
jburt137 Jan 9, 2025
28a7784
Fix typo in AudioStreamSynchronized.xml
brevven Jan 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix typo in RenderingServer docs
(cherry picked from commit 3a1160b)
Kiisu-Master authored and Spartan322 committed Jan 17, 2025

Verified

This commit was signed with the committer’s verified signature.
Spartan322 George L. Albany
commit 432dabe84650eadc2274b1efe2ddd831252360a5
2 changes: 1 addition & 1 deletion doc/classes/RenderingServer.xml
Original file line number Diff line number Diff line change
@@ -3653,7 +3653,7 @@
<return type="float" />
<param index="0" name="viewport" type="RID" />
<description>
Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_gpu].
Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_cpu].
[b]Note:[/b] Requires measurements to be enabled on the specified [param viewport] using [method viewport_set_measure_render_time]. Otherwise, this method returns [code]0.0[/code].
[b]Note:[/b] When GPU utilization is low enough during a certain period of time, GPUs will decrease their power state (which in turn decreases core and memory clock speeds). This can cause the reported GPU time to increase if GPU utilization is kept low enough by a framerate cap (compared to what it would be at the GPU's highest power state). Keep this in mind when benchmarking using [method viewport_get_measured_render_time_gpu]. This behavior can be overridden in the graphics driver settings at the cost of higher power usage.
</description>