TgpuTexture

Defined in: packages/typegpu/src/core/texture/texture.ts:193

Extends

• TgpuNamable

Type Parameters

TProps

TProps extends TextureProps = any

Properties

[$internal]

readonly [$internal]: TextureInternals

Defined in: packages/typegpu/src/core/texture/texture.ts:194

---

[$soul]

readonly [$soul]: TgpuTextureSoul<TProps>

Defined in: packages/typegpu/src/core/texture/texture.ts:195

---

destroyed

readonly destroyed: boolean

Defined in: packages/typegpu/src/core/texture/texture.ts:198

---

props

readonly props: TProps

Defined in: packages/typegpu/src/core/texture/texture.ts:197

---

resourceType

readonly resourceType: "texture"

Defined in: packages/typegpu/src/core/texture/texture.ts:196

---

usableAsRender

readonly usableAsRender: boolean

Defined in: packages/typegpu/src/core/texture/texture.ts:203

---

usableAsSampled

readonly usableAsSampled: boolean

Defined in: packages/typegpu/src/core/texture/texture.ts:202

---

usableAsStorage

readonly usableAsStorage: boolean

Defined in: packages/typegpu/src/core/texture/texture.ts:201

Methods

$name()

$name(label): this

Defined in: packages/typegpu/src/shared/meta.ts:44

Parameters

label

string

Returns

this

Inherited from

TgpuNamable.$name

---

$overrideFlags()

$overrideFlags(flags): TgpuTexture<TProps> & StorageFlag & SampledFlag & RenderFlag

Defined in: packages/typegpu/src/core/texture/texture.ts:208

Parameters

flags

number

Returns

TgpuTexture<TProps> & StorageFlag & SampledFlag & RenderFlag

---

$usage()

$usage<T>(…usages): TgpuTexture<TProps> & UnionToIntersection<LiteralToExtensionMap[T[number]]>

Defined in: packages/typegpu/src/core/texture/texture.ts:205

Type Parameters

T

T extends AllowedUsages<TProps>[]

Parameters

usages

…T

Returns

TgpuTexture<TProps> & UnionToIntersection<LiteralToExtensionMap[T[number]]>

---

clear()

Call Signature

clear(mipLevel?): void

Defined in: packages/typegpu/src/core/texture/texture.ts:228

Clears the texture to zeros

Parameters

mipLevel?

number | "all"

Returns

void

Call Signature

clear(color, mipLevel?): void

Defined in: packages/typegpu/src/core/texture/texture.ts:230

Clears the texture to color. Requires the 'render' usage flag

Parameters

color

readonly [number, number, number, number]

mipLevel?

number | "all"

Returns

void

---

copyFrom()

Call Signature

copyFrom<T>(source): void

Defined in: packages/typegpu/src/core/texture/texture.ts:246

Copies the contents of a texture with a matching size and format

Type Parameters

T

T extends CopyCompatibleTexture<TProps>

Parameters

source

T

Returns

void

Call Signature

copyFrom<T>(source, options): void

Defined in: packages/typegpu/src/core/texture/texture.ts:248

Copies a region between textures of the same format

Type Parameters

T

T extends FormatCompatibleTexture<TProps>

Parameters

source

T

options

TextureCopyOptions

Returns

void

---

createView()

Call Signature

createView(…args): TgpuTextureView<TextureSchemaForDescriptor<{ dimension: Default<TProps["dimension"], "2d">; multisampled: Default<TProps["sampleCount"], 1> extends 1 ? false : true; sampleType: TProps["format"] extends GPUTextureFormat ? TextureFormats[any[any]]["channelType"] : F32 | I32 | U32; }>>

Defined in: packages/typegpu/src/core/texture/texture.ts:210

Parameters

args

…[SelfOrErrors<WgslTexture<WgslTextureProps>, ValidSampledUsage<TgpuTexture<TProps>, WgslTexture<WgslTextureProps>>>]

Returns

TgpuTextureView<TextureSchemaForDescriptor<{ dimension: Default<TProps["dimension"], "2d">; multisampled: Default<TProps["sampleCount"], 1> extends 1 ? false : true; sampleType: TProps["format"] extends GPUTextureFormat ? TextureFormats[any[any]]["channelType"] : F32 | I32 | U32; }>>

Call Signature

createView(schema, viewDescriptor?): TgpuTextureRenderView

Defined in: packages/typegpu/src/core/texture/texture.ts:215

Parameters

schema

"render"

viewDescriptor?

TgpuTextureViewDescriptor

Returns

TgpuTextureRenderView

Call Signature

createView<T>(schema, viewDescriptor?): TgpuTextureView<T>

Defined in: packages/typegpu/src/core/texture/texture.ts:216

Type Parameters

T

T extends WgslTexture<WgslTextureProps>

Parameters

schema

ValidateTextureViewSchema<TgpuTexture<TProps>, T>

viewDescriptor?

TgpuTextureViewDescriptor & object

Returns

TgpuTextureView<T>

Call Signature

createView<T>(schema, viewDescriptor?): TgpuTextureView<T>

Defined in: packages/typegpu/src/core/texture/texture.ts:222

Type Parameters

T

T extends WgslStorageTexture<WgslStorageTextureProps>

Parameters

schema

ValidateTextureViewSchema<TgpuTexture<TProps>, T>

viewDescriptor?

TgpuTextureViewDescriptor

Returns

TgpuTextureView<T>

---

destroy()

destroy(): void

Defined in: packages/typegpu/src/core/texture/texture.ts:250

Returns

void

---

generateMipmaps()

generateMipmaps(baseMipLevel?, mipLevels?): void

Defined in: packages/typegpu/src/core/texture/texture.ts:231

Parameters

baseMipLevel?

number

mipLevels?

number

Returns

void

---

write()

Call Signature

write(source, options?): void

Defined in: packages/typegpu/src/core/texture/texture.ts:233

Writes image sources to the texture, one per array layer. Requires the 'render' usage flag

Parameters

source

GPUCopyExternalImageSource | GPUCopyExternalImageSource[]

options?

TextureWriteOptions

Returns

void

Call Signature

write(source, options?): void

Defined in: packages/typegpu/src/core/texture/texture.ts:238

Writes raw texel data to the texture

Parameters

source

TypedArray | ArrayBuffer | DataView<ArrayBufferLike>

options?

number | TextureRawWriteOptions

Returns

void

---

writeAsync()

writeAsync(source, options?): Promise<void>

Defined in: packages/typegpu/src/core/texture/texture.ts:243

Decodes an image blob and writes it to the texture. Requires the 'render' usage flag

Parameters

source

Blob

options?

TextureBlobWriteOptions

Returns

Promise<void>