@tmrw-realityos/charm / Exports / WebGPUTexture

Class: WebGPUTexture

Texture class

Table of contents

Constructors

• constructor

Methods

• assignDefaultView
• convertToHalf
• create
• createCubemapFromData
• createFromData
• createFromDescriptor
• createFromImage
• destroy
• generateMipmap
• getDescriptor
• getHandle
• getView
• getViewCube
• getViewGamma
• getViewLinear
• resize

Constructors

constructor

• new WebGPUTexture(device): WebGPUTexture

Parameters

Name	Type
device	GPUDevice

Returns

WebGPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:30

Methods

assignDefaultView

▸ assignDefaultView(type): void

Parameters

Name	Type	Description
type	eTextureViewTypes	Assign the default view to use with this texture when view is omited

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:388

---

convertToHalf

▸ convertToHalf(): GPUTexture

Convert a texture to rgba16float format.

Returns

GPUTexture

Copy of inputTexture in float16 format

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:270

---

create

▸ create(): GPUTexture

Create the GPU resource

Returns

GPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:63

---

createCubemapFromData

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

Parameters

Name	Type	Default value
data	ArrayBuffer[][]	undefined
width	number	1
height	number	1
format	GPUTextureFormat	"rgba16float"
usage	undefined | number	undefined

Returns

GPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:198

---

createFromData

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

Create texture from data

Parameters

Name	Type	Default value	Description
data	ArrayBuffer	undefined	Source data
width	number	1	Texture width
height	number	1	Texture height
format	GPUTextureFormat	"rgba8unorm"	Texture format

Returns

GPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:162

---

createFromDescriptor

▸ createFromDescriptor(descriptor): GPUTexture

Parameters

Name	Type
descriptor	GPUTextureDescriptor

Returns

GPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:73

---

createFromImage

▸ createFromImage(image): GPUTexture

Create texture from image

Parameters

Name	Type	Description
image	ImageData | HTMLImageElement	Source image

Returns

GPUTexture

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:125

---

destroy

▸ destroy(): void

Destroy GPU resource

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:453

---

generateMipmap

▸ generateMipmap(): void

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:114

---

getDescriptor

▸ getDescriptor(): GPUTextureDescriptor

Returns

GPUTextureDescriptor

Texture descriptor for the current settings

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:43

---

getHandle

▸ getHandle(): undefined | GPUTexture

Get GPU handle

Returns

undefined | GPUTexture

WebGPU handle

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:380

---

getView

▸ getView(): undefined | GPUTextureView

Get GPU texture view

Returns

undefined | GPUTextureView

WebGPU view

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:446

---

getViewCube

▸ getViewCube(): undefined | GPUTextureView

Get GPU cube texture view

Returns

undefined | GPUTextureView

WebGPU view

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:435

---

getViewGamma

▸ getViewGamma(): undefined | GPUTextureView

Get GPU texture view in gamma space

Returns

undefined | GPUTextureView

WebGPU view

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:411

---

getViewLinear

▸ getViewLinear(): undefined | GPUTextureView

Get GPU texture view

Returns

undefined | GPUTextureView

WebGPU view

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:403

---

resize

▸ resize(width, height): void

Parameters

Name	Type
width	number
height	number

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUTexture.ts:105