Skip to content

TgpuBuffer

Defined in: packages/typegpu/src/core/buffer/buffer.ts:101

  • TgpuNamable

TData extends BaseData

readonly [$internal]: true

Defined in: packages/typegpu/src/core/buffer/buffer.ts:102


readonly buffer: GPUBuffer

Defined in: packages/typegpu/src/core/buffer/buffer.ts:107


readonly dataType: TData

Defined in: packages/typegpu/src/core/buffer/buffer.ts:104


readonly destroyed: boolean

Defined in: packages/typegpu/src/core/buffer/buffer.ts:108


readonly optional initial: Infer<TData>

Defined in: packages/typegpu/src/core/buffer/buffer.ts:105


readonly resourceType: "buffer"

Defined in: packages/typegpu/src/core/buffer/buffer.ts:103


usableAsIndex: boolean

Defined in: packages/typegpu/src/core/buffer/buffer.ts:113


usableAsStorage: boolean

Defined in: packages/typegpu/src/core/buffer/buffer.ts:111


usableAsUniform: boolean

Defined in: packages/typegpu/src/core/buffer/buffer.ts:110


usableAsVertex: boolean

Defined in: packages/typegpu/src/core/buffer/buffer.ts:112

$addFlags(flags): this

Defined in: packages/typegpu/src/core/buffer/buffer.ts:123

number

this


$name(label): this

Defined in: packages/typegpu/src/shared/meta.ts:83

string

this

TgpuNamable.$name


$usage<T>(…usages): TgpuBuffer<TData> & UnionToIntersection<LiteralToUsageType<T[number]>>

Defined in: packages/typegpu/src/core/buffer/buffer.ts:115

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))[]]

T

TgpuBuffer<TData> & UnionToIntersection<LiteralToUsageType<T[number]>>


as<T>(usage): UsageTypeToBufferUsage<TData>[T]

Defined in: packages/typegpu/src/core/buffer/buffer.ts:125

T extends never

T

UsageTypeToBufferUsage<TData>[T]


compileWriter(): void

Defined in: packages/typegpu/src/core/buffer/buffer.ts:127

void


copyFrom(srcBuffer): void

Defined in: packages/typegpu/src/core/buffer/buffer.ts:130

TgpuBuffer<MemIdentity<TData>>

void


destroy(): void

Defined in: packages/typegpu/src/core/buffer/buffer.ts:132

void


read(): Promise<Infer<TData>>

Defined in: packages/typegpu/src/core/buffer/buffer.ts:131

Promise<Infer<TData>>


write(data): void

Defined in: packages/typegpu/src/core/buffer/buffer.ts:128

Infer<TData>

void


writePartial(data): void

Defined in: packages/typegpu/src/core/buffer/buffer.ts:129

InferPartial<TData>

void