UAndroidXRLightEstimationBlueprintFunctionLibrary

#include <AndroidXRLightEstimationBlueprintFunctionLibrary.h>

Summary

Inheritance

Inherits from: UBlueprintFunctionLibrary

Public static functions
ApplyLightEstimationCubemap(const FAndroidXRCubemapLightData & CubemapData, UTextureCube *TextureCube)	bool Applies a cubemap data to a texture cube.
CreateCubemapLightEstimator(FAndroidXRCubemapConfiguration & Config, FAndroidXRCubemapEstimator & CubemapEstimator)	bool Creates a cubemap light estimator.
CreateCubemapTextureForLightEstimation(const FAndroidXRCubemapEstimator & CubemapEstimator, UTextureCube *& TextureCube)	bool Creates a cubemap texture for a cubemap light estimator.
CreateLightEstimator(FAndroidXRLightEstimator & LightEstimator)	bool Creates a light estimator.
DestroyCubemapEstimator(FAndroidXRCubemapEstimator & CubemapEstimator)	bool Destroys a cubemap estimator.
DestroyLightEstimator(FAndroidXRLightEstimator & LightEstimator)	bool Destroys a light estimator.
EnumerateSupportedCubemapFormats(TArray< EAndroidXRCubemapColorFormat > & Formats)	bool Gets the supported cubemap formats.
EnumerateSupportedCubemapResolutions(TArray< int > & Resolutions)	bool Gets the supported cubemap resolutions.
GetAmbientLightData(const FAndroidXRLightEstimator & LightEstimator, FAndroidXRAmbientLightData & AmbientLightData)	bool Gets the ambient light data.
GetCubemapData(const FAndroidXRCubemapEstimator & CubemapEstimator, FAndroidXRCubemapLightData & CubemapData)	bool Gets the cubemap data.
GetDirectionalLightData(const FAndroidXRLightEstimator & LightEstimator, FAndroidXRDirectionalLightData & DirectionalLightData)	bool Gets the directional light data.
GetSphericalHarmonicsData(const FAndroidXRLightEstimator & LightEstimator, EAndroidXRSphericalHarmonicsKind HarmonicsKind, FAndroidXRSphericalHarmonicsData & SphericalHarmonicsData)	bool Gets the spherical harmonics data.
IsCubemapLightEstimationSupported()	bool Returns whether light estimation cubemap is supported for the device.
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.

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.

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.

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.

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

DestroyCubemapEstimator

bool DestroyCubemapEstimator(
  FAndroidXRCubemapEstimator & CubemapEstimator
)

Destroys a cubemap estimator.

Details
Parameters

DestroyLightEstimator

bool DestroyLightEstimator(
  FAndroidXRLightEstimator & LightEstimator
)

Destroys a light estimator.

Details
Parameters

EnumerateSupportedCubemapFormats

bool EnumerateSupportedCubemapFormats(
  TArray< EAndroidXRCubemapColorFormat > & Formats
)

Gets the supported cubemap formats.

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.

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.

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.

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.

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.

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.

Details
Returns	True if device supports light estimation cubemap.

IsLightEstimationSupported

bool IsLightEstimationSupported()

Returns whether or not light estimation is supported on the device.

Details
Returns	True if light estimation is supported.