UAndroidXRGlobalDimmingBlueprintFunctionLibrary

#include <AndroidXRGlobalDimmingBlueprintFunctionLibrary.h>

Summary

Inheritance

Inherits from: UBlueprintFunctionLibrary

Public static functions
EnumerateSupportedGlobalDimmingLevels(bool & AllLevelsSupported, TArray< float > & SupportedGlobalDimmingLevels)
bool
Enumerates the global dimming levels supported by the system.
GetEventProxy()
Gets the AndroidXRGlobalDimming event proxy, which allows users to bind to delegates which fired in response to XrEvents.
GetGlobalDimmingLevel(float & CurrentDimmingLevel)
bool
Gets the current global dimming level.
GetGlobalDimmingSupported()
bool
Checks if global dimming is supported by the system.
SetGlobalDimmingLevel(float PreferredDimmingLevel)
bool
Sets the preferred global dimming level.

Public static functions

EnumerateSupportedGlobalDimmingLevels

bool EnumerateSupportedGlobalDimmingLevels(
  bool & AllLevelsSupported,
  TArray< float > & SupportedGlobalDimmingLevels
)

Enumerates the global dimming levels supported by the system.

If returns true but SupportedGlobalDimmingLevels is empty all levels are supported.

Details
Parameters
True
if all levels between 0 and 1 are supported. SupportedGlobalDimmingLevels will be empty if this is true.
An
array of supported levels, but can be empty if all levels between 0 and 1 are supported.
Returns
True if the underlying API call was successful.

GetEventProxy

UAndroidXRGlobalDimmingEventProxy * GetEventProxy()

Gets the AndroidXRGlobalDimming event proxy, which allows users to bind to delegates which fired in response to XrEvents.

Details
Returns
AndroidXRGlobalDimming event proxy static instance.

GetGlobalDimmingLevel

bool GetGlobalDimmingLevel(
  float & CurrentDimmingLevel
)

Gets the current global dimming level.

Details
Parameters
The
current global dimming level.
Returns
True if the underlying API call was successful.

GetGlobalDimmingSupported

bool GetGlobalDimmingSupported()

Checks if global dimming is supported by the system.

Details
Returns
True if the system supports global dimming.

SetGlobalDimmingLevel

bool SetGlobalDimmingLevel(
  float PreferredDimmingLevel
)

Sets the preferred global dimming level.

EnumerateSupportedGlobalDimmingLevels will provide the supported levels.

Details
Parameters
The
preferred global dimming level. Must be between 0 and 1. Values will be clamped. Call EnumerateSupportedGlobalDimmingLevels to return the supported dimming levels.
Returns
True if the underlying API call was successful.