TgpuTexture
Defined in: packages/typegpu/src/core/texture/texture.ts:192
Extends
Section titled “Extends”TgpuNamable
Type Parameters
Section titled “Type Parameters”TProps
Section titled “TProps”TProps extends TextureProps = any
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:TextureInternals
Defined in: packages/typegpu/src/core/texture/texture.ts:193
[$soul]
Section titled “[$soul]”
readonly[$soul]:TgpuTextureSoul<TProps>
Defined in: packages/typegpu/src/core/texture/texture.ts:194
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:197
readonlyprops:TProps
Defined in: packages/typegpu/src/core/texture/texture.ts:196
resourceType
Section titled “resourceType”
readonlyresourceType:"texture"
Defined in: packages/typegpu/src/core/texture/texture.ts:195
usableAsRender
Section titled “usableAsRender”
readonlyusableAsRender:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:202
usableAsSampled
Section titled “usableAsSampled”
readonlyusableAsSampled:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:201
usableAsStorage
Section titled “usableAsStorage”
readonlyusableAsStorage:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:200
Methods
Section titled “Methods”$name()
Section titled “$name()”$name(
label):this
Defined in: packages/typegpu/src/shared/meta.ts:44
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
$overrideFlags()
Section titled “$overrideFlags()”$overrideFlags(
flags):TgpuTexture<TProps> &StorageFlag&SampledFlag&RenderFlag
Defined in: packages/typegpu/src/core/texture/texture.ts:207
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”TgpuTexture<TProps> & StorageFlag & SampledFlag & RenderFlag
$usage()
Section titled “$usage()”$usage<
T>(…usages):TgpuTexture<TProps> &UnionToIntersection<LiteralToExtensionMap[T[number]]>
Defined in: packages/typegpu/src/core/texture/texture.ts:204
Type Parameters
Section titled “Type Parameters”T extends AllowedUsages<TProps>[]
Parameters
Section titled “Parameters”usages
Section titled “usages”…T
Returns
Section titled “Returns”TgpuTexture<TProps> & UnionToIntersection<LiteralToExtensionMap[T[number]]>
clear()
Section titled “clear()”Call Signature
Section titled “Call Signature”clear(
mipLevel?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:227
Clears the texture to zeros
Parameters
Section titled “Parameters”mipLevel?
Section titled “mipLevel?”number | "all"
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”clear(
color,mipLevel?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:229
Clears the texture to color. Requires the 'render' usage flag
Parameters
Section titled “Parameters”readonly [number, number, number, number]
mipLevel?
Section titled “mipLevel?”number | "all"
Returns
Section titled “Returns”void
copyFrom()
Section titled “copyFrom()”Call Signature
Section titled “Call Signature”copyFrom<
T>(source):void
Defined in: packages/typegpu/src/core/texture/texture.ts:245
Copies the contents of a texture with a matching size and format
Type Parameters
Section titled “Type Parameters”T extends CopyCompatibleTexture<TProps>
Parameters
Section titled “Parameters”source
Section titled “source”T
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”copyFrom<
T>(source,options):void
Defined in: packages/typegpu/src/core/texture/texture.ts:247
Copies a region between textures of the same format
Type Parameters
Section titled “Type Parameters”T extends FormatCompatibleTexture<TProps>
Parameters
Section titled “Parameters”source
Section titled “source”T
options
Section titled “options”Returns
Section titled “Returns”void
createView()
Section titled “createView()”Call Signature
Section titled “Call Signature”createView(…
args):TgpuTextureView<TextureSchemaForDescriptor<{dimension:Default<TProps["dimension"],"2d">;multisampled:Default<TProps["sampleCount"],1> extends1?false:true;sampleType:TProps["format"] extendsGPUTextureFormat?TextureFormats[any[any]]["channelType"] :F32|I32|U32; }>>
Defined in: packages/typegpu/src/core/texture/texture.ts:209
Parameters
Section titled “Parameters”…[SelfOrErrors<WgslTexture<WgslTextureProps>, ValidSampledUsage<TgpuTexture<TProps>, WgslTexture<WgslTextureProps>>>]
Returns
Section titled “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
Section titled “Call Signature”createView(
schema,viewDescriptor?):TgpuTextureRenderView
Defined in: packages/typegpu/src/core/texture/texture.ts:214
Parameters
Section titled “Parameters”schema
Section titled “schema”"render"
viewDescriptor?
Section titled “viewDescriptor?”TgpuTextureViewDescriptor
Returns
Section titled “Returns”TgpuTextureRenderView
Call Signature
Section titled “Call Signature”createView<
T>(schema,viewDescriptor?):TgpuTextureView<T>
Defined in: packages/typegpu/src/core/texture/texture.ts:215
Type Parameters
Section titled “Type Parameters”T extends WgslTexture<WgslTextureProps>
Parameters
Section titled “Parameters”schema
Section titled “schema”ValidateTextureViewSchema<TgpuTexture<TProps>, T>
viewDescriptor?
Section titled “viewDescriptor?”TgpuTextureViewDescriptor & object
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”createView<
T>(schema,viewDescriptor?):TgpuTextureView<T>
Defined in: packages/typegpu/src/core/texture/texture.ts:221
Type Parameters
Section titled “Type Parameters”T extends WgslStorageTexture<WgslStorageTextureProps>
Parameters
Section titled “Parameters”schema
Section titled “schema”ValidateTextureViewSchema<TgpuTexture<TProps>, T>
viewDescriptor?
Section titled “viewDescriptor?”TgpuTextureViewDescriptor
Returns
Section titled “Returns”destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/typegpu/src/core/texture/texture.ts:249
Returns
Section titled “Returns”void
generateMipmaps()
Section titled “generateMipmaps()”generateMipmaps(
baseMipLevel?,mipLevels?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:230
Parameters
Section titled “Parameters”baseMipLevel?
Section titled “baseMipLevel?”number
mipLevels?
Section titled “mipLevels?”number
Returns
Section titled “Returns”void
write()
Section titled “write()”Call Signature
Section titled “Call Signature”write(
source,options?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:232
Writes image sources to the texture, one per array layer. Requires the 'render' usage flag
Parameters
Section titled “Parameters”source
Section titled “source”GPUCopyExternalImageSource | GPUCopyExternalImageSource[]
options?
Section titled “options?”Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”write(
source,options?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:237
Writes raw texel data to the texture
Parameters
Section titled “Parameters”source
Section titled “source”TypedArray | ArrayBuffer | DataView<ArrayBufferLike>
options?
Section titled “options?”number | TextureRawWriteOptions
Returns
Section titled “Returns”void
writeAsync()
Section titled “writeAsync()”writeAsync(
source,options?):Promise<void>
Defined in: packages/typegpu/src/core/texture/texture.ts:242
Decodes an image blob and writes it to the texture. Requires the 'render' usage flag
Parameters
Section titled “Parameters”source
Section titled “source”Blob
options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
© Software Mansion 2026. All trademarks and copyrights belong to their respective owners. Read about our Privacy Policy.