TgpuBuffer
Extends
Section titled “Extends”TgpuNamable
Type Parameters
Section titled “Type Parameters”• TData extends BaseData
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:true
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:102
buffer
Section titled “buffer”
readonlybuffer:GPUBuffer
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:107
dataType
Section titled “dataType”
readonlydataType:TData
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:104
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:108
initial?
Section titled “initial?”
readonlyoptionalinitial:Infer<TData>
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:105
resourceType
Section titled “resourceType”
readonlyresourceType:"buffer"
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:103
usableAsIndex
Section titled “usableAsIndex”usableAsIndex:
boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:113
usableAsStorage
Section titled “usableAsStorage”usableAsStorage:
boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:111
usableAsUniform
Section titled “usableAsUniform”usableAsUniform:
boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:110
usableAsVertex
Section titled “usableAsVertex”usableAsVertex:
boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:112
Methods
Section titled “Methods”$addFlags()
Section titled “$addFlags()”$addFlags(
flags):this
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:123
$name()
Section titled “$name()”$name(
label):this
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
Defined in
Section titled “Defined in”packages/typegpu/src/shared/meta.ts:87
$usage()
Section titled “$usage()”$usage<
T>(…usages):TgpuBuffer<TData> &UnionToIntersection<LiteralToUsageType<T[number]>>
Type Parameters
Section titled “Type Parameters”• T extends [IsValidStorageSchema<TData> extends true ? "storage" : never | IsValidUniformSchema<TData> extends true ? "uniform" : never | IsValidVertexSchema<TData> extends true ? "vertex" : never | IsValidIndexSchema<TData> extends true ? "index" : never, …((IsValidStorageSchema<TData> extends true ? “storage” : never) | (IsValidUniformSchema<TData> extends true ? “uniform” : never) | (IsValidVertexSchema<TData> extends true ? “vertex” : never) | (IsValidIndexSchema<TData> extends true ? “index” : never))[]]
Parameters
Section titled “Parameters”usages
Section titled “usages”…T
Returns
Section titled “Returns”TgpuBuffer<TData> & UnionToIntersection<LiteralToUsageType<T[number]>>
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:115
as<
T>(usage):UsageTypeToBufferUsage<TData>[T]
Type Parameters
Section titled “Type Parameters”• T extends never
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”UsageTypeToBufferUsage<TData>[T]
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:125
clear()
Section titled “clear()”clear():
void
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:130
compileWriter()
Section titled “compileWriter()”compileWriter():
void
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:127
copyFrom()
Section titled “copyFrom()”copyFrom(
srcBuffer):void
Parameters
Section titled “Parameters”srcBuffer
Section titled “srcBuffer”TgpuBuffer<MemIdentity<TData>>
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:131
destroy()
Section titled “destroy()”destroy():
void
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:133
read()
Section titled “read()”read():
Promise<Infer<TData>>
Returns
Section titled “Returns”Promise<Infer<TData>>
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:132
write()
Section titled “write()”write(
data):void
Parameters
Section titled “Parameters”Infer<TData>
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/buffer/buffer.ts:128
writePartial()
Section titled “writePartial()”writePartial(
data):void
Parameters
Section titled “Parameters”InferPartial<TData>
Returns
Section titled “Returns”void