OpenXRAndroidGlobalPassthroughDimmingExtension

Inherits: OpenXRExtensionWrapper

Allow requesting a global passthrough dimming level via the XR_ANDROID_global_passthrough_dimming extension.

Description

Allow requesting a global passthrough dimming level via the XR_ANDROID_global_passthrough_dimming extension.

Methods

float	get_dimming_level ( ) const
PackedFloat32Array	get_supported_dimming_levels ( )
bool	is_enabled ( ) const
void	set_dimming_level ( float dimming_level )

---

Signals

openxr_android_global_passthrough_dimming_level_changed ( )

Emitted when the global passthrough dimming level has changed, either due to calling set_dimming_level or the user interacting with system controls.

---

Method Descriptions

float get_dimming_level ( ) const

Gets the current global passthrough dimming level, with a range from 0.0 (no dimming) to 1.0 (maximum dimming).

---

PackedFloat32Array get_supported_dimming_levels ( )

Gets an array of the supported dimming levels on this device.

---

bool is_enabled ( ) const

Returns true if this extension is supported on this device; otherwise, false.

---

void set_dimming_level ( float dimming_level )

Requests changing the current global passthrough dimming level, with a range from 0.0 (no dimming) to 1.0 (maximum dimming).

This is only a request, which may be ignored or modified. You can call get_dimming_level to get the actual dimming level, however, it won't be updated right away, so you may want to connect to openxr_android_global_passthrough_dimming_level_changed.