:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/AREnvironmentProbeAnchor.xml. .. _class_AREnvironmentProbeAnchor: AREnvironmentProbeAnchor ======================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` An anchor that captures environment lighting for realistic reflections. .. rst-class:: classref-introduction-group Description ----------- Represents a captured environment texture probe at a specific location and extent. Generated automatically when ``environmentTexturing`` is set to ``AUTOMATIC`` on the configuration. **iOS only.** On visionOS and macOS, this type exists for API consistency but is never populated with real data. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`extent` | ``Vector3(0, 0, 0)`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`bool` | :ref:`has_environment_texture` | ``false`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`identifier` | ``""`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`texture_height` | ``0`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`texture_width` | ``0`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | +---------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AREnvironmentProbeAnchor_property_extent: .. rst-class:: classref-property :ref:`Vector3` **extent** = ``Vector3(0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_extent**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_extent**\ (\ ) The size of the region covered by this environment probe. .. rst-class:: classref-item-separator ---- .. _class_AREnvironmentProbeAnchor_property_has_environment_texture: .. rst-class:: classref-property :ref:`bool` **has_environment_texture** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_has_environment_texture**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_has_environment_texture**\ (\ ) Whether the probe currently contains a captured environment texture. .. rst-class:: classref-item-separator ---- .. _class_AREnvironmentProbeAnchor_property_identifier: .. rst-class:: classref-property :ref:`String` **identifier** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_identifier**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_identifier**\ (\ ) A unique identifier for this environment probe anchor. .. rst-class:: classref-item-separator ---- .. _class_AREnvironmentProbeAnchor_property_texture_height: .. rst-class:: classref-property :ref:`int` **texture_height** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_height**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_texture_height**\ (\ ) The height of the captured environment texture in pixels. .. rst-class:: classref-item-separator ---- .. _class_AREnvironmentProbeAnchor_property_texture_width: .. rst-class:: classref-property :ref:`int` **texture_width** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_width**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_texture_width**\ (\ ) The width of the captured environment texture in pixels. .. rst-class:: classref-item-separator ---- .. _class_AREnvironmentProbeAnchor_property_transform: .. rst-class:: classref-property :ref:`Transform3D` **transform** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) - :ref:`Transform3D` **get_transform**\ (\ ) The probe transform in world space. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`