Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion classes/class_audioserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,9 @@ Returns the names of all audio output devices detected on the system.

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

Returns the audio driver's output latency. This can be expensive, it is not recommended to call this every frame.
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.

\ **Note:** This can be expensive; it is not recommended to call :ref:`get_output_latency<class_AudioServer_method_get_output_latency>` every frame.

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

Expand Down
8 changes: 4 additions & 4 deletions classes/class_audiostreamrandomizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Properties
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
| :ref:`PlaybackMode<enum_AudioStreamRandomizer_PlaybackMode>` | :ref:`playback_mode<class_AudioStreamRandomizer_property_playback_mode>` | ``0`` |
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>` | ``1.1`` |
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomizer_property_random_pitch>` | ``1.0`` |
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`random_volume_offset_db<class_AudioStreamRandomizer_property_random_volume_offset_db>` | ``5.0`` |
| :ref:`float<class_float>` | :ref:`random_volume_offset_db<class_AudioStreamRandomizer_property_random_volume_offset_db>` | ``0.0`` |
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
| :ref:`int<class_int>` | :ref:`streams_count<class_AudioStreamRandomizer_property_streams_count>` | ``0`` |
+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+
Expand Down Expand Up @@ -132,7 +132,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next.

.. rst-class:: classref-property

:ref:`float<class_float>` **random_pitch** = ``1.1``
:ref:`float<class_float>` **random_pitch** = ``1.0``

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

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

.. rst-class:: classref-property

:ref:`float<class_float>` **random_volume_offset_db** = ``5.0``
:ref:`float<class_float>` **random_volume_offset_db** = ``0.0``

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

Expand Down
4 changes: 2 additions & 2 deletions classes/class_backbuffercopy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ BackBufferCopy

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

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``).
A node that copies a region of the screen to a buffer for access in shader code.

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

Description
-----------

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.
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``).

\ **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.

Expand Down
6 changes: 3 additions & 3 deletions classes/class_basematerial3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ BaseMaterial3D

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

Default 3D rendering material.
Abstract base class for defining the 3D rendering properties of meshes.

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

Description
-----------

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.
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.

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

Tutorials
---------

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

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ Returns the total amount of arguments bound (or unbound) via successive :ref:`bi

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

Returns the name of the method represented by this **Callable**. If the callable is a lambda function, returns the function's name.
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>"``.

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_compressedcubemap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CompressedCubemap

**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>`

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

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_compressedcubemaparray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CompressedCubemapArray

**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>`

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

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_cpuparticles2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CPUParticles2D

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

CPU-based 2D particle emitter.
A CPU-based 2D particle emitter.

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_cpuparticles3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CPUParticles3D

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

CPU-based 3D particle emitter.
A CPU-based 3D particle emitter.

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

Expand Down
4 changes: 3 additions & 1 deletion classes/class_csgmesh3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ The :ref:`Material<class_Material>` used in drawing the CSG shape.

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

\ **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.
\ **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.

\ :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.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
Expand Down
2 changes: 1 addition & 1 deletion classes/class_cubemap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Cubemap

**Inherits:** :ref:`ImageTextureLayered<class_ImageTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

6-sided texture typically used in 3D rendering.
Six square textures representing the faces of a cube. Commonly used as a skybox.

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

Expand Down
10 changes: 5 additions & 5 deletions classes/class_cubemaparray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ CubemapArray

