Class Buffer

constructor

• new Buffer(parameters?: BufferParams): Buffer

  Buffer constructors

  Parameters

  • parameters: BufferParams = ...

    parameters used to create our Buffer

  Returns Buffer

type

uuid

index

options

GPUBuffer

consumers

size

• set size(value: number): void

  Allow to dynamically set the size of the GPUBuffer.

  Parameters

  • value: number

  Returns void

reset

• reset(): void

  Reset the GPUBuffer value to null.

  Returns void

createBuffer

• createBuffer(renderer: Renderer, options?: BufferParams): void

  Create a GPUBuffer based on the descriptor stored in the Buffer options.

  Parameters

  • renderer: Renderer

    renderer used to create the GPUBuffer.

  • options: BufferParams = {}

    optional way to update the Buffer options previously set before creating the GPUBuffer.

  Returns void

setBuffer

• setBuffer(GPUBuffer: GPUBuffer): void

  Set the GPUBuffer. This allows to use a Buffer with a GPUBuffer created separately.

  Parameters

  • GPUBuffer: GPUBuffer

    GPU buffer to use.

  Returns void

copy

• copy(buffer: Buffer, destroyPreviousBuffer?: boolean): void

  Copy an Buffer GPUBuffer and its options into this Buffer.

  Parameters

  • buffer: Buffer

    Buffer to use for the copy.

  • destroyPreviousBuffer: boolean = false

    whether to destroy the previous Buffer before the copy.

  Returns void

mapBufferAsync

• mapBufferAsync(): Promise<Float32Array<ArrayBuffer>>

  Map the GPUBuffer and put a copy of the data into a Float32Array.

  Returns Promise<Float32Array<ArrayBuffer>>

  • Float32Array holding the GPUBuffer data.

destroy

• destroy(): void

  Destroy the GPUBuffer and reset its value.

  Returns void