Skip to content

Commit 8028db9

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (b51ee8b)
1 parent e0dca52 commit 8028db9

File tree

76 files changed

+721
-264
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+721
-264
lines changed

classes/class_audioserver.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,9 @@ Returns the names of all audio output devices detected on the system.
488488

489489
:ref:`float<class_float>` **get_output_latency** **(** **)** |const|
490490

491-
Returns the audio driver's output latency. This can be expensive, it is not recommended to call this every frame.
491+
Returns the audio driver's effective output latency. This is based on :ref:`ProjectSettings.audio/driver/output_latency<class_ProjectSettings_property_audio/driver/output_latency>`, but the exact returned value will differ depending on the operating system and audio driver.
492+
493+
\ **Note:** This can be expensive; it is not recommended to call :ref:`get_output_latency<class_AudioServer_method_get_output_latency>` every frame.
492494

493495
.. rst-class:: classref-item-separator
494496

classes/class_audiostreamrandomizer.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Properties
3232
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
3333
| :ref:`PlaybackMode<enum_AudioStreamRandomizer_PlaybackMode>` | :ref:`playback_mode<class_AudioStreamRandomizer_property_playback_mode>` | ``0`` |
3434
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
35-
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>` | ``1.1`` |
35+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>` | ``1.0`` |
3636
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
37-
| :ref:`float<class_float>` | :ref:`random_volume_offset_db<class_AudioStreamRandomizer_property_random_volume_offset_db>` | ``5.0`` |
37+
| :ref:`float<class_float>` | :ref:`random_volume_offset_db<class_AudioStreamRandomizer_property_random_volume_offset_db>` | ``0.0`` |
3838
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
3939
| :ref:`int<class_int>` | :ref:`streams_count<class_AudioStreamRandomizer_property_streams_count>` | ``0`` |
4040
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
@@ -132,7 +132,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next.
132132

133133
.. rst-class:: classref-property
134134

135-
:ref:`float<class_float>` **random_pitch** = ``1.1``
135+
:ref:`float<class_float>` **random_pitch** = ``1.0``
136136

137137
.. rst-class:: classref-property-setget
138138

@@ -149,7 +149,7 @@ The intensity of random pitch variation. A value of 1 means no variation.
149149

150150
.. rst-class:: classref-property
151151

152-
:ref:`float<class_float>` **random_volume_offset_db** = ``5.0``
152+
:ref:`float<class_float>` **random_volume_offset_db** = ``0.0``
153153

154154
.. rst-class:: classref-property-setget
155155

classes/class_backbuffercopy.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ BackBufferCopy
1212

1313
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
1414

15-
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed in your shader scripts using the screen texture (i.e. a uniform sampler with ``hint_screen_texture``).
15+
A node that copies a region of the screen to a buffer for access in shader code.
1616

1717
.. rst-class:: classref-introduction-group
1818

1919
Description
2020
-----------
2121

22-
Node for back-buffering the currently-displayed screen. The region defined in the **BackBufferCopy** node is buffered with the content of the screen it covers, or the entire screen according to the copy mode set. Use the screen texture in your shader scripts to access the buffer.
22+
Node for back-buffering the currently-displayed screen. The region defined in the **BackBufferCopy** node is buffered with the content of the screen it covers, or the entire screen according to the :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>`. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with ``hint_screen_texture``).
2323

2424
\ **Note:** Since this node inherits from :ref:`Node2D<class_Node2D>` (and not :ref:`Control<class_Control>`), anchors and margins won't apply to child :ref:`Control<class_Control>`-derived nodes. This can be problematic when resizing the window. To avoid this, add :ref:`Control<class_Control>`-derived nodes as *siblings* to the **BackBufferCopy** node instead of adding them as children.
2525

classes/class_basematerial3d.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ BaseMaterial3D
1414

1515
**Inherited By:** :ref:`ORMMaterial3D<class_ORMMaterial3D>`, :ref:`StandardMaterial3D<class_StandardMaterial3D>`
1616

17-
Default 3D rendering material.
17+
Abstract base class for defining the 3D rendering properties of meshes.
1818

1919
.. rst-class:: classref-introduction-group
2020

2121
Description
2222
-----------
2323

24-
This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details.
24+
This class serves as a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details.
2525

2626
.. rst-class:: classref-introduction-group
2727

2828
Tutorials
2929
---------
3030

31-
- :doc:`Standard Material 3D <../tutorials/3d/standard_material_3d>`
31+
- :doc:`Standard Material 3D and ORM Material 3D <../tutorials/3d/standard_material_3d>`
3232

3333
.. rst-class:: classref-reftable-group
3434

classes/class_callable.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ Returns the total amount of arguments bound (or unbound) via successive :ref:`bi
308308