**Inherits:** :ref:`ImageTextureLayered<class_ImageTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A single composite texture resource which consists of multiple :ref:`Cubemap<class_Cubemap>`\ s.
An array of :ref:`Cubemap<class_Cubemap>`\ s, stored together and with a single reference.

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

Description
-----------

**CubemapArray**\ s are made of an array of :ref:`Cubemap<class_Cubemap>`\ s. Accordingly, like :ref:`Cubemap<class_Cubemap>`\ s they are made of multiple textures the amount of which must be divisible by 6 (one image for each face of the cube). The primary benefit of **CubemapArray**\ s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple :ref:`Cubemap<class_Cubemap>`\ s into a shader using a single **CubemapArray**.
**CubemapArray**\ s are made of an array of :ref:`Cubemap<class_Cubemap>`\ s. Like :ref:`Cubemap<class_Cubemap>`\ s, they are made of multiple textures, the amount of which must be divisible by 6 (one for each face of the cube). The primary benefit of **CubemapArray**\ s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple :ref:`Cubemap<class_Cubemap>`\ s into a shader using a single **CubemapArray**.

Generally, **CubemapArray**\ s provide a more efficient way for storing multiple :ref:`Cubemap<class_Cubemap>`\ s compared to storing multiple :ref:`Cubemap<class_Cubemap>`\ s themselves in an array.
Moreover, :ref:`Cubemap<class_Cubemap>`\ s are allocated in adjacent cache regions on the GPU. This makes **CubemapArray**\ s the most efficient way to store multiple :ref:`Cubemap<class_Cubemap>`\ s.

Internally, Godot uses **CubemapArray**\ s for many effects including the :ref:`Sky<class_Sky>`, if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections<class_ProjectSettings_property_rendering/reflections/sky_reflections/texture_array_reflections>` to ``true``.
Internally, Godot uses **CubemapArray**\ s for many effects, including the :ref:`Sky<class_Sky>` if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections<class_ProjectSettings_property_rendering/reflections/sky_reflections/texture_array_reflections>` to ``true``.

To create such a texture file yourself, reimport your image files using the Godot Editor import presets.
To create such a texture file yourself, reimport your image files using the import presets of the File System dock.

\ **Note:** **CubemapArray** is not supported in the OpenGL 3 rendering backend.

Expand Down
4 changes: 2 additions & 2 deletions classes/class_curve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ Curve

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A mathematic curve.
A mathematical curve.

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

Description
-----------

A curve that can be saved and re-used for other objects. By default, it ranges between ``0`` and ``1`` on the Y axis and positions points relative to the ``0.5`` Y position.
This resource describes a mathematical curve by defining a set of points and tangents at each point. By default, it ranges between ``0`` and ``1`` on the Y axis and positions points relative to the ``0.5`` Y position.

See also :ref:`Gradient<class_Gradient>` which is designed for color interpolation. See also :ref:`Curve2D<class_Curve2D>` and :ref:`Curve3D<class_Curve3D>`.

Expand Down
4 changes: 2 additions & 2 deletions classes/class_curvetexture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ CurveTexture

**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A texture that shows a curve.
A 1D texture where pixel brightness corresponds to points on a curve.

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

Description
-----------

Renders a given :ref:`Curve<class_Curve>` provided to it. Simplifies the task of drawing curves and/or saving them as image files.
A 1D texture where pixel brightness corresponds to points on a :ref:`Curve<class_Curve>` resource, either in grayscale or in red. This visual representation simplifies the task of saving curves as image files.

If you need to store up to 3 curves within a single texture, use :ref:`CurveXYZTexture<class_CurveXYZTexture>` instead. See also :ref:`GradientTexture1D<class_GradientTexture1D>` and :ref:`GradientTexture2D<class_GradientTexture2D>`.

Expand Down
4 changes: 2 additions & 2 deletions classes/class_curvexyztexture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ CurveXYZTexture

**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A texture that shows 3 different curves (stored on the red, green and blue color channels).
A 1D texture where the red, green, and blue color channels correspond to points on 3 curves.

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

Description
-----------

Renders 3 given :ref:`Curve<class_Curve>`\ s provided to it, on the red, green and blue channels respectively. Compared to using separate :ref:`CurveTexture<class_CurveTexture>`\ s, this further simplifies the task of drawing curves and/or saving them as image files.
A 1D texture where the red, green, and blue color channels correspond to points on 3 :ref:`Curve<class_Curve>` resources. Compared to using separate :ref:`CurveTexture<class_CurveTexture>`\ s, this further simplifies the task of saving curves as image files.

If you only need to store one curve within a single texture, use :ref:`CurveTexture<class_CurveTexture>` instead. See also :ref:`GradientTexture1D<class_GradientTexture1D>` and :ref:`GradientTexture2D<class_GradientTexture2D>`.

Expand Down
6 changes: 5 additions & 1 deletion classes/class_displayserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1576,7 +1576,11 @@ Callbacks have the following arguments: ``bool status, PackedStringArray selecte

\ **Note:** This method is implemented if the display server has the ``FEATURE_NATIVE_DIALOG`` feature.

\ **Note:** This method is implemented on Windows and macOS.
\ **Note:** This method is implemented on Linux, Windows and macOS.

\ **Note:** ``current_directory`` might be ignored.

\ **Note:** On Linux, ``show_hidden`` is ignored.

\ **Note:** On macOS, native file dialogs have no title.

Expand Down
16 changes: 16 additions & 0 deletions classes/class_editorexportplatformandroid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ Properties
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`package/show_in_android_tv<class_EditorExportPlatformAndroid_property_package/show_in_android_tv>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`package/show_in_app_library<class_EditorExportPlatformAndroid_property_package/show_in_app_library>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`package/signed<class_EditorExportPlatformAndroid_property_package/signed>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`package/unique_name<class_EditorExportPlatformAndroid_property_package/unique_name>` |
Expand Down Expand Up @@ -798,6 +800,20 @@ If ``true``, this app will show in Android TV launcher UI.

----

.. _class_EditorExportPlatformAndroid_property_package/show_in_app_library:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **package/show_in_app_library**

If ``true``, this app will show in the device's app library.

\ **Note:** This is ``true`` by default.

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

----

.. _class_EditorExportPlatformAndroid_property_package/signed:

.. rst-class:: classref-property
Expand Down
Loading