TgpuTexture
Defined in: packages/typegpu/src/core/texture/texture.ts:131
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:132
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:135
readonlyprops:TProps
Defined in: packages/typegpu/src/core/texture/texture.ts:134
resourceType
Section titled “resourceType”
readonlyresourceType:"texture"
Defined in: packages/typegpu/src/core/texture/texture.ts:133
usableAsRender
Section titled “usableAsRender”
readonlyusableAsRender:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:140
usableAsSampled
Section titled “usableAsSampled”
readonlyusableAsSampled:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:139
usableAsStorage
Section titled “usableAsStorage”
readonlyusableAsStorage:boolean
Defined in: packages/typegpu/src/core/texture/texture.ts:138
Methods
Section titled “Methods”$name()
Section titled “$name()”$name(
label):this
Defined in: packages/typegpu/src/shared/meta.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
$usage()
Section titled “$usage()”$usage<
T>(…usages):TgpuTexture<TProps> &UnionToIntersection<LiteralToExtensionMap[T[number]]>
Defined in: packages/typegpu/src/core/texture/texture.ts:142
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()”clear(
mipLevel?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:163
Parameters
Section titled “Parameters”mipLevel?
Section titled “mipLevel?”number | "all"
Returns
Section titled “Returns”void
copyFrom()
Section titled “copyFrom()”copyFrom<
T>(source):void
Defined in: packages/typegpu/src/core/texture/texture.ts:168
Type Parameters
Section titled “Type Parameters”T extends CopyCompatibleTexture<TProps>
Parameters
Section titled “Parameters”source
Section titled “source”T
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"] :U32|F32|I32; }>>
Defined in: packages/typegpu/src/core/texture/texture.ts:146
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"] : U32 | F32 | I32; }>>
Call Signature
Section titled “Call Signature”createView(
schema,viewDescriptor?):TgpuTextureRenderView
Defined in: packages/typegpu/src/core/texture/texture.ts:151
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:152
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:158
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:170
Returns
Section titled “Returns”void
generateMipmaps()
Section titled “generateMipmaps()”generateMipmaps(
baseMipLevel?,mipLevels?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:164
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):void
Defined in: packages/typegpu/src/core/texture/texture.ts:165
Parameters
Section titled “Parameters”source
Section titled “source”ExternalImageSource | ExternalImageSource[]
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”write(
source,mipLevel?):void
Defined in: packages/typegpu/src/core/texture/texture.ts:166
Parameters
Section titled “Parameters”source
Section titled “source”TypedArray | ArrayBuffer | DataView<ArrayBufferLike>
mipLevel?
Section titled “mipLevel?”number
Returns
Section titled “Returns”void