Skip to content

Commit

Permalink
Revert "classref: Sync with current master branch (44fa552)"
Browse files Browse the repository at this point in the history
This reverts commit f347f7f.
  • Loading branch information
Spartan322 committed Oct 20, 2024
1 parent aaedfc8 commit 5386dc0
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 69 deletions.
14 changes: 0 additions & 14 deletions classes/class_cpuparticles3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,6 @@ Methods
.. table::
:widths: auto

+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_CPUParticles3D_method_capture_aabb>`\ (\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`convert_from_particles<class_CPUParticles3D_method_convert_from_particles>`\ (\ particles\: :ref:`Node<class_Node>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -1815,18 +1813,6 @@ Grow the box if particles suddenly appear/disappear when the node enters/exits t
Method Descriptions
-------------------

.. _class_CPUParticles3D_method_capture_aabb:

.. rst-class:: classref-method

:ref:`AABB<class_AABB>` **capture_aabb**\ (\ ) |const| :ref:`πŸ”—<class_CPUParticles3D_method_capture_aabb>`

Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.

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

----

.. _class_CPUParticles3D_method_convert_from_particles:

.. rst-class:: classref-method
Expand Down
19 changes: 0 additions & 19 deletions classes/class_editorexportplatformmacos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ Properties
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`codesign/custom_options<class_EditorExportPlatformMacOS_property_codesign/custom_options>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`codesign/entitlements/additional<class_EditorExportPlatformMacOS_property_codesign/entitlements/additional>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`codesign/entitlements/address_book<class_EditorExportPlatformMacOS_property_codesign/entitlements/address_book>` |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`codesign/entitlements/allow_dyld_environment_variables<class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_dyld_environment_variables>` |
Expand Down Expand Up @@ -755,23 +753,6 @@ Array of the additional command line arguments passed to the code signing tool.

----

.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/additional:

.. rst-class:: classref-property

:ref:`String<class_String>` **codesign/entitlements/additional** :ref:`πŸ”—<class_EditorExportPlatformMacOS_property_codesign/entitlements/additional>`

Additional data added to the root ``<dict>`` section of the `.entitlements <https://developer.apple.com/documentation/bundleresources/entitlements>`__ file. The value should be an XML section with pairs of key-value elements, e.g.:

.. code:: text
<key>key_name</key>
<string>value</string>
.. rst-class:: classref-item-separator

----

.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/address_book:

.. rst-class:: classref-property
Expand Down
4 changes: 2 additions & 2 deletions classes/class_fileaccess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1185,7 +1185,7 @@ Stores a floating-point number as 32 bits in the file.

|void| **store_line**\ (\ line\: :ref:`String<class_String>`\ ) :ref:`πŸ”—<class_FileAccess_method_store_line>`

Stores ``line`` in the file followed by a newline character (``\n``), encoding the text as UTF-8.
Appends ``line`` to the file followed by a line return character (``\n``), encoding the text as UTF-8.

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

Expand Down Expand Up @@ -1223,7 +1223,7 @@ Stores a floating-point number in the file.

|void| **store_string**\ (\ string\: :ref:`String<class_String>`\ ) :ref:`πŸ”—<class_FileAccess_method_store_string>`

Stores ``string`` in the file without a newline character (``\n``), encoding the text as UTF-8.
Appends ``string`` to the file without a line return, encoding the text as UTF-8.

\ **Note:** This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using :ref:`store_pascal_string<class_FileAccess_method_store_pascal_string>` instead. For retrieving strings from a text file, you can use ``get_buffer(length).get_string_from_utf8()`` (if you know the length) or :ref:`get_as_text<class_FileAccess_method_get_as_text>`.

Expand Down
2 changes: 1 addition & 1 deletion classes/class_filedialog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ If ``true``, the dialog will show hidden files.
- |void| **set_use_native_dialog**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_use_native_dialog**\ (\ )

