# UAndroidXRBlueprintFunctionLibrary

`#include <AndroidXRBlueprintFunctionLibrary.h>`

<br />

## Summary

### Inheritance

Inherits from: `UBlueprintFunctionLibrary`

| ### Public static functions ||
|---|---|
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#destroyspace(https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSpace#struct_f_android_x_r_space & Space)` | `bool` Destroys the underlying XrSpace. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#enumeratedisplayrefreshrates(TArray< float > & DisplayRefreshRates)` | `bool` Enumerates the available display refresh rates. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#getcamerapassthroughsupported()` | `bool` Returns whether or not camera passthrough is supported. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#getdisplayrefreshrate(float & DisplayRefreshRate)` | `bool` Gets the current display refresh rate. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#geteventproxy()` | `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXREventProxy#class_u_android_x_r_event_proxy *` Gets the [AndroidXR](https://developer.android.com/develop/xr/unreal/reference/namespace/AndroidXR#namespace_android_x_r) event proxy, which allows users to bind to delegates which fired in response to XrEvents. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#getpassthroughcamerastate(https://developer.android.com/develop/xr/unreal/reference/other/AndroidXRTypes.h#eandroidxrpassthroughcamerastate & CameraState)` | `bool` Gets the passthrough camera state. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#isvalidspace(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSpace#struct_f_android_x_r_space & Space)` | `bool` Determines whether or not an [FAndroidXRSpace](https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSpace#struct_f_android_x_r_space) is valid. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#locatespace(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSpace#struct_f_android_x_r_space & Space, FTransform & Transform)` | `bool` Locates the underlying XrSpace and provides its current transform (base space is the HMD's). |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#perfsettingssetperformancelevel(https://developer.android.com/develop/xr/unreal/reference/other/AndroidXRTypes.h#eandroidxrperfsettingsdomain SettingsDomain, https://developer.android.com/develop/xr/unreal/reference/other/AndroidXRTypes.h#eandroidxrperfsettingslevel SettingsLevel)` | `bool` Set the performance level for a settings domain. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRBlueprintFunctionLibrary#requestdisplayrefreshrate(float DisplayRefreshRate)` | `bool` Requests a display refresh rate. |

## Public static functions

### DestroySpace

```
bool DestroySpace(
  FAndroidXRSpace & Space
)
```
Destroys the underlying XrSpace.

<br />

Details Parameters `Space` Space to be destroyed. **Returns** True if the underlying API call was successful.

### EnumerateDisplayRefreshRates

```
bool EnumerateDisplayRefreshRates(
  TArray< float > & DisplayRefreshRates
)
```
Enumerates the available display refresh rates.

<br />

Details Parameters `DisplayRefreshRates` Array to be populated with refresh rates. **Returns** True if the underlying API call was successful.

### GetCameraPassthroughSupported

```
bool GetCameraPassthroughSupported()
```
Returns whether or not camera passthrough is supported.

<br />

| Details ||
|---|---|
| **Returns** | True if camera passthrough is supported. |

### GetDisplayRefreshRate

```
bool GetDisplayRefreshRate(
  float & DisplayRefreshRate
)
```
Gets the current display refresh rate.

<br />

Details Parameters `DisplayRefreshRate` The current display refresh rate. **Returns** True if the underlying API call was successful.

### GetEventProxy

```
UAndroidXREventProxy * GetEventProxy()
```
Gets the [AndroidXR](https://developer.android.com/develop/xr/unreal/reference/namespace/AndroidXR#namespace_android_x_r) event proxy, which allows users to bind to delegates which fired in response to XrEvents.

<br />

| Details ||
|---|---|
| **Returns** | [AndroidXR](https://developer.android.com/develop/xr/unreal/reference/namespace/AndroidXR#namespace_android_x_r) event proxy static instance. |

### GetPassthroughCameraState

```
bool GetPassthroughCameraState(
  EAndroidXRPassthroughCameraState & CameraState
)
```
Gets the passthrough camera state.

<br />

Details Parameters `CameraState` The current passthrough camera state. **Returns** True if the underlying API call was successful.

### IsValidSpace

```
bool IsValidSpace(
  const FAndroidXRSpace & Space
)
```
Determines whether or not an [FAndroidXRSpace](https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSpace#struct_f_android_x_r_space) is valid.

<br />

Details Parameters `Space` Space to be verified. **Returns** True if the space is valid.

### LocateSpace

```
bool LocateSpace(
  const FAndroidXRSpace & Space,
  FTransform & Transform
)
```
Locates the underlying XrSpace and provides its current transform (base space is the HMD's).

<br />

Details Parameters `Space` Space to be located. `Current` transform. **Returns** True if the underlying API call was successful.

### PerfSettingsSetPerformanceLevel

```
bool PerfSettingsSetPerformanceLevel(
  EAndroidXRPerfSettingsDomain SettingsDomain,
  EAndroidXRPerfSettingsLevel SettingsLevel
)
```
Set the performance level for a settings domain.

<br />

Details Parameters `SettingsDomain` Settings domain to set. `SettingsLevel` Level to set. **Returns** True if the underlying API call was successful.

### RequestDisplayRefreshRate

```
bool RequestDisplayRefreshRate(
  float DisplayRefreshRate
)
```
Requests a display refresh rate.

<br />

Details Parameters `DisplayRefreshRate` Requested display refresh rate. **Returns** True if the underlying API call was successful.