GPUTexture

Kotlin |Java

class GPUTexture : AutoCloseable

A GPU texture object for image data storage.

Summary

Public functions
`open external Unit`	`close()`
`external GPUTextureView`	`@FastNative createView(descriptor: TextureViewDescriptor?)` Creates a view of the texture, specifying its usage and subresource range.
`external Unit`	`@FastNative destroy()` Immediately destroys the texture resource.
`open operator Boolean`	`equals(other: Any?)`
`external Int`	`@FastNative getDepthOrArrayLayers()` Gets the depth or number of array layers of the texture at mip level 0.
`external Int`	`@FastNative getDimension()` Gets the dimension of the texture (1D, 2D, or 3D).
`external Int`	`@FastNative getFormat()` Gets the texture format.
`external Int`	`@FastNative getHeight()` Gets the height of the texture at mip level 0.
`external Int`	`@FastNative getMipLevelCount()` Gets the number of mipmap levels in the texture.
`external Int`	`@FastNative getSampleCount()` Gets the number of samples per texel (for multisampled textures).
`external Int`	`@FastNative getUsage()` Gets the usage flags the texture was created with.
`external Int`	`@FastNative getWidth()` Gets the width of the texture at mip level 0.
`open Int`	`hashCode()`
`external Unit`	`@FastNative setLabel(label: String)` Sets a debug label for the texture.

Public properties
`Int`	`depthOrArrayLayers`
`Int`	`dimension`
`Int`	`format`
`Long`	`handle`
`Int`	`height`
`Int`	`mipLevelCount`
`Int`	`sampleCount`
`Int`	`usage`
`Int`	`width`

Extension functions
`suspend Bitmap`	`GPUTexture.createBitmap(device: GPUDevice)`

Public functions

close

Added in 1.0.0-alpha01

open external fun close(): Unit

createView

Added in 1.0.0-alpha01

@FastNative
external fun createView(descriptor: TextureViewDescriptor? = null): GPUTextureView

Creates a view of the texture, specifying its usage and subresource range.

Parameters
`descriptor: TextureViewDescriptor? = null`	A descriptor specifying creation options for the texture view.

Returns
`GPUTextureView`	The newly created texture view.

destroy

Added in 1.0.0-alpha01

@FastNative
external fun destroy(): Unit

Immediately destroys the texture resource.

equals

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

getDepthOrArrayLayers

Added in 1.0.0-alpha01

@FastNative
external fun getDepthOrArrayLayers(): Int

Gets the depth or number of array layers of the texture at mip level 0.

Returns
`Int`	The depth or array layer count.

getDimension

Added in 1.0.0-alpha01

@FastNative
external fun getDimension(): Int

Gets the dimension of the texture (1D, 2D, or 3D).

Returns
`Int`	The texture dimension.

getFormat

Added in 1.0.0-alpha01

@FastNative
external fun getFormat(): Int

Gets the texture format.

Returns
`Int`	The texture format.

getHeight

Added in 1.0.0-alpha01

@FastNative
external fun getHeight(): Int

Gets the height of the texture at mip level 0.

Returns
`Int`	The height in texels.

getMipLevelCount

Added in 1.0.0-alpha01

@FastNative
external fun getMipLevelCount(): Int

Gets the number of mipmap levels in the texture.

Returns
`Int`	The number of mip levels.

getSampleCount

Added in 1.0.0-alpha01

@FastNative
external fun getSampleCount(): Int

Gets the number of samples per texel (for multisampled textures).

Returns
`Int`	The sample count.

getUsage

Added in 1.0.0-alpha01

@FastNative
external fun getUsage(): Int

Gets the usage flags the texture was created with.

Returns
`Int`	The texture's usage flags.

getWidth

Added in 1.0.0-alpha01

@FastNative
external fun getWidth(): Int

Gets the width of the texture at mip level 0.

Returns
`Int`	The width in texels.

hashCode

open fun hashCode(): Int

setLabel

Added in 1.0.0-alpha01

@FastNative
external fun setLabel(label: String): Unit

Sets a debug label for the texture.

Parameters
`label: String`	The label to assign to the texture.

Public properties

depthOrArrayLayers

Added in 1.0.0-alpha01

val depthOrArrayLayers: Int

dimension

Added in 1.0.0-alpha01

val dimension: Int

format

Added in 1.0.0-alpha01

val format: Int

handle

Added in 1.0.0-alpha01

val handle: Long

height

Added in 1.0.0-alpha01

val height: Int

mipLevelCount

Added in 1.0.0-alpha01

val mipLevelCount: Int

sampleCount

Added in 1.0.0-alpha01

val sampleCount: Int

usage

Added in 1.0.0-alpha01

val usage: Int

width

Added in 1.0.0-alpha01

val width: Int

Extension functions

createBitmap

Artifact: androidx.webgpu:webgpu

View Source

suspend fun GPUTexture.createBitmap(device: GPUDevice): Bitmap