Class Buffer<T>`Abstract`

An array of binary data.

See

Type Parameters

T extends ArrayBufferView = ArrayBufferView

Hierarchy (View Summary)

ContextDependent
- Buffer
  - ElementBuffer
  - VertexBuffer

Index

Properties

Accessors

data size type usage

Methods

Properties

`Readonly`context

context: Context

The rendering context.

Accessors

`Abstract`data

get data(): T
The data contained in this buffer.

Returns T
See
getBufferSubData
- Defined in src/core/buffers/Buffer.ts:80
set data(value: T): void
Parameters
- value: T
Returns void
- Defined in src/core/buffers/Buffer.ts:82

size

get size(): number
The size of this buffer's data store in bytes.

Returns number
- Defined in src/core/buffers/Buffer.ts:110

type

get type(): DataType
The type of the data in this buffer.

Returns DataType
- Defined in src/core/buffers/Buffer.ts:99

usage

get usage(): BufferUsage
The intended usage of this buffer.

Returns BufferUsage
- Defined in src/core/buffers/Buffer.ts:52

Methods

delete

delete(): void
Delete this buffer.

Returns void
See
deleteBuffer
- Defined in src/core/buffers/Buffer.ts:153

`Abstract`setData

setData(data: number, usage?: BufferUsage): void
Set the size of this buffer, clearing its data.
Parameters
- data: number
  The size to set this buffer's data store to in bytes.
- Optionalusage: BufferUsage
  The intended use case of the buffer.
Returns void
See
- bufferData
- bufferSubData
- Defined in src/core/buffers/Buffer.ts:129
setData(
    data: T,
    usage?: BufferUsage,
    srcOffset?: number,
    length?: number,
    dstOffset?: number,
): void
Replace all of or update a subset of the data in this buffer.
Parameters
- data: T
  The data to store in this buffer.
- Optionalusage: BufferUsage
  The intended use case of the buffer.
- OptionalsrcOffset: number
  The index of the element to start reading the supplied data at.
- Optionallength: number
  The length of the supplied data to read.
- OptionaldstOffset: number
  The offset in bytes to start replacing data at. If this value is set, a subset of the data in the buffer is updated rather than replacing all of the data in the buffer and the usage pattern of the buffer is not updated.
Returns void
See
- bufferData
- bufferSubData
- Defined in src/core/buffers/Buffer.ts:141