OpenXRAndroidLightEstimationExtensionWrapper

Inherits: OpenXRExtensionWrapperExtension

Wraps the XR_ANDROID_light_estimation extension.

Description

Wraps the XR_ANDROID_light_estimation extension.

Properties

LightEstimateType

light_estimate_types

0

Methods

Color

get_ambient_light_color_correction ( ) const

Color

get_ambient_light_intensity ( ) const

Vector3

get_directional_light_direction ( ) const

Color

get_directional_light_intensity ( ) const

int

get_last_updated_time ( ) const

PackedVector3Array

get_spherical_harmonics_ambient_coefficients ( ) const

PackedVector3Array

get_spherical_harmonics_total_coefficients ( ) const

bool

is_ambient_light_valid ( ) const

bool

is_directional_light_valid ( ) const

bool

is_estimate_valid ( ) const

bool

is_light_estimation_started ( )

bool

is_light_estimation_supported ( )

bool

is_spherical_harmonics_ambient_valid ( ) const

bool

is_spherical_harmonics_total_valid ( ) const

bool

start_light_estimation ( )

void

stop_light_estimation ( )

Enumerations

enum LightEstimateType:

LightEstimateType LIGHT_ESTIMATE_TYPE_DIRECTIONAL_LIGHT = 1

Directional light data.

LightEstimateType LIGHT_ESTIMATE_TYPE_AMBIENT = 2

Simple ambient light data.

LightEstimateType LIGHT_ESTIMATE_TYPE_SPHERICAL_HARMONICS_AMBIENT = 4

Ambient spherical harmonics data.

LightEstimateType LIGHT_ESTIMATE_TYPE_SPHERICAL_HARMONICS_TOTAL = 8

Total spherical harmonics data.

LightEstimateType LIGHT_ESTIMATE_TYPE_ALL = 2147483647

All available types of light estimation data.

Property Descriptions

LightEstimateType light_estimate_types = 0

Bitfield of all the types of light estimation data that will be queried when light estimation is running.

If a light estimation type isn't OR'd into this field, then its data will always be invalid.

Method Descriptions

Color get_ambient_light_color_correction ( ) const

Gets the color correction in gamma space, which can be multiplied with a gamma corrected output color.

Only valid if is_ambient_light_valid returns true.

Color get_ambient_light_intensity ( ) const

Gets the ambient light color in linear space, premultiplied with intensity (so values can be greater than 1.0).

Only valid if is_ambient_light_valid returns true.

Vector3 get_directional_light_direction ( ) const

Gets the direction of the directional light as a normalized vector.

Only valid if is_directional_light_valid returns true.

Color get_directional_light_intensity ( ) const

Gets the directional light color in linear space, premultiplied with intensity (so values can be greater than 1.0).

Only valid if is_directional_light_valid returns true.

int get_last_updated_time ( ) const

Gets a value representing the last time the light estimation data was updated.

This is can be used to check if the data has changed since the last time you checked.

PackedVector3Array get_spherical_harmonics_ambient_coefficients ( ) const

Gets 9 spherical harmonics coefficients representing the environment light radiance, excluding the contribution from the directional light.

Only valid if is_spherical_harmonics_ambient_valid returns true.

PackedVector3Array get_spherical_harmonics_total_coefficients ( ) const

Gets 9 spherical harmonics coefficients representing the environment light radiance, including the contribution from the directional light.

Only valid if is_spherical_harmonics_total_valid returns true.

bool is_ambient_light_valid ( ) const

Returns true if the current ambient light data is valid; otherwise, false.

bool is_directional_light_valid ( ) const

Returns true if the current directional light data is valid; otherwise, false.

bool is_estimate_valid ( ) const

Returns true if any of the current data is valid; otherwise, false.

bool is_light_estimation_started ( )

Returns true if light estimation has successfully started; otherwise, false.

bool is_light_estimation_supported ( )

Returns true if light estimation is supported on this headset; otherwise, false.

bool is_spherical_harmonics_ambient_valid ( ) const

Returns true if the current ambient spherical harmonics data is valid; otherwise, false.

bool is_spherical_harmonics_total_valid ( ) const

Returns true if the current total spherical harmonics data is valid; otherwise, false.

bool start_light_estimation ( )

Attempts to start light estimation, and returns true if successful.

void stop_light_estimation ( )

Stops light estimation.