From 9c0dc0abda56561237ea4a4489b829fce88b5e75 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 12 Oct 2024 03:21:04 +0000 Subject: [PATCH] classref: Sync with current master branch (92e51fc) --- classes/class_environment.rst | 4 +++- classes/class_fastnoiselite.rst | 4 ++-- classes/class_packedvector2array.rst | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/classes/class_environment.rst b/classes/class_environment.rst index a4da483fba9..63f7a9487d9 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -840,10 +840,12 @@ The background mode. See :ref:`BGMode` for possible val - |void| **set_fog_aerial_perspective**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_fog_aerial_perspective**\ (\ ) -If set above ``0.0`` (exclusive), blends between the fog's color and the color of the background :ref:`Sky`. This has a small performance cost when set above ``0.0``. Must have :ref:`background_mode` set to :ref:`BG_SKY`. +If set above ``0.0`` (exclusive), blends between the fog's color and the color of the background :ref:`Sky`, as read from the radiance cubemap. This has a small performance cost when set above ``0.0``. Must have :ref:`background_mode` set to :ref:`BG_SKY`. This is useful to simulate `aerial perspective `__ in large scenes with low density fog. However, it is not very useful for high-density fog, as the sky will shine through. When set to ``1.0``, the fog color comes completely from the :ref:`Sky`. If set to ``0.0``, aerial perspective is disabled. +Notice that this does not sample the :ref:`Sky` directly, but rather the radiance cubemap. The cubemap is sampled at a mipmap level depending on the depth of the rendered pixel; the farther away, the higher the resolution of the sampled mipmap. This results in the actual color being a blurred version of the sky, with more blur closer to the camera. The highest mipmap resolution is used at a depth of :ref:`Camera3D.far`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_fastnoiselite.rst b/classes/class_fastnoiselite.rst index 130ca392e4e..e7281aea36f 100644 --- a/classes/class_fastnoiselite.rst +++ b/classes/class_fastnoiselite.rst @@ -130,7 +130,7 @@ Cellular includes both Worley noise and Voronoi diagrams which creates various r :ref:`NoiseType` **TYPE_SIMPLEX** = ``0`` -As opposed to :ref:`TYPE_PERLIN`, gradients exist in a simplex lattice rather than a grid lattice, avoiding directional artifacts. +As opposed to :ref:`TYPE_PERLIN`, gradients exist in a simplex lattice rather than a grid lattice, avoiding directional artifacts. Internally uses FastNoiseLite's OpenSimplex2 noise type. .. _class_FastNoiseLite_constant_TYPE_SIMPLEX_SMOOTH: @@ -138,7 +138,7 @@ As opposed to :ref:`TYPE_PERLIN`, grad :ref:`NoiseType` **TYPE_SIMPLEX_SMOOTH** = ``1`` -Modified, higher quality version of :ref:`TYPE_SIMPLEX`, but slower. +Modified, higher quality version of :ref:`TYPE_SIMPLEX`, but slower. Internally uses FastNoiseLite's OpenSimplex2S noise type. .. rst-class:: classref-item-separator diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index 242e8505bd0..d9c5ea19fb6 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -19,7 +19,7 @@ Description An array specifically designed to hold :ref:`Vector2`. Packs data tightly, so it saves memory for large array sizes. -\ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. :ref:`PackedVector3Array` versus ``Array[Vector2]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. +\ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedVector2Array** versus ``Array[Vector2]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. \ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.