TgpuBuffer
Defined in: packages/typegpu/src/core/buffer/buffer.ts:101
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: packages/typegpu/src/core/buffer/buffer.ts:102
buffer
Section titled “buffer”
readonly
buffer:GPUBuffer
Defined in: packages/typegpu/src/core/buffer/buffer.ts:107
dataType
Section titled “dataType”
readonly
dataType:TData
Defined in: packages/typegpu/src/core/buffer/buffer.ts:104
destroyed
Section titled “destroyed”
readonly
destroyed:boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:108
initial?
Section titled “initial?”
readonly
optional
initial:Infer
<TData
>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:105
resourceType
Section titled “resourceType”
readonly
resourceType:"buffer"
Defined in: packages/typegpu/src/core/buffer/buffer.ts:103
usableAsIndex
Section titled “usableAsIndex”usableAsIndex:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:113
usableAsStorage
Section titled “usableAsStorage”usableAsStorage:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:111
usableAsUniform
Section titled “usableAsUniform”usableAsUniform:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:110
usableAsVertex
Section titled “usableAsVertex”usableAsVertex:
boolean
Defined in: packages/typegpu/src/core/buffer/buffer.ts:112
Methods
Section titled “Methods”$addFlags()
Section titled “$addFlags()”$addFlags(
flags
):this
Defined in: packages/typegpu/src/core/buffer/buffer.ts:123
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:83
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:115
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
]>>
as<
T
>(usage
):UsageTypeToBufferUsage
<TData
>[T
]
Defined in: packages/typegpu/src/core/buffer/buffer.ts:125
Type Parameters
Section titled “Type Parameters”• T extends never
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”UsageTypeToBufferUsage
<TData
>[T
]
compileWriter()
Section titled “compileWriter()”compileWriter():
void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:127
Returns
Section titled “Returns”void
copyFrom()
Section titled “copyFrom()”copyFrom(
srcBuffer
):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:130
Parameters
Section titled “Parameters”srcBuffer
Section titled “srcBuffer”TgpuBuffer
<MemIdentity
<TData
>>
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:132
Returns
Section titled “Returns”void
read()
Section titled “read()”read():
Promise
<Infer
<TData
>>
Defined in: packages/typegpu/src/core/buffer/buffer.ts:131
Returns
Section titled “Returns”Promise
<Infer
<TData
>>
write()
Section titled “write()”write(
data
):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:128
Parameters
Section titled “Parameters”Infer
<TData
>
Returns
Section titled “Returns”void
writePartial()
Section titled “writePartial()”writePartial(
data
):void
Defined in: packages/typegpu/src/core/buffer/buffer.ts:129
Parameters
Section titled “Parameters”InferPartial
<TData
>
Returns
Section titled “Returns”void