Class VertexBuffer

An array of binary data to be used as a vertex buffer object.

See

WebGLBuffer

Hierarchy (View Summary)

Buffer
- VertexBuffer

Index

Constructors

constructor

new VertexBuffer(
    context: Context,
    data?: number | ArrayBufferView<ArrayBufferLike> | VertexBuffer,
    usage?: BufferUsage,
    offset?: number,
    length?: number,
): 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> | VertexBuffer = 0
  The initial data contained in this buffer or the size of this buffer's data store in bytes.
- Optionalusage: BufferUsage
  The intended usage of the buffer.
- Optionaloffset: number
  The index of the element to start reading the initial data at.
- Optionallength: number
  The length of the initial data to read into the buffer.
Returns VertexBuffer
Throws
UnsupportedOperationError if a buffer cannot be created.

See
createBuffer
Overrides Buffer.constructor
- Defined in src/core/buffers/VertexBuffer.ts:147

Properties

`Readonly`context

context: Context

The rendering context.

Accessors

data

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

Returns ArrayBufferView
See
getBufferSubData
Overrides Buffer.data
- Defined in src/core/buffers/VertexBuffer.ts:187
set data(value: ArrayBufferView): void
The data contained in this buffer.
Parameters
- value: ArrayBufferView
Returns void
See
getBufferSubData
Overrides Buffer.data
- Defined in src/core/buffers/VertexBuffer.ts:223

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:110

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:99

usage

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

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

Methods

delete

delete(): void
Delete this buffer.

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

getData

getData(): Promise<ArrayBufferView<ArrayBufferLike>>
Get the data contained in this buffer.

Returns Promise<ArrayBufferView<ArrayBufferLike>>
The data contained in this buffer.

See
getBufferSubData
- Defined in src/core/buffers/VertexBuffer.ts:232

setData

setData(
    data: number | ArrayBufferView<ArrayBufferLike> | VertexBuffer,
    usage?: BufferUsage,
    srcOffset?: number,
    length?: number,
    dstOffset?: number,
): void
Set the size of this buffer, clearing its data.
Parameters
- data: number | ArrayBufferView<ArrayBufferLike> | VertexBuffer
  The size to set this buffer's data store to in bytes.
- Optionalusage: BufferUsage
  The intended use case of the buffer.
- OptionalsrcOffset: number
- Optionallength: number
- OptionaldstOffset: number
Returns void
See
- bufferData
- bufferSubData
Overrides Buffer.setData
- Defined in src/core/buffers/VertexBuffer.ts:270

Class VertexBuffer

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VertexBuffer

Throws

See

Properties

Readonlycontext

Accessors

data

Returns ArrayBufferView

See

Parameters

Returns void

See

size

Returns number

type

Returns DataType

usage

Returns BufferUsage

Methods

delete

Returns void

See

getData

Returns Promise<ArrayBufferView<ArrayBufferLike>>

See

setData

Parameters

Returns void

See

Settings

On This Page

`Readonly`context