.. _stdlib_ambient_settings_component:

================
Ambient Settings
================


++++++++++++
Enumerations
++++++++++++

.. _enum-public_components-AmbientSource:

.. das:attribute:: AmbientSource

:Values: * **SkyColor** = 0 - Use skybox as source of ambient light.

         * **ConstColor** = 1 - Use ambientColor as source of ambient light.


+++++++
Classes
+++++++

.. _struct-ambient_settings_component-AmbientSettings:

.. das:attribute:: AmbientSettings : NativeComponent

This component is used to setup source and strength of the ambient light.

To use this component, add the following line to your project file::

    require engine.core_components.ambient_settings_component // or require engine.core

Usage example::

    let setting = create_render_settings()
    get_component(renderSettings) $(var ambient : AmbientSettings?) {
        ambient.ambientColor = float3(0.95, 0.5, 0.7)
        ambient.ambientStrength = 1f
        ambient.ambientSource = AmbientSource.ConstColor
    }


:Properties:

.. _function-ambient_settings_component__dot__rq_ambientColor_AmbientSettings:

.. das:operator:: AmbientSettings.ambientColor() : float3



.. _function-ambient_settings_component__dot__rq_ambientColor_rq_clone_AmbientSettings_float3:

.. das:operator:: AmbientSettings.ambientColor =(value: float3)

The color of the ambient light. Only used if ambientSource is set to ConstColor. Default is (1, 1, 1)

:Arguments: * **value** : float3

.. _function-ambient_settings_component__dot__rq_ambientStrength_AmbientSettings:

.. das:operator:: AmbientSettings.ambientStrength() : float



.. _function-ambient_settings_component__dot__rq_ambientStrength_rq_clone_AmbientSettings_float:

.. das:operator:: AmbientSettings.ambientStrength =(value: float)

The strength of the ambient light. Default is 0.15

:Arguments: * **value** : float

.. _function-ambient_settings_component__dot__rq_ambientSource_AmbientSettings:

.. das:operator:: AmbientSettings.ambientSource() : AmbientSource



.. _function-ambient_settings_component__dot__rq_ambientSource_rq_clone_AmbientSettings_AmbientSource:

.. das:operator:: AmbientSettings.ambientSource =(value: AmbientSource)

The type of the ambient light source. Default is SkyColor

:Arguments: * **value** :  :ref:`AmbientSource <enum-public_components-AmbientSource>`