DirectionalLight

Inherits: :ref:`Light<class_Light>` < :ref:`VisualInstance<class_VisualInstance>` < :ref:`Spatial<class_Spatial>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`

Directional light from a distance, as from the Sun.

Description

A directional light is a type of :ref:`Light<class_Light>` node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used to determine light direction.

Tutorials

• :doc:`../tutorials/3d/lights_and_shadows`

Properties

Enumerations

enum ShadowMode:

• SHADOW_ORTHOGONAL = 0 --- Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects.
• SHADOW_PARALLEL_2_SPLITS = 1 --- Splits the view frustum in 2 areas, each with its own shadow map.
• SHADOW_PARALLEL_4_SPLITS = 2 --- Splits the view frustum in 4 areas, each with its own shadow map.

enum ShadowDepthRange:

• SHADOW_DEPTH_RANGE_STABLE = 0 --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution.
• SHADOW_DEPTH_RANGE_OPTIMIZED = 1 --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges.

Property Descriptions

• :ref:`float<class_float>` directional_shadow_bias_split_scale

Amount of extra bias for shadow splits that are far away. If self-shadowing occurs only on the splits far away, increasing this value can fix them.

• :ref:`bool<class_bool>` directional_shadow_blend_splits

If true, shadow detail is sacrificed in exchange for smoother transitions between splits.

• :ref:`ShadowDepthRange<enum_DirectionalLight_ShadowDepthRange>` directional_shadow_depth_range

Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange<enum_DirectionalLight_ShadowDepthRange>`.

• :ref:`float<class_float>` directional_shadow_fade_start

• :ref:`float<class_float>` directional_shadow_max_distance

The maximum distance for shadow splits.

• :ref:`ShadowMode<enum_DirectionalLight_ShadowMode>` directional_shadow_mode

The light's shadow rendering algorithm. See :ref:`ShadowMode<enum_DirectionalLight_ShadowMode>`.

• :ref:`float<class_float>` directional_shadow_normal_bias

Can be used to fix special cases of self shadowing when objects are perpendicular to the light.

• :ref:`float<class_float>` directional_shadow_split_1

The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance<class_DirectionalLight_property_directional_shadow_max_distance>`. Only used when :ref:`directional_shadow_mode<class_DirectionalLight_property_directional_shadow_mode>` is SHADOW_PARALLEL_2_SPLITS or SHADOW_PARALLEL_4_SPLITS.

• :ref:`float<class_float>` directional_shadow_split_2

The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance<class_DirectionalLight_property_directional_shadow_max_distance>`. Only used when :ref:`directional_shadow_mode<class_DirectionalLight_property_directional_shadow_mode>` is SHADOW_PARALLEL_2_SPLITS or SHADOW_PARALLEL_4_SPLITS.

• :ref:`float<class_float>` directional_shadow_split_3

The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance<class_DirectionalLight_property_directional_shadow_max_distance>`. Only used when :ref:`directional_shadow_mode<class_DirectionalLight_property_directional_shadow_mode>` is SHADOW_PARALLEL_4_SPLITS.