OpenXRAndroidLightEstimation

Inherits: Node3D

Applies light estimation data from XR_ANDROID_light_estimation to a DirectionalLight3D and WorldEnvironment.

Description

Applies light estimation data from XR_ANDROID_light_estimation to a DirectionalLight3D and WorldEnvironment.

Properties

float

ambient_light_energy_multiplier

1.0

AmbientLightMode

ambient_light_mode

1

DirectionalLight3D

directional_light

float

directional_light_energy_multiplier

1.0

DirectionalLightMode

directional_light_mode

1

WorldEnvironment

world_environment


Enumerations

enum DirectionalLightMode:

DirectionalLightMode DIRECTIONAL_LIGHT_MODE_DISABLED = 0

Don't make any changes to the directional light.

DirectionalLightMode DIRECTIONAL_LIGHT_MODE_DIRECTION_ONLY = 1

Only update the direction of the directional light.

DirectionalLightMode DIRECTIONAL_LIGHT_MODE_DIRECTION_INTENSITY = 2

Update the direction and intensity of the directional light.

DirectionalLightMode DIRECTIONAL_LIGHT_MODE_DIRECTION_COLOR_INTENSITY = 3

Update the direction, color, and intensity of the directional light.


enum AmbientLightMode:

AmbientLightMode AMBIENT_LIGHT_MODE_DISABLED = 0

Don't make any changes to the environment.

AmbientLightMode AMBIENT_LIGHT_MODE_COLOR = 1

Only update the environment's ambient color.

AmbientLightMode AMBIENT_LIGHT_MODE_SPHERICAL_HARMONICS = 2

Use spherical harmonics from the light estimation data to update the environment's radiance map.


Property Descriptions

float ambient_light_energy_multiplier = 1.0

  • void set_ambient_light_energy_multiplier ( float value )

  • float get_ambient_light_energy_multiplier ( )

The value ambient light energy is multiplied by.


AmbientLightMode ambient_light_mode = 1

Controls how ambient light data is applied to the WorldEnvironment.


DirectionalLight3D directional_light

  • void set_directional_light ( DirectionalLight3D value )

  • DirectionalLight3D get_directional_light ( )

The DirectionalLight3D that the light estimation data is applied to.


float directional_light_energy_multiplier = 1.0

  • void set_ambient_light_energy_multiplier ( float value )

  • float get_ambient_light_energy_multiplier ( )

The value directional light energy is multiplied by.


DirectionalLightMode directional_light_mode = 1

Controls how directional light data is applied to the DirectionalLight3D.


WorldEnvironment world_environment

  • void set_world_environment ( WorldEnvironment value )

  • WorldEnvironment get_world_environment ( )

The WorldEnvironment that the light estimation data is applied to.