public class Texture implements 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 methods

void

Closes the given Texture.

static final @NonNull Texture

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

Public methods

close

Added in 1.0.0-alpha08
@MainThread
public void close()

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.

create

@MainThread
public static final @NonNull Texture create(@NonNull Session session, @NonNull Path path)

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
@NonNull Session session

The Session to use for loading the Texture.

@NonNull Path path

The Path of the .png texture file to be loaded, relative to the application's assets/ folder.

Returns
@NonNull Texture

a Texture upon completion.

Throws
kotlin.IllegalArgumentException

if Path.isAbsolute is true, as this method requires a relative path.