open class Texture

Known direct subclasses
CubeMapTexture

CubeMapTexture represents a cube map texture that can be used with materials.

Texture represents a texture that can be used with materials.

Summary

Public companion functions
suspend Texture
@MainThread
create(session: Session, path: Path, sampler: TextureSampler)

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

Public functions
open Unit

Disposes the given Texture.

Public companion functions

create

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

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

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

Currently, only URLs and relative paths from the android_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.
sampler: TextureSampler

A TextureSampler descriptor which describes how the texture will be filtered
Returns
Texture

a Texture 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.

Public functions

dispose

Added in 1.0.0-alpha05
@MainThread
open fun dispose(): Unit

Disposes the given Texture.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

Currently, a glTF model (which this texture will be used with) can't be disposed. This means that calling dispose on the texture will lead to a crash if the call is made out of order, that is, if the texture is disposed before the glTF model that uses it.