Skip to content

@tmrw-realityos/charm


@tmrw-realityos/charm / WebGPUTexture

Class: WebGPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:13

Texture class

Extends

  • Texture

Constructors

Constructor

new WebGPUTexture(device): WebGPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:27

Parameters

device

GPUDevice

Returns

WebGPUTexture

Overrides

Texture.constructor

Properties

arrayLayers_

protected arrayLayers_: number = 1

Defined in: packages/charm/src/graphics/texture.ts:11

Inherited from

Texture.arrayLayers_


height_

protected height_: number = 1

Defined in: packages/charm/src/graphics/texture.ts:10

Inherited from

Texture.height_


index

index: number

Defined in: packages/charm/src/graphics/texture.ts:6

Inherited from

Texture.index


loading

loading: boolean = false

Defined in: packages/charm/src/graphics/texture.ts:7

Inherited from

Texture.loading


mipLevelCount_

protected mipLevelCount_: number = 1

Defined in: packages/charm/src/graphics/texture.ts:12

Inherited from

Texture.mipLevelCount_


name

name: string = ""

Defined in: packages/charm/src/graphics/texture.ts:5

Inherited from

Texture.name


width_

protected width_: number = 1

Defined in: packages/charm/src/graphics/texture.ts:9

Inherited from

Texture.width_


lastIndex

static lastIndex: number = -1

Defined in: packages/charm/src/graphics/texture.ts:3

Inherited from

Texture.lastIndex

Methods

assignDefaultView()

assignDefaultView(type): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:441

Parameters

type

eTextureViewTypes

Assign the default view to use with this texture when view is omited

Returns

void


clearViewsCache()

clearViewsCache(): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:452

Returns

void


convertToHalf()

convertToHalf(): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:319

Convert a texture to rgba16float format.

Returns

GPUTexture

Copy of inputTexture in float16 format


create()

create(): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:62

Create the GPU resource

Returns

GPUTexture


createCubemapFromData()

createCubemapFromData(data, width, height, format, usage): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:247

Parameters

data

TypedArray[][]

width

number = 1

height

number = 1

format

GPUTextureFormat = "rgba16float"

usage

undefined | number

Returns

GPUTexture


createFromData()

createFromData(data, width, height, format): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:207

Create texture from data

Parameters

data

ArrayBuffer

Source data

width

number = 1

Texture width

height

number = 1

Texture height

format

GPUTextureFormat = "rgba8unorm"

Texture format

Returns

GPUTexture


createFromDescriptor()

createFromDescriptor(descriptor): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:75

Parameters

descriptor

GPUTextureDescriptor

Returns

GPUTexture


createFromImage()

createFromImage(image): GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:136

Create texture from image

Parameters

image

Source image

HTMLImageElement | HTMLCanvasElement | ImageBitmap | HTMLVideoElement | VideoFrame

Returns

GPUTexture


destroy()

destroy(): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:517

Destroy GPU resource

Returns

void


generateMipmap()

generateMipmap(): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:122

Returns

void


getDescriptor()

getDescriptor(): GPUTextureDescriptor

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:42

Returns

GPUTextureDescriptor

Texture descriptor for the current settings


getHandle()

getHandle(): undefined | GPUTexture

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:433

Get GPU handle

Returns

undefined | GPUTexture

WebGPU handle


getView()

getView(): undefined | GPUTextureView

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:510

Get GPU texture view

Returns

undefined | GPUTextureView

WebGPU view


getViewCube()

getViewCube(): undefined | GPUTextureView

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:497

Get GPU cube texture view

Returns

undefined | GPUTextureView

WebGPU view


getViewGamma()

getViewGamma(): undefined | GPUTextureView

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:471

Get GPU texture view in gamma space

Returns

undefined | GPUTextureView

WebGPU view


getViewLinear()

getViewLinear(): undefined | GPUTextureView

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:463

Get GPU texture view

Returns

undefined | GPUTextureView

WebGPU view


resize()

resize(width, height): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:113

Parameters

width

number

height

number

Returns

void


updateFromData()

updateFromData(data): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:235

Parameters

data

ArrayBuffer

Returns

void


updateFromExternalVideo()

updateFromExternalVideo(frame): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:190

Parameters

frame

VideoFrame

Returns

void


updateFromImage()

updateFromImage(image): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:171

Parameters

image

HTMLImageElement | HTMLCanvasElement | ImageBitmap | HTMLVideoElement | VideoFrame

Returns

void