filament/io.github.erkko68.filament/Texture

Texture

class Texture(nativeHandle: NativePointer)

Texture represents a GPU texture resource.

The Texture class supports:

2D textures
3D textures
Cube maps
Mip mapping

Creation and destruction

========================

A Texture object is created using the Texture.Builder and destroyed by calling Engine.destroy(texture).

val engine = Engine.create()!!

val texture = Texture.Builder()
    .width(64)
    .height(64)
    .build(engine)

engine.destroy(texture)

Constructors

Texture

constructor(nativeHandle: NativePointer)

Types

Builder

class Builder

Builder for creating Texture instances.

Companion

object Companion

CubemapFace

enum CubemapFace : Enum<Texture.CubemapFace>

Cubemap face identifiers.

Format

enum Format : Enum<Texture.Format>

Pixel color format (how data is laid out in the client buffer for setImage()).

InternalFormat

enum InternalFormat : Enum<Texture.InternalFormat>

Internal texel format (how texels are stored in memory).

PixelBufferDescriptor

class PixelBufferDescriptor(val storage: ByteArray, val sizeInBytes: Int, val format: Texture.Format, val type: Texture.Type, val alignment: Int = 1, val left: Int = 0, val top: Int = 0, val stride: Int = 0, val callback: () -> Unit? = null)

Describes pixel buffer data for uploading to a texture via setImage().

Sampler

enum Sampler : Enum<Texture.Sampler>

Sampler type for texture sampling.

Swizzle

enum Swizzle : Enum<Texture.Swizzle>

Texture channel swizzle (maps channels to output RGBA).

Type

enum Type : Enum<Texture.Type>

Pixel data type (size and signedness of color components in the client buffer for setImage()).

Usage

object Usage

Texture usage flags affecting memory layout and capabilities.

Properties

format

val format: Texture.InternalFormat

Return this texture InternalFormat as set by Builder.format().

levels

val levels: Int

Returns the maximum number of levels this texture can have.

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

target

val target: Texture.Sampler

Return this texture Sampler as set by Builder.sampler().

Functions

generateMipmaps

fun generateMipmaps(engine: Engine)

Generates all mipmap levels automatically.

getDepth

fun getDepth(level: Int = 0): Int

Returns the depth of a 3D texture level.

getHeight

fun getHeight(level: Int = 0): Int

Returns the height of a 2D or 3D texture level.

getWidth

fun getWidth(level: Int = 0): Int

Returns the width of a 2D or 3D texture level.

isCreationComplete

fun isCreationComplete(): Boolean

Returns whether this texture's creation is complete: always true unless the Builder was asynchronous.

setExternalStream

fun setExternalStream(engine: Engine, stream: Stream)

Associates an external stream with this texture. Typically the external stream is OS-specific and can be a video or camera stream.

setImage

fun setImage(engine: Engine, level: Int, descriptor: Texture.PixelBufferDescriptor)

Updates a 2D texture level with image data from a buffer.

fun setImage(engine: Engine, level: Int, xoffset: Int, yoffset: Int, width: Int, height: Int, descriptor: Texture.PixelBufferDescriptor)

Updates a rectangular sub-region of a 2D texture level.

fun setImage(engine: Engine, level: Int, xoffset: Int, yoffset: Int, zoffset: Int, width: Int, height: Int, depth: Int, descriptor: Texture.PixelBufferDescriptor)

Updates a sub-region of a 3D texture or 2D texture array. Cubemaps are treated like a 2D array of six layers.

setImageAsync

fun setImageAsync(engine: Engine, level: Int, descriptor: Texture.PixelBufferDescriptor, callback: (Texture, AsyncCallStatus) -> Unit? = null): Int

setImage, asynchronously: returns an ID for Engine.cancelAsyncCall, and callback runs once on the main thread with how it ended. Needs Engine.isAsynchronousModeEnabled.

fun setImageAsync(engine: Engine, level: Int, xoffset: Int, yoffset: Int, width: Int, height: Int, descriptor: Texture.PixelBufferDescriptor, callback: (Texture, AsyncCallStatus) -> Unit? = null): Int

fun setImageAsync(engine: Engine, level: Int, xoffset: Int, yoffset: Int, zoffset: Int, width: Int, height: Int, depth: Int, descriptor: Texture.PixelBufferDescriptor, callback: (Texture, AsyncCallStatus) -> Unit? = null): Int

setImage, asynchronously; see the level-only setImageAsync.