TgpuBuffer
Defined in: packages/typegpu/src/core/buffer/buffer.ts:135
Extends
Section titled “Extends”TgpuNamable
Type Parameters
Section titled “Type Parameters”TData extends BaseData
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:object
Defined in: packages/typegpu/src/core/buffer/buffer.ts:136
materialize()
Section titled “materialize()”
readonlymaterialize: () =>GPUBuffer
Returns
Section titled “Returns”GPUBuffer
readonlyroot:ExperimentalTgpuRoot
[$soul]
Section titled “[$soul]”
readonly[$soul]:TgpuBufferSoul<TData>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:140
arrayBuffer
Section titled “arrayBuffer”
readonlyarrayBuffer:ArrayBuffer
Defined in: packages/typegpu/src/core/buffer/buffer.ts:144
buffer
Section titled “buffer”
readonlybuffer:GPUBuffer
Defined in: packages/typegpu/src/core/buffer/buffer.ts:146
dataType
Section titled “dataType”
readonlydataType:TData
Defined in: packages/typegpu/src/core/buffer/buffer.ts:142
destroyed
Section titled “destroyed”
readonlydestroyed:boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:147
initial?
Section titled “initial?”
readonlyoptionalinitial:InferInput<TData>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:143
resourceType
Section titled “resourceType”
readonlyresourceType:"buffer"
Defined in: packages/typegpu/src/core/buffer/buffer.ts:141
usableAsIndex
Section titled “usableAsIndex”usableAsIndex:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:152
usableAsIndirect
Section titled “usableAsIndirect”usableAsIndirect:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:153
usableAsStorage
Section titled “usableAsStorage”usableAsStorage:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:150
usableAsUniform
Section titled “usableAsUniform”usableAsUniform:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:149
usableAsVertex
Section titled “usableAsVertex”usableAsVertex:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:151
Methods
Section titled “Methods”$addFlags()
Section titled “$addFlags()”$addFlags(
flags):this
Defined in: packages/typegpu/src/core/buffer/buffer.ts:163
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
$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
$usage()
Section titled “$usage()”$usage<
T>(…usages):TgpuBuffer<TData> &UnionToIntersection<LiteralToUsageType<T[number]>>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:155
Type Parameters
Section titled “Type Parameters”T extends ["indirect" | IsValidStorageSchema<TData> extends true ? "storage" : never | IsValidUniformSchema<TData> extends true ? "uniform" : never | IsValidVertexSchema<TData> extends true ? "vertex" : never | IsValidIndexSchema<TData> extends true ? "index" : never, …(“indirect” | (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]>>
as<
T>(usage):UsageTypeToBufferBinding<TData>[T]
Defined in: packages/typegpu/src/core/buffer/buffer.ts:165
Type Parameters
Section titled “Type Parameters”T extends never
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”UsageTypeToBufferBinding<TData>[T]
clear()
Section titled “clear()”clear(
encoder?):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:173
Parameters
Section titled “Parameters”encoder?
Section titled “encoder?”Returns
Section titled “Returns”void
compileWriter()
Section titled “compileWriter()”compileWriter():
void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:167
Returns
Section titled “Returns”void
copyFrom()
Section titled “copyFrom()”copyFrom(
srcBuffer,encoder?):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:174
Parameters
Section titled “Parameters”srcBuffer
Section titled “srcBuffer”TgpuBuffer<MemIdentity<TData>>
encoder?
Section titled “encoder?”Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:176
Returns
Section titled “Returns”void
patch()
Section titled “patch()”patch(
data):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:172
Parameters
Section titled “Parameters”InferPatch<TData>
Returns
Section titled “Returns”void
read()
Section titled “read()”read():
Promise<Infer<TData>>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:175
Returns
Section titled “Returns”Promise<Infer<TData>>
toString()
Section titled “toString()”toString():
string
Defined in: packages/typegpu/src/core/buffer/buffer.ts:177
Returns a string representation of an object.
Returns
Section titled “Returns”string
write()
Section titled “write()”Call Signature
Section titled “Call Signature”write(
data,options?):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:168
Parameters
Section titled “Parameters”InferInput<TData>
options?
Section titled “options?”Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”write(
data,options?):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:169
Parameters
Section titled “Parameters”ArrayBuffer
options?
Section titled “options?”Returns
Section titled “Returns”void
writePartial()
Section titled “writePartial()”writePartial(
data):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:171
Parameters
Section titled “Parameters”InferPartial<TData>
Returns
Section titled “Returns”void
© Software Mansion 2026. All trademarks and copyrights belong to their respective owners. Read about our Privacy Policy.