mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-09-03 18:14:53 +03:00
classref: Sync with current master branch (df62358)
This commit is contained in:
@@ -27,6 +27,17 @@ Area lights can cast soft shadows using PCSS, which you can control by tweaking
|
||||
|
||||
\ **Note:** Area lights have limited support in the Mobile and Compatibility renderers. In the Mobile renderer, the size of the penumbra doesn't vary as it should with PCSS. In Compatibility, area lights cannot cast shadows.
|
||||
|
||||
\ **Warning:** Shadows cast by an area light may look incorrect if the object casting shadows doesn't have enough subdivisions and it's very close to the area light. This is the same limitation as the Dual Paraboloid shadow mode on an :ref:`OmniLight3D<class_OmniLight3D>`.
|
||||
|
||||
\ **Performance:** Area lights are more demanding on the GPU compared to omni and spot lights. In Forward+, there is an additional GPU cost on *all* rendered objects as soon as one area light is present in the view frustum (due to the nature of clustered lighting). Consider using them only for cinematics or when targeting high-end devices.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- `3D lights and shadows <../tutorials/3d/lights_and_shadows.html#area-light>`__
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
|
||||
@@ -31,7 +31,7 @@ Light is emitted in the -Z direction of the node's global basis. For an unrotate
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
|
||||
- `3D lights and shadows <../tutorials/3d/lights_and_shadows.html#directional-light>`__
|
||||
|
||||
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
|
||||
|
||||
|
||||
@@ -121,7 +121,7 @@ Method Descriptions
|
||||
|
||||
|void| **blit_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`, source\: :ref:`Texture2D<class_Texture2D>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), mipmap\: :ref:`int<class_int>` = 0, material\: :ref:`Material<class_Material>` = null\ ) :ref:`🔗<class_DrawableTexture2D_method_blit_rect>`
|
||||
|
||||
**Experimental:** This function and its parameters are likely to change in the 4.7 Dev Cycle
|
||||
**Experimental:** This method may be changed or removed in future versions.
|
||||
|
||||
Draws to given ``rect`` on this texture by copying from the given ``source``. A ``modulate`` color can be passed in for the shader to use, but defaults to White. The ``mipmap`` value can specify a draw to a lower mipmap level. The ``material`` parameter can take a ShaderMaterial with a TextureBlit Shader for custom drawing behavior.
|
||||
|
||||
@@ -135,7 +135,7 @@ Draws to given ``rect`` on this texture by copying from the given ``source``. A
|
||||
|
||||
|void| **blit_rect_multi**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`, sources\: :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\], extra_targets\: :ref:`Array<class_Array>`\[:ref:`DrawableTexture2D<class_DrawableTexture2D>`\], modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), mipmap\: :ref:`int<class_int>` = 0, material\: :ref:`Material<class_Material>` = null\ ) :ref:`🔗<class_DrawableTexture2D_method_blit_rect_multi>`
|
||||
|
||||
**Experimental:** This function and its parameters are likely to change in the 4.7 Dev Cycle
|
||||
**Experimental:** This method may be changed or removed in future versions.
|
||||
|
||||
Draws to the given ``rect`` on this texture, as well as on up to 3 DrawableTexture ``extra_targets``. All ``extra_targets`` must be the same size and DrawableFormat as the original target, otherwise the Shader may fail. Expects up to 4 Texture ``sources``, but will replace missing ``sources`` with default Black Textures.
|
||||
|
||||
@@ -197,7 +197,7 @@ Sets if mipmaps should be used on this DrawableTexture.
|
||||
|
||||
|void| **setup**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, format\: :ref:`DrawableFormat<enum_DrawableTexture2D_DrawableFormat>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), use_mipmaps\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_DrawableTexture2D_method_setup>`
|
||||
|
||||
**Experimental:** This function and its parameters are likely to change in the 4.7 Dev Cycle
|
||||
**Experimental:** This method may be changed or removed in future versions.
|
||||
|
||||
Initializes the DrawableTexture to a White texture of the given ``width``, ``height``, and ``format``.
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ An Omnidirectional light is a type of :ref:`Light3D<class_Light3D>` that emits l
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
|
||||
- `3D lights and shadows <../tutorials/3d/lights_and_shadows.html#omni-light>`__
|
||||
|
||||
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ Light is emitted in the -Z direction of the node's global basis. For an unrotate
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
|
||||
- `3D lights and shadows <../tutorials/3d/lights_and_shadows.html#spot-light>`__
|
||||
|
||||
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
|
||||
|
||||
|
||||
@@ -604,7 +604,7 @@ enum **DropModeFlags**: :ref:`🔗<enum_Tree_DropModeFlags>`
|
||||
|
||||
:ref:`DropModeFlags<enum_Tree_DropModeFlags>` **DROP_MODE_DISABLED** = ``0``
|
||||
|
||||
Disables all drop sections, but still allows to detect the "on item" drop section by :ref:`get_drop_section_at_position()<class_Tree_method_get_drop_section_at_position>`.
|
||||
Disables all drop sections.
|
||||
|
||||
\ **Note:** This is the default flag, it has no effect when combined with other flags.
|
||||
|
||||
@@ -616,7 +616,7 @@ Disables all drop sections, but still allows to detect the "on item" drop sectio
|
||||
|
||||
Enables the "on item" drop section. This drop section covers the entire item.
|
||||
|
||||
When combined with :ref:`DROP_MODE_INBETWEEN<class_Tree_constant_DROP_MODE_INBETWEEN>`, this drop section halves the height and stays centered vertically.
|
||||
When combined with :ref:`DROP_MODE_INBETWEEN<class_Tree_constant_DROP_MODE_INBETWEEN>`, this drop section halves in height and stays centered vertically.
|
||||
|
||||
.. _class_Tree_constant_DROP_MODE_INBETWEEN:
|
||||
|
||||
@@ -624,9 +624,9 @@ When combined with :ref:`DROP_MODE_INBETWEEN<class_Tree_constant_DROP_MODE_INBET
|
||||
|
||||
:ref:`DropModeFlags<enum_Tree_DropModeFlags>` **DROP_MODE_INBETWEEN** = ``2``
|
||||
|
||||
Enables "above item" and "below item" drop sections. The "above item" drop section covers the top half of the item, and the "below item" drop section covers the bottom half.
|
||||
Enables "above item" and "below item" drop sections. The "above item" drop section covers the top half of the item, while the "below item" drop section covers the bottom half, and extends downward to the left of any children.
|
||||
|
||||
When combined with :ref:`DROP_MODE_ON_ITEM<class_Tree_constant_DROP_MODE_ON_ITEM>`, these drop sections halves the height and stays on top / bottom accordingly.
|
||||
When combined with :ref:`DROP_MODE_ON_ITEM<class_Tree_constant_DROP_MODE_ON_ITEM>`, these drop sections halve in height and stay at the top and bottom respectively.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
@@ -1176,11 +1176,19 @@ Returns the rectangle for custom popups. Helper to create custom cell controls t
|
||||
|
||||
:ref:`int<class_int>` **get_drop_section_at_position**\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`🔗<class_Tree_method_get_drop_section_at_position>`
|
||||
|
||||
Returns the drop section at ``position``, or -100 if no item is there.
|
||||
Returns the drop section at ``position``, as permitted by enabled :ref:`DropModeFlags<enum_Tree_DropModeFlags>`.
|
||||
|
||||
Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. See :ref:`DropModeFlags<enum_Tree_DropModeFlags>` for a description of each drop section.
|
||||
- ``-1`` if the position is **above** the item. Typically used to insert as the item's previous sibling.
|
||||
|
||||
To get the item which the returned drop section is relative to, use :ref:`get_item_at_position()<class_Tree_method_get_item_at_position>`.
|
||||
- ``0`` if the position is **on** the item. Typically used to insert as the item's last child.
|
||||
|
||||
- ``1`` if the position is **below** the item, when the item has no children. Typically used to insert as the item's next sibling. If the item *does* have children, this section is still reachable by hovering to the left of the item's collapse arrow, and below.
|
||||
|
||||
- ``2`` if the position is **below** the item, when the item has children. Typically used to insert as the item's first child.
|
||||
|
||||
- ``-100`` if the position is not over any item, or no :ref:`DropModeFlags<enum_Tree_DropModeFlags>` are set.
|
||||
|
||||
See :ref:`DropModeFlags<enum_Tree_DropModeFlags>` for a description of each drop region. To get the item which the returned drop section refers to, use :ref:`get_item_at_position()<class_Tree_method_get_item_at_position>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
|
||||
@@ -32,6 +32,8 @@ Tutorials
|
||||
|
||||
- :doc:`HDR output <../tutorials/rendering/hdr_output>`
|
||||
|
||||
- `Multiple Windows demo <https://github.com/godotengine/godot-demo-projects/tree/master/misc/multiple_windows>`__
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
|
||||
Reference in New Issue
Block a user