Skip to content

Commit

Permalink
Merge pull request godotengine#8008 from godotengine/classref/sync-c1…
Browse files Browse the repository at this point in the history
…2d635

classref: Sync with current master branch (c12d635)
  • Loading branch information
mhilbrunner authored Sep 23, 2023
2 parents 4752803 + 7c71041 commit fed201e
Show file tree
Hide file tree
Showing 21 changed files with 455 additions and 68 deletions.
2 changes: 1 addition & 1 deletion classes/class_aabb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Returns the scalar length of the shortest axis of the **AABB**.

:ref:`Vector3<class_Vector3>` **get_support** **(** :ref:`Vector3<class_Vector3>` dir **)** |const|

Returns the support point in a given direction. This is useful for collision detection algorithms.
Returns the vertex of the AABB that's the farthest in a given direction. This point is commonly known as the support point in collision detection algorithms.

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

Expand Down
14 changes: 13 additions & 1 deletion classes/class_audioserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,19 @@ Signals

**bus_layout_changed** **(** **)**

Emitted when the :ref:`AudioBusLayout<class_AudioBusLayout>` changes.
Emitted when an audio bus is added, deleted, or moved.

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

----

.. _class_AudioServer_signal_bus_renamed:

.. rst-class:: classref-signal

**bus_renamed** **(** :ref:`int<class_int>` bus_index, :ref:`StringName<class_StringName>` old_name, :ref:`StringName<class_StringName>` new_name **)**

Emitted when the audio bus at ``bus_index`` is renamed from ``old_name`` to ``new_name``.

.. rst-class:: classref-section-separator

Expand Down
7 changes: 7 additions & 0 deletions classes/class_canvastexture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ Description

\ **Note:** **CanvasTexture** cannot be used in 3D rendering. For physically-based materials in 3D, use :ref:`BaseMaterial3D<class_BaseMaterial3D>` instead.

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

Tutorials
---------

- :doc:`2D Lights and Shadows <../tutorials/2d/2d_lights_and_shadows>`

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

Properties
Expand Down
4 changes: 2 additions & 2 deletions classes/class_displayserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1282,11 +1282,11 @@ Window view:

OpenGL context (only with the GL Compatibility renderer):

- Windows: ``HGLRC`` for the window.
- Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).

- Linux: ``GLXContext*`` for the window.

- macOS: ``NSOpenGLContext*`` for the window.
- macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).

- Android: ``EGLContext`` for the window.

Expand Down
14 changes: 14 additions & 0 deletions classes/class_editorexportplatformmacos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Properties
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`application/copyright_localized<class_EditorExportPlatformMacOS_property_application/copyright_localized>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`application/export_angle<class_EditorExportPlatformMacOS_property_application/export_angle>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/icon<class_EditorExportPlatformMacOS_property_application/icon>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`application/icon_interpolation<class_EditorExportPlatformMacOS_property_application/icon_interpolation>` |
Expand Down Expand Up @@ -268,6 +270,18 @@ Copyright notice for the bundle visible to the user (localized).

----

.. _class_EditorExportPlatformMacOS_property_application/export_angle:

.. rst-class:: classref-property

:ref:`int<class_int>` **application/export_angle**

If set to ``1``, ANGLE libraries are exported with the exported application. If set to ``0``, ANGLE libraries are exported only if :ref:`ProjectSettings.rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>` is set to ``"opengl3_angle"``.

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

----

.. _class_EditorExportPlatformMacOS_property_application/icon:

.. rst-class:: classref-property
Expand Down
14 changes: 14 additions & 0 deletions classes/class_editorexportplatformwindows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Properties
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/copyright<class_EditorExportPlatformWindows_property_application/copyright>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`application/export_angle<class_EditorExportPlatformWindows_property_application/export_angle>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/file_description<class_EditorExportPlatformWindows_property_application/file_description>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/file_version<class_EditorExportPlatformWindows_property_application/file_version>` |
Expand Down Expand Up @@ -148,6 +150,18 @@ Copyright notice for the bundle visible to the user. Optional. See `StringFileIn

----

.. _class_EditorExportPlatformWindows_property_application/export_angle:

.. rst-class:: classref-property

:ref:`int<class_int>` **application/export_angle**

If set to ``1``, ANGLE libraries are exported with the exported application. If set to ``0``, ANGLE libraries are exported only if :ref:`ProjectSettings.rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>` is set to ``"opengl3_angle"``.

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

----

.. _class_EditorExportPlatformWindows_property_application/file_description:

.. rst-class:: classref-property
Expand Down
57 changes: 56 additions & 1 deletion classes/class_gltfdocument.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Description

GLTFDocument supports reading data from a glTF file, buffer, or Godot scene. This data can then be written to the filesystem, buffer, or used to create a Godot scene.

All of the data in a GLTF scene is stored in the :ref:`GLTFState<class_GLTFState>` class. GLTFDocument processes state objects, but does not contain any scene data itself.
All of the data in a GLTF scene is stored in the :ref:`GLTFState<class_GLTFState>` class. GLTFDocument processes state objects, but does not contain any scene data itself. GLTFDocument has member variables to store export configuration settings such as the image format, but is otherwise stateless. Multiple scenes can be processed with the same settings using the same GLTFDocument object and different :ref:`GLTFState<class_GLTFState>` objects.

GLTFDocument can be extended with arbitrary functionality by extending the :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` class and registering it with GLTFDocument via :ref:`register_gltf_document_extension<class_GLTFDocument_method_register_gltf_document_extension>`. This allows for custom data to be imported and exported.

Expand All @@ -36,6 +36,20 @@ Tutorials

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

Properties
----------

.. table::
:widths: auto

+-----------------------------+-----------------------------------------------------------------+-----------+
| :ref:`String<class_String>` | :ref:`image_format<class_GLTFDocument_property_image_format>` | ``"PNG"`` |
+-----------------------------+-----------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`lossy_quality<class_GLTFDocument_property_lossy_quality>` | ``0.75`` |
+-----------------------------+-----------------------------------------------------------------+-----------+

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

Methods
-------

Expand Down Expand Up @@ -66,6 +80,47 @@ Methods

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_GLTFDocument_property_image_format:

.. rst-class:: classref-property

:ref:`String<class_String>` **image_format** = ``"PNG"``

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

- void **set_image_format** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_image_format** **(** **)**

The user-friendly name of the export image format. This is used when exporting the GLTF file, including writing to a file and writing to a byte array.

By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless WebP", and "Lossy WebP". Support for more image formats can be added in :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` classes.

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

----

.. _class_GLTFDocument_property_lossy_quality:

.. rst-class:: classref-property

:ref:`float<class_float>` **lossy_quality** = ``0.75``

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

- void **set_lossy_quality** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_lossy_quality** **(** **)**

If :ref:`image_format<class_GLTFDocument_property_image_format>` is a lossy image format, this determines the lossy quality of the image. On a range of ``0.0`` to ``1.0``, where ``0.0`` is the lowest quality and ``1.0`` is the highest quality. A lossy quality of ``1.0`` is not the same as lossless.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

Expand Down
Loading

0 comments on commit fed201e

Please sign in to comment.