Texture

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

open class Texture : AutoCloseable

Represents a Texture in SceneCore.

A texture is an image that can be applied to a 3D model to give it color, detail, and realism. It can also be used as an alpha mask for a StereoSurfaceEntity.

It's important to close a Texture when it's no longer needed to free up resources. This can be done by calling the close method or letting it get garbage collected.

Summary

Public companion functions
`suspend Texture`	`@MainThread create(session: Session, path: Path)` Public factory for a Texture, asynchronously loading a preprocessed texture from a `Path` relative to the application's `assets/` folder.

Public functions
`open Unit`	`@MainThread close()` Closes the given `Texture`.

Public companion functions

create

@MainThread
suspend fun create(session: Session, path: Path): Texture

Public factory for a Texture, asynchronously loading a preprocessed texture from a Path relative to the application's assets/ folder.

Currently, only URLs and relative paths from the assets/ directory are supported.

Parameters
`session: Session`	The `Session` to use for loading the `Texture`.
`path: Path`	The Path of the `.png` texture file to be loaded, relative to the application's `assets/` folder.

Returns
`Texture`	a `Texture` upon completion.

Throws
`kotlin.IllegalArgumentException`	if `Path.isAbsolute` is true, as this method requires a relative path.

Public functions

close

Added in 1.0.0-alpha08

@MainThread
open fun close(): Unit

Closes the given Texture.

The Texture can be explicitly closed at anytime or garbage collected. In both cases, its resources are freed and an exception will be thrown if the Texture is used after being closed.