ImageBasedLightingAsset

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class ImageBasedLightingAsset implements AutoCloseable

Represents an image based lighting asset which contains lighting information for the scene.

EXR and HDR images are supported by the SpatialEnvironment.

Summary

Public methods
`void`	`@MainThread close()` Closes the given `ImageBasedLightingAsset`.
`static final @NonNull ImageBasedLightingAsset`	`@MainThread createFromZip(@NonNull Session session, @NonNull Path path)` Public factory for an `ImageBasedLightingAsset`, asynchronously loading a preprocessed image based lighting asset from a `Path` relative to the application's `assets/` folder.
`static final @NonNull ImageBasedLightingAsset`	`@MainThread createFromZip(@NonNull Session session, @NonNull Uri uri)` Public factory for an `ImageBasedLightingAsset`, asynchronously loading a preprocessed image based lighting asset from a `Uri`.
`boolean`	`equals(Object other)`
`int`	`hashCode()`

Public methods

close

Added in 1.0.0-alpha16

@MainThread
public void close()

Closes the given ImageBasedLightingAsset.

The ImageBasedLightingAsset can be explicitly closed at any time or garbage collected. When either happens, its resources are freed. If close() is not explicitly invoked by the client, the ImageBasedLightingAsset will be automatically closed when the ImageBasedLightingAsset is garbage collected.

Throws
`IllegalStateException`	if the resource has already been closed.

createFromZip

@MainThread
public static final @NonNull ImageBasedLightingAsset createFromZip(@NonNull Session session, @NonNull Path path)

Public factory for an ImageBasedLightingAsset, asynchronously loading a preprocessed image based lighting asset from a Path relative to the application's assets/ folder.

The input .zip file should contain the preprocessed image-based lighting (IBL) data, typically generated from an .exr or .hdr environment map using a tool like Filament's cmgen. See: https://github.com/google/filament/tree/main/tools/cmgen

Parameters
`@NonNull Session session`	The `Session` to use for loading the asset.
`@NonNull Path path`	The Path of the preprocessed `.zip` image based lighting asset file to be loaded, relative to the application's `assets/` folder.

Returns
`@NonNull ImageBasedLightingAsset`	a `ImageBasedLightingAsset` upon completion.

Throws
`IllegalArgumentException`	if `Path.isAbsolute` is true, as this method requires a relative path, or if the path does not specify a `.zip` file.

createFromZip

@MainThread
public static final @NonNull ImageBasedLightingAsset createFromZip(@NonNull Session session, @NonNull Uri uri)

Public factory for an ImageBasedLightingAsset, asynchronously loading a preprocessed image based lighting asset from a Uri.

Parameters
`@NonNull Session session`	The `Session` to use for loading the asset.
`@NonNull Uri uri`	The Uri of the preprocessed `.zip` image based lighting asset file to be loaded.

Returns
`@NonNull ImageBasedLightingAsset`	a `ImageBasedLightingAsset` upon completion.

Throws
`IllegalArgumentException`	if the Uri does not specify a `.zip` file.

equals

public boolean equals(Object other)

hashCode

public int hashCode()