Class VertexBuffer

An array of binary data to be used as a vertex buffer object. Must contain unsigned integers.

See

WebGLBuffer

Hierarchy (View Summary)

Buffer<ArrayBufferView>
- VertexBuffer

Index

Constructors

constructor

new VertexBuffer(
    context: Context,
    data: number | ArrayBufferView<ArrayBufferLike>,
    usage?: BufferUsage,
    offset?: undefined | number,
    length?: undefined | number,
    isHalf?: boolean,
): VertexBuffer
Create a buffer to be used as anything other than an element array buffer.
Parameters
- context: Context
  The rendering context.
- data: number | ArrayBufferView<ArrayBufferLike>
  The initial data contained in this buffer or the size of this buffer's data store in bytes.
- usage: BufferUsage = BufferUsage.STATIC_DRAW
  The intended usage of the buffer.
- offset: undefined | number = ...
  The index of the element to start reading the initial data at.
- length: undefined | number = ...
  The length of the initial data to read into the buffer.
- isHalf: boolean = false
  Whether or not the data contains half floats if it contains floats.
Returns VertexBuffer
Throws
UnsupportedOperationError if a buffer cannot be created.

See
createBuffer
Overrides Buffer<ArrayBufferView>.constructor
- Defined in src/core/buffers/VertexBuffer.ts:150

Properties

`Readonly`context

context: Context

The rendering context.

Accessors

data

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

Returns T
See
getBufferSubData
Inherited from Buffer.data
- Defined in src/core/buffers/Buffer.ts:105
set data(value: T): void
Parameters
- value: T
Returns void
Inherited from Buffer.data
- 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
Inherited from Buffer.isHalf
- Defined in src/core/buffers/Buffer.ts:143

size

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

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

type

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

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

usage

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

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

Methods

delete

delete(): void
Delete this buffer.

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

setData

setData(
    data: ArrayBufferView<ArrayBufferLike>,
    usage?: BufferUsage,
    offset?: number,
    length?: number,
    isHalf?: boolean,
): void
Replace the data in this buffer.
Parameters
- data: ArrayBufferView<ArrayBufferLike>
  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
Inherited from Buffer.setData
- 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
Inherited from Buffer.setData
- Defined in src/core/buffers/Buffer.ts:175
setData(
    data: ArrayBufferView<ArrayBufferLike>,
    _?: unknown,
    offset?: number,
    length?: number,
    __?: unknown,
    replaceOffset?: number,
): void
Update a subset of the data in this buffer.
Parameters
- data: ArrayBufferView<ArrayBufferLike>
  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
Inherited from Buffer.setData
- Defined in src/core/buffers/Buffer.ts:194

Class VertexBuffer

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VertexBuffer

Throws

See

Properties

Readonlycontext

Accessors

data

Returns T

See

Parameters

Returns void

isHalf

Returns boolean

size

Returns number

type

Returns DataType

usage

Returns BufferUsage

Methods

delete

Returns void

See

setData

Parameters

Returns void

See

Parameters

Returns void

See

Parameters

Returns void

See

Settings

On This Page

`Readonly`context