: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/ARLightEstimate.xml.

.. _class_ARLightEstimate:

ARLightEstimate
===============

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Lighting information estimated from the current AR frame.

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

Description
-----------

Provides ambient and directional lighting values extracted from the current frame. Use these values to better match virtual content to the real scene. Directional light data is only present when the platform exposes it; otherwise those fields remain zero or empty.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                           | :ref:`ambient_color_temperature<class_ARLightEstimate_property_ambient_color_temperature>`               | ``0.0``                  |
   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                           | :ref:`ambient_intensity<class_ARLightEstimate_property_ambient_intensity>`                               | ``0.0``                  |
   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector3<class_Vector3>`                       | :ref:`primary_light_direction<class_ARLightEstimate_property_primary_light_direction>`                   | ``Vector3(0, 0, 0)``     |
   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                           | :ref:`primary_light_intensity<class_ARLightEstimate_property_primary_light_intensity>`                   | ``0.0``                  |
   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+
   | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`spherical_harmonics_coefficients<class_ARLightEstimate_property_spherical_harmonics_coefficients>` | ``PackedFloat32Array()`` |
   +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------+--------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------+--------------------------------------------------------------------------+
   | :ref:`bool<class_bool>` | :ref:`is_directional<class_ARLightEstimate_method_is_directional>`\ (\ ) |
   +-------------------------+--------------------------------------------------------------------------+

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

----

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

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

.. _class_ARLightEstimate_property_ambient_color_temperature:

.. rst-class:: classref-property

:ref:`float<class_float>` **ambient_color_temperature** = ``0.0`` :ref:`🔗<class_ARLightEstimate_property_ambient_color_temperature>`

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

- |void| **set_ambient_color_temperature**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_ambient_color_temperature**\ (\ )

Estimated ambient color temperature in Kelvin.

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

----

.. _class_ARLightEstimate_property_ambient_intensity:

.. rst-class:: classref-property

:ref:`float<class_float>` **ambient_intensity** = ``0.0`` :ref:`🔗<class_ARLightEstimate_property_ambient_intensity>`

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

- |void| **set_ambient_intensity**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_ambient_intensity**\ (\ )

Estimated ambient light intensity.

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

----

.. _class_ARLightEstimate_property_primary_light_direction:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **primary_light_direction** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_ARLightEstimate_property_primary_light_direction>`

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

- |void| **set_primary_light_direction**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_primary_light_direction**\ (\ )

Direction of the dominant light source when directional lighting is available.

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

----

.. _class_ARLightEstimate_property_primary_light_intensity:

.. rst-class:: classref-property

:ref:`float<class_float>` **primary_light_intensity** = ``0.0`` :ref:`🔗<class_ARLightEstimate_property_primary_light_intensity>`

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

- |void| **set_primary_light_intensity**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_primary_light_intensity**\ (\ )

Intensity of the dominant light source when directional lighting is available.

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

----

.. _class_ARLightEstimate_property_spherical_harmonics_coefficients:

.. rst-class:: classref-property

:ref:`PackedFloat32Array<class_PackedFloat32Array>` **spherical_harmonics_coefficients** = ``PackedFloat32Array()`` :ref:`🔗<class_ARLightEstimate_property_spherical_harmonics_coefficients>`

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

- |void| **set_spherical_harmonics_coefficients**\ (\ value\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_spherical_harmonics_coefficients**\ (\ )

Spherical harmonics coefficients describing ambient scene lighting.

**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array<class_PackedFloat32Array>` for more details.

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

----

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

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

.. _class_ARLightEstimate_method_is_directional:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_directional**\ (\ ) :ref:`🔗<class_ARLightEstimate_method_is_directional>`

Returns ``true`` when directional light information is available in addition to ambient lighting.

.. |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.)`