public final class ExrImage

Represents an EXR image in SceneCore.

EXR images are used by the SpatialEnvironment for drawing skyboxes.

Summary

Public methods
static final @NonNull ExrImage

Public factory for an ExrImage, asynchronously loading a preprocessed skybox from a Path relative to the application's assets/ folder.
static final @NonNull ExrImage

Public factory for an ExrImage, asynchronously loading a preprocessed skybox from a Uri.
boolean
equals(Object other)
int

Public methods

createFromZip

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

Public factory for an ExrImage, asynchronously loading a preprocessed skybox 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 skybox file to be loaded, relative to the application's assets/ folder.
Returns
@NonNull ExrImage

a ExrImage upon completion.
Throws
kotlin.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 ExrImage createFromZip(@NonNull Session session, @NonNull Uri uri)

Public factory for an ExrImage, asynchronously loading a preprocessed skybox from a Uri.

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 Uri uri

The Uri of the preprocessed .zip skybox file to be loaded.
Returns
@NonNull ExrImage

a ExrImage upon completion.
Throws
kotlin.IllegalArgumentException

if the Uri does not specify a .zip file.

equals

public boolean equals(Object other)

hashCode

public int hashCode()