309309
:ref:`StringName<class_StringName>` **get_method** **(** **)** |const|
310310

311-
Returns the name of the method represented by this **Callable**. If the callable is a lambda function, returns the function's name.
311+
Returns the name of the method represented by this **Callable**. If the callable is a GDScript lambda function, returns the function's name or ``"<anonymous lambda>"``.
312312

313313
.. rst-class:: classref-item-separator
314314

classes/class_compressedcubemap.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CompressedCubemap
1212

1313
**Inherits:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
1414

15-
6-sided texture typically used in 3D rendering, optionally compressed.
15+
An optionally compressed :ref:`Cubemap<class_Cubemap>`.
1616

1717
.. rst-class:: classref-introduction-group
1818

classes/class_compressedcubemaparray.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CompressedCubemapArray
1212

1313
**Inherits:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
1414

15-
Array of 6-sided textures typically used in 3D rendering, optionally compressed.
15+
An optionally compressed :ref:`CubemapArray<class_CubemapArray>`.
1616

1717
.. rst-class:: classref-introduction-group
1818

classes/class_cpuparticles2d.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CPUParticles2D
1212

1313
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
1414

15-
CPU-based 2D particle emitter.
15+
A CPU-based 2D particle emitter.
1616

1717
.. rst-class:: classref-introduction-group
1818

classes/class_cpuparticles3d.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CPUParticles3D
1212

1313
**Inherits:** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
1414

15-
CPU-based 3D particle emitter.
15+
A CPU-based 3D particle emitter.
1616

1717
.. rst-class:: classref-introduction-group
1818

classes/class_csgmesh3d.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ The :ref:`Material<class_Material>` used in drawing the CSG shape.
8383

8484
The :ref:`Mesh<class_Mesh>` resource to use as a CSG shape.
8585

86-
\ **Note:** When using an :ref:`ArrayMesh<class_ArrayMesh>`, avoid meshes with vertex normals unless a flat shader is required. By default, CSGMesh will ignore the mesh's vertex normals and use a smooth shader calculated using the faces' normals. If a flat shader is required, ensure that all faces' vertex normals are parallel.
86+
\ **Note:** When using an :ref:`ArrayMesh<class_ArrayMesh>`, all vertex attributes except :ref:`Mesh.ARRAY_VERTEX<class_Mesh_constant_ARRAY_VERTEX>`, :ref:`Mesh.ARRAY_NORMAL<class_Mesh_constant_ARRAY_NORMAL>` and :ref:`Mesh.ARRAY_TEX_UV<class_Mesh_constant_ARRAY_TEX_UV>` are left unused. Only :ref:`Mesh.ARRAY_VERTEX<class_Mesh_constant_ARRAY_VERTEX>` and :ref:`Mesh.ARRAY_TEX_UV<class_Mesh_constant_ARRAY_TEX_UV>` will be passed to the GPU.
87+
88+
\ :ref:`Mesh.ARRAY_NORMAL<class_Mesh_constant_ARRAY_NORMAL>` is only used to determine which faces require the use of flat shading. By default, CSGMesh will ignore the mesh's vertex normals, recalculate them for each vertex and use a smooth shader. If a flat shader is required for a face, ensure that all vertex normals of the face are approximately equal.
8789

8890
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
8991
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

0 commit comments

Comments
 (0)