class ExrImage

Represents an EXR image in SceneCore.

EXR images are used by the SpatialEnvironment for drawing skyboxes.

Summary

Public companion functions
suspend ExrImage
@MainThread
createFromZip(session: Session, path: Path)

Public factory for an ExrImage, asynchronously loading a preprocessed skybox from a Path relative to the application's assets/ folder.
suspend ExrImage
@MainThread
createFromZip(session: Session, uri: Uri)

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

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

Public companion functions

createFromZip

@MainThread
suspend fun createFromZip(session: Session, path: Path): ExrImage

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
session: Session

The Session to use for loading the asset.
path: Path

The Path of the preprocessed .zip skybox file to be loaded, relative to the application's assets/ folder.
Returns
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
suspend fun createFromZip(session: Session, uri: Uri): ExrImage

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
session: Session

The Session to use for loading the asset.
uri: Uri

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

a ExrImage upon completion.
Throws
kotlin.IllegalArgumentException

if the Uri does not specify a .zip file.

Public functions

equals

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

hashCode

open fun hashCode(): Int