Skip to main content

Class: BufferTransform

Defined in: modules/engine/src/compute/buffer-transform.ts:47

Manages a WebGL program (pipeline) for buffer→buffer transforms.

Note​

Only works under WebGL2.

Constructors​

Constructor​

new BufferTransform(device, props?): BufferTransform

Defined in: modules/engine/src/compute/buffer-transform.ts:67

Parameters​

device​

Device

props?​

BufferTransformProps = BufferTransform.defaultProps

Returns​

BufferTransform

Properties​

device​

readonly device: Device

Defined in: modules/engine/src/compute/buffer-transform.ts:48

model​

readonly model: GPUVectorModel

Defined in: modules/engine/src/compute/buffer-transform.ts:49

transformFeedback​

readonly transformFeedback: TransformFeedback

Defined in: modules/engine/src/compute/buffer-transform.ts:50

defaultProps​

static defaultProps: Required<BufferTransformProps>

Defined in: modules/engine/src/compute/buffer-transform.ts:54

Methods​

delete()​

delete(): void

Defined in: modules/engine/src/compute/buffer-transform.ts:106

Returns​

void

Deprecated​

Use destroy.

destroy()​

destroy(): void

Defined in: modules/engine/src/compute/buffer-transform.ts:99

Destroy owned resources.

Returns​

void

getBuffer()​

getBuffer(varyingName): Buffer | BufferRange | null

Defined in: modules/engine/src/compute/buffer-transform.ts:165

Parameters​

varyingName​

string

Returns​

Buffer | BufferRange | null

Deprecated​

App knows what buffers it is passing in - Returns the Buffer or BufferRange for given varying name.

readAsync()​

readAsync(varyingName): Promise<Uint8Array<ArrayBufferLike>>

Defined in: modules/engine/src/compute/buffer-transform.ts:170

Parameters​

varyingName​

string

Returns​

Promise<Uint8Array<ArrayBufferLike>>

Deprecated​

App knows what buffers it is passing in - Reads the Buffer or BufferRange for given varying name.

run()​

run(options?): void

Defined in: modules/engine/src/compute/buffer-transform.ts:111

Run one transform loop.

Parameters​

options?​

ResourceProps & object & object

Returns​

void

setOutputVectors()​

setOutputVectors(vectors): void

Defined in: modules/engine/src/compute/buffer-transform.ts:136

Binds borrowed output ranges without taking ownership or repacking vector chunks.

Parameters​

vectors​

GPUVectorModelInputs

Returns​

void

isSupported()​

static isSupported(device): boolean

Defined in: modules/engine/src/compute/buffer-transform.ts:63

Parameters​

device​

Device

Returns​

boolean