If ``true``, and if supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.
If ``true``, :ref:`access<class_FileDialog_property_access>` is set to :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`, and it is supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.

\ **Note:** On Linux and macOS, sandboxed apps always use native dialogs to access the host file system.

Expand Down
20 changes: 6 additions & 14 deletions classes/class_projectsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9782,12 +9782,10 @@ If ``true``, vertices of :ref:`CanvasItem<class_CanvasItem>` nodes will snap to

:ref:`int<class_int>` **rendering/anti_aliasing/quality/msaa_2d** = ``0`` :ref:`πŸ”—<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d>`

Sets the number of multisample antialiasing (MSAA) samples to use for 2D/Canvas rendering (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware, especially integrated graphics due to their limited memory bandwidth. This has no effect on shader-induced aliasing or texture aliasing.
Sets the number of MSAA samples to use for 2D/Canvas rendering (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware, especially integrated graphics due to their limited memory bandwidth. This has no effect on shader-induced aliasing or texture aliasing.

\ **Note:** MSAA is only supported in the Forward+ and Mobile rendering methods, not Compatibility.

\ **Note:** This property is only read when the project starts. To set the number of 2D MSAA samples at runtime, set :ref:`Viewport.msaa_2d<class_Viewport_property_msaa_2d>` or use :ref:`RenderingServer.viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>`.

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

----
Expand All @@ -9798,9 +9796,7 @@ Sets the number of multisample antialiasing (MSAA) samples to use for 2D/Canvas

:ref:`int<class_int>` **rendering/anti_aliasing/quality/msaa_3d** = ``0`` :ref:`πŸ”—<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>`

Sets the number of multisample antialiasing (MSAA) samples to use for 3D rendering (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware, especially integrated graphics due to their limited memory bandwidth. See also :ref:`rendering/scaling_3d/mode<class_ProjectSettings_property_rendering/scaling_3d/mode>` for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing.

\ **Note:** This property is only read when the project starts. To set the number of 3D MSAA samples at runtime, set :ref:`Viewport.msaa_3d<class_Viewport_property_msaa_3d>` or use :ref:`RenderingServer.viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>`.
Sets the number of MSAA samples to use for 3D rendering (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware, especially integrated graphics due to their limited memory bandwidth. See also :ref:`rendering/scaling_3d/mode<class_ProjectSettings_property_rendering/scaling_3d/mode>` for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing.

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

Expand All @@ -9818,8 +9814,6 @@ Another way to combat specular aliasing is to enable :ref:`rendering/anti_aliasi

\ **Note:** Screen-space antialiasing is only supported in the Forward+ and Mobile rendering methods, not Compatibility.

\ **Note:** This property is only read when the project starts. To set the screen-space antialiasing mode at runtime, set :ref:`Viewport.screen_space_aa<class_Viewport_property_screen_space_aa>` on the root :ref:`Viewport<class_Viewport>` instead, or use :ref:`RenderingServer.viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>`.

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

----
Expand All @@ -9834,7 +9828,7 @@ If ``true``, uses a fast post-processing filter to make banding significantly le

In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.

\ **Note:** This property is only read when the project starts. To set debanding at runtime, set :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>` on the root :ref:`Viewport<class_Viewport>` instead, or use :ref:`RenderingServer.viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>`.
\ **Note:** This property is only read when the project starts. To set debanding at run-time, set :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>` on the root :ref:`Viewport<class_Viewport>` instead.

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

Expand All @@ -9846,14 +9840,12 @@ In some cases, debanding may introduce a slightly noticeable dithering pattern.

:ref:`bool<class_bool>` **rendering/anti_aliasing/quality/use_taa** = ``false`` :ref:`πŸ”—<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>`

Enables temporal antialiasing for the default screen :ref:`Viewport<class_Viewport>`. TAA works by jittering the camera and accumulating the images of the last rendered frames, motion vector rendering is used to account for camera and object motion. Enabling TAA can make the image blurrier, which is partially counteracted by automatically using a negative mipmap LOD bias (see :ref:`rendering/textures/default_filters/texture_mipmap_bias<class_ProjectSettings_property_rendering/textures/default_filters/texture_mipmap_bias>`).
Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport<class_Viewport>`. TAA works by jittering the camera and accumulating the images of the last rendered frames, motion vector rendering is used to account for camera and object motion. Enabling TAA can make the image blurrier, which is partially counteracted by automatically using a negative mipmap LOD bias (see :ref:`rendering/textures/default_filters/texture_mipmap_bias<class_ProjectSettings_property_rendering/textures/default_filters/texture_mipmap_bias>`).

\ **Note:** The implementation is not complete yet. Some visual instances such as particles and skinned meshes may show ghosting artifacts in motion.

\ **Note:** TAA is only supported in the Forward+ rendering method, not Mobile or Compatibility.

\ **Note:** This property is only read when the project starts. To set TAA at runtime, set :ref:`Viewport.use_taa<class_Viewport_property_use_taa>` on the root :ref:`Viewport<class_Viewport>` instead, or use :ref:`RenderingServer.viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>`.

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

----
Expand Down Expand Up @@ -11788,9 +11780,9 @@ If ``true``, the GPU texture compressor will cache the local RenderingDevice and

If ``true``, the texture importer will utilize the GPU for compressing textures, improving the import time of large images.

\ **Note:** This only functions on a device which supports either Vulkan, D3D12, or Metal available as a rendering backend.
\ **Note:** This setting requires either Vulkan or D3D12 available as a rendering backend.

\ **Note:** Currently this only affects certain compressed formats (BC1, BC4, and BC6), all of which are exclusive to desktop platforms and consoles.
\ **Note:** Currently this only affects BC1 and BC6H compression, which are used on Desktop and Console for fully opaque and HDR images respectively.

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

Expand Down
10 changes: 5 additions & 5 deletions classes/class_renderingserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11854,7 +11854,7 @@ Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewpo

|void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`πŸ”—<class_RenderingServer_method_viewport_set_msaa_2d>`

Sets the multisample antialiasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d>` or :ref:`Viewport.msaa_2d<class_Viewport_property_msaa_2d>`.
Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.

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

Expand All @@ -11866,7 +11866,7 @@ Sets the multisample antialiasing mode for 2D/Canvas on the specified ``viewport

|void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`πŸ”—<class_RenderingServer_method_viewport_set_msaa_3d>`

Sets the multisample antialiasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>` or :ref:`Viewport.msaa_3d<class_Viewport_property_msaa_3d>`.
Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.

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

Expand Down Expand Up @@ -11990,7 +11990,7 @@ Sets a viewport's scenario. The scenario contains information about environment

|void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>`\ ) :ref:`πŸ”—<class_RenderingServer_method_viewport_set_screen_space_aa>`

Sets the viewport's screen-space antialiasing mode. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa<class_ProjectSettings_property_rendering/anti_aliasing/quality/screen_space_aa>` or :ref:`Viewport.screen_space_aa<class_Viewport_property_screen_space_aa>`.
Sets the viewport's screen-space antialiasing mode.

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

Expand Down Expand Up @@ -12088,7 +12088,7 @@ Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_Rend

|void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`πŸ”—<class_RenderingServer_method_viewport_set_use_debanding>`

If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>` or :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>`.
If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>`.

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

Expand Down Expand Up @@ -12126,7 +12126,7 @@ If ``true``, enables occlusion culling on the specified viewport. Equivalent to

|void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`πŸ”—<class_RenderingServer_method_viewport_set_use_taa>`

If ``true``, use temporal antialiasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>` or :ref:`Viewport.use_taa<class_Viewport_property_use_taa>`.
If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>`.

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

Expand Down
Loading

0 comments on commit 5386dc0

Please sign in to comment.