SpatialEnvironment.SpatialEnvironmentPreference

class SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

The SpatialEnvironmentPreference can consist of image-based lighting and geometry. Setting the image-based lighting to null will result in no lighting for the scene, and setting the geometry to null will result in black void environment.

Summary

Public constructors
SpatialEnvironmentPreference(
    imageBasedLightingAsset: ImageBasedLightingAsset?,
    geometry: GltfModel?
)

Creates a preference for the SpatialEnvironment.

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
GltfModel?

The preferred geometry for the environment based on a pre-loaded GltfModel.
ImageBasedLightingAsset?

The preferred image-based lighting for the environment based on a pre-loaded ImageBasedLightingAsset.

Public constructors

SpatialEnvironmentPreference

Added in 1.0.0-alpha16
SpatialEnvironmentPreference(
    imageBasedLightingAsset: ImageBasedLightingAsset?,
    geometry: GltfModel?
)

Creates a preference for the SpatialEnvironment.

Parameters
imageBasedLightingAsset: ImageBasedLightingAsset?

The preferred image-based lighting for the environment.
geometry: GltfModel?

The preferred geometry for the environment.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

geometry

Added in 1.0.0-alpha16
val geometry: GltfModel?

The preferred geometry for the environment based on a pre-loaded GltfModel. The geometry can include a skybox texture for the horizon of the environment.

imageBasedLightingAsset

Added in 1.0.0-alpha16
val imageBasedLightingAsset: ImageBasedLightingAsset?

The preferred image-based lighting for the environment based on a pre-loaded ImageBasedLightingAsset. This lighting contributes to the overall illumination and reflections within the scene.