Class Buffer<T>`Abstract`

An array of binary data.

See

Type Parameters

T extends ArrayBufferView

Hierarchy (View Summary)

ContextDependent
- Buffer
  - ElementBuffer
  - VertexBuffer

Index

Properties

Accessors

data isHalf size type usage

Methods

Properties

`Readonly`context

context: Context

The rendering context.

Accessors

data

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

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

isHalf

get isHalf(): boolean
Whether or not this buffer contains 16-bit floating-point data if it contains floating-point data.

Returns boolean
- Defined in src/core/buffers/Buffer.ts:143

size

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

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

type

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

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

usage

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

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

Methods

delete

delete(): void
Delete this buffer.

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

setData

setData(
    data: T,
    usage?: BufferUsage,
    offset?: number,
    length?: number,
    isHalf?: boolean,
): void
Replace the data in this buffer.
Parameters
- data: T
  The data to store in this buffer or the size to set this buffer's data store to in bytes.
- Optionalusage: BufferUsage
  The intended usage of the buffer.
- Optionaloffset: number
  The index of the element to start reading the supplied data at.
- Optionallength: number
  The length of the supplied data to read.
- OptionalisHalf: boolean
  Whether or not the data contains 16-bit floating-point data if it contains floating-point data.
Returns void
See
- bufferData
- bufferSubData
- Defined in src/core/buffers/Buffer.ts:157
setData(
    data: number,
    usage?: BufferUsage,
    _?: unknown,
    __?: unknown,
    isHalf?: boolean,
): void
Set the size of this buffer, clearing its data.
Parameters
- data: number
  The data to store in this buffer or the size to set this buffer's data store to in bytes.
- Optionalusage: BufferUsage
  The intended usage of the buffer.
- Optional_: unknown
  An unused value.
- Optional__: unknown
  An unused value.
- OptionalisHalf: boolean
  Whether or not the data contains 16-bit floating-point data if it contains floating-point data.
Returns void
See
- bufferData
- bufferSubData
- Defined in src/core/buffers/Buffer.ts:175
setData(
    data: T,
    _?: unknown,
    offset?: number,
    length?: number,
    __?: unknown,
    replaceOffset?: number,
): void
Update a subset of the data in this buffer.
Parameters
- data: T
  The data to store in this buffer.
- Optional_: unknown
  An ignored value.
- Optionaloffset: number
  The index of the element to start reading the supplied data at.
- Optionallength: number
  The length of the supplied data to read.
- Optional__: unknown
  An ignored value.
- OptionalreplaceOffset: number
  The offset in bytes to start replacing data at.
Returns void
See
- bufferData
- bufferSubData
- Defined in src/core/buffers/Buffer.ts:194