# UAndroidXRLightEstimationBlueprintFunctionLibrary

`#include <AndroidXRLightEstimationBlueprintFunctionLibrary.h>`

<br />

## Summary

### Inheritance

Inherits from: `UBlueprintFunctionLibrary`

| ### Public static functions ||
|---|---|
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#applylightestimationcubemap(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapLightData#struct_f_android_x_r_cubemap_light_data & CubemapData, UTextureCube *TextureCube)` | `bool` Applies a cubemap data to a texture cube. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#createcubemaplightestimator(https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapConfiguration#struct_f_android_x_r_cubemap_configuration & Config, https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapEstimator#struct_f_android_x_r_cubemap_estimator & CubemapEstimator)` | `bool` Creates a cubemap light estimator. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#createcubemaptextureforlightestimation(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapEstimator#struct_f_android_x_r_cubemap_estimator & CubemapEstimator, UTextureCube *& TextureCube)` | `bool` Creates a cubemap texture for a cubemap light estimator. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#createlightestimator(https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRLightEstimator#struct_f_android_x_r_light_estimator & LightEstimator)` | `bool` Creates a light estimator. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#destroycubemapestimator(https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapEstimator#struct_f_android_x_r_cubemap_estimator & CubemapEstimator)` | `bool` Destroys a cubemap estimator. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#destroylightestimator(https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRLightEstimator#struct_f_android_x_r_light_estimator & LightEstimator)` | `bool` Destroys a light estimator. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#enumeratesupportedcubemapformats(TArray< https://developer.android.com/develop/xr/unreal/reference/other/AndroidXRLightEstimationTypes.h#eandroidxrcubemapcolorformat > & Formats)` | `bool` Gets the supported cubemap formats. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#enumeratesupportedcubemapresolutions(TArray< int > & Resolutions)` | `bool` Gets the supported cubemap resolutions. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#getambientlightdata(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRLightEstimator#struct_f_android_x_r_light_estimator & LightEstimator, https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRAmbientLightData#struct_f_android_x_r_ambient_light_data & AmbientLightData)` | `bool` Gets the ambient light data. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#getcubemapdata(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapEstimator#struct_f_android_x_r_cubemap_estimator & CubemapEstimator, https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRCubemapLightData#struct_f_android_x_r_cubemap_light_data & CubemapData)` | `bool` Gets the cubemap data. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#getdirectionallightdata(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRLightEstimator#struct_f_android_x_r_light_estimator & LightEstimator, https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRDirectionalLightData#struct_f_android_x_r_directional_light_data & DirectionalLightData)` | `bool` Gets the directional light data. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#getsphericalharmonicsdata(const https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRLightEstimator#struct_f_android_x_r_light_estimator & LightEstimator, https://developer.android.com/develop/xr/unreal/reference/other/AndroidXRLightEstimationTypes.h#eandroidxrsphericalharmonicskind HarmonicsKind, https://developer.android.com/develop/xr/unreal/reference/struct/FAndroidXRSphericalHarmonicsData#struct_f_android_x_r_spherical_harmonics_data & SphericalHarmonicsData)` | `bool` Gets the spherical harmonics data. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#iscubemaplightestimationsupported()` | `bool` Returns whether light estimation cubemap is supported for the device. |
| `https://developer.android.com/develop/xr/unreal/reference/class/UAndroidXRLightEstimationBlueprintFunctionLibrary#islightestimationsupported()` | `bool` Returns whether or not light estimation is supported on the device. |

## Public static functions

### ApplyLightEstimationCubemap

```
bool ApplyLightEstimationCubemap(
  const FAndroidXRCubemapLightData & CubemapData,
  UTextureCube *TextureCube
)
```
Applies a cubemap data to a texture cube.

<br />

Details Parameters `The` cubemap data to apply. `The` texture to update with the cubemap data. **Returns** True if the underlying API call was successful.

### CreateCubemapLightEstimator

```
bool CreateCubemapLightEstimator(
  FAndroidXRCubemapConfiguration & Config,
  FAndroidXRCubemapEstimator & CubemapEstimator
)
```
Creates a cubemap light estimator.

<br />

Details Parameters `The` configuration for creating the cubemap estimator. `The` created cubemap light estimator. **Returns** True if the underlying API call was successful.

### CreateCubemapTextureForLightEstimation

```
bool CreateCubemapTextureForLightEstimation(
  const FAndroidXRCubemapEstimator & CubemapEstimator,
  UTextureCube *& TextureCube
)
```
Creates a cubemap texture for a cubemap light estimator.

<br />

Details Parameters `The` cubemap estimator for which to create the cubemap texture. `The` texture cube for which to create the cubemap textures. **Returns** True if the underlying API call was successful.

### CreateLightEstimator

```
bool CreateLightEstimator(
  FAndroidXRLightEstimator & LightEstimator
)
```
Creates a light estimator.

<br />

Details Parameters `The` created light estimator. **Returns** True if the underlying API call was successful.

### DestroyCubemapEstimator

```
bool DestroyCubemapEstimator(
  FAndroidXRCubemapEstimator & CubemapEstimator
)
```
Destroys a cubemap estimator.

<br />

Details Parameters `
`

### DestroyLightEstimator

```
bool DestroyLightEstimator(
  FAndroidXRLightEstimator & LightEstimator
)
```
Destroys a light estimator.

<br />

Details Parameters `
`

### EnumerateSupportedCubemapFormats

```
bool EnumerateSupportedCubemapFormats(
  TArray< EAndroidXRCubemapColorFormat > & Formats
)
```
Gets the supported cubemap formats.

<br />

Details Parameters `The` supported cubemap formats. **Returns** True if the underlying API call was successful.

### EnumerateSupportedCubemapResolutions

```
bool EnumerateSupportedCubemapResolutions(
  TArray< int > & Resolutions
)
```
Gets the supported cubemap resolutions.

<br />

Details Parameters `The` supported cubemap resolutions. **Returns** True if the underlying API call was successful.

### GetAmbientLightData

```
bool GetAmbientLightData(
  const FAndroidXRLightEstimator & LightEstimator,
  FAndroidXRAmbientLightData & AmbientLightData
)
```
Gets the ambient light data.

<br />

Details Parameters `The` light estimator to get the ambient light data. `The` ambient light data. **Returns** True if the underlying API call was successful.

### GetCubemapData

```
bool GetCubemapData(
  const FAndroidXRCubemapEstimator & CubemapEstimator,
  FAndroidXRCubemapLightData & CubemapData
)
```
Gets the cubemap data.

<br />

Details Parameters `The` cubemap estimator. `The` cubemap light data. **Returns** True if the underlying API call was successful.

### GetDirectionalLightData

```
bool GetDirectionalLightData(
  const FAndroidXRLightEstimator & LightEstimator,
  FAndroidXRDirectionalLightData & DirectionalLightData
)
```
Gets the directional light data.

<br />

Details Parameters `The` light estimator to get the directional light data. `The` directional light data. **Returns** True if the underlying API call was successful.

### GetSphericalHarmonicsData

```
bool GetSphericalHarmonicsData(
  const FAndroidXRLightEstimator & LightEstimator,
  EAndroidXRSphericalHarmonicsKind HarmonicsKind,
  FAndroidXRSphericalHarmonicsData & SphericalHarmonicsData
)
```
Gets the spherical harmonics data.

<br />

Details Parameters `The` light estimator to get the spherical harmonics data. `The` spherical harmonics data. **Returns** True if the underlying API call was successful.

### IsCubemapLightEstimationSupported

```
bool IsCubemapLightEstimationSupported()
```
Returns whether light estimation cubemap is supported for the device.

<br />

| Details ||
|---|---|
| **Returns** | True if device supports light estimation cubemap. |

### IsLightEstimationSupported

```
bool IsLightEstimationSupported()
```
Returns whether or not light estimation is supported on the device.

<br />

| Details ||
|---|---|
| **Returns** | True if light estimation is supported. |