Class VertexBuffer

A vertex buffer is the mechanism via which the application specifies vertex data to the graphics hardware.

Index

Constructors

Methods

destroy getFormat getNumVertices getUsage lock setData unlock

Constructors

constructor

new VertexBuffer(
    graphicsDevice: GraphicsDevice,
    format: VertexFormat,
    numVertices: number,
    options?: { data?: ArrayBuffer; storage?: boolean; usage?: number },
    ...args: any,
): VertexBuffer
Create a new VertexBuffer instance.
Parameters
- graphicsDevice: GraphicsDevice
  The graphics device used to manage this vertex buffer.
- format: VertexFormat
  The vertex format of this vertex buffer.
- numVertices: number
  The number of vertices that this vertex buffer will hold.
- Optionaloptions: { data?: ArrayBuffer; storage?: boolean; usage?: number }
  Object for passing optional arguments.
  - Optionaldata?: ArrayBuffer
    Initial data.
  - Optionalstorage?: boolean
    Defines if the vertex buffer can be used as a storage buffer by a compute shader. Defaults to false. Only supported on WebGPU.
  - Optionalusage?: number
    The usage type of the vertex buffer (see BUFFER_*). Defaults to BUFFER_STATIC.
- ...args: any
Returns VertexBuffer
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:31

Methods

destroy

destroy(): void
Frees resources associated with this vertex buffer.

Returns void
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:72

getFormat

getFormat(): VertexFormat
Returns the data format of the specified vertex buffer.

Returns VertexFormat
The data format of the specified vertex buffer.
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:107

getNumVertices

getNumVertices(): number
Returns the number of vertices stored in the specified vertex buffer.

Returns number
The number of vertices stored in the vertex buffer.
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:128

getUsage

getUsage(): number
Returns the usage type of the specified vertex buffer. This indicates whether the buffer can be modified once and used many times BUFFER_STATIC, modified repeatedly and used many times BUFFER_DYNAMIC or modified once and used at most a few times BUFFER_STREAM.

Returns number
The usage type of the vertex buffer (see BUFFER_*).
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:119

lock

lock(): ArrayBuffer
Returns a mapped memory block representing the content of the vertex buffer.

Returns ArrayBuffer
An array containing the byte data stored in the vertex buffer.
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:137

setData

setData(data?: ArrayBuffer): boolean
Copies data into vertex buffer's memory.
Parameters
- Optionaldata: ArrayBuffer
  Source data to copy.
Returns boolean
True if function finished successfully, false otherwise.
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:157

unlock

unlock(): void
Notifies the graphics engine that the client side copy of the vertex buffer's memory can be returned to the control of the graphics driver.

Returns void
- Defined in submodules/engine/src/platform/graphics/vertex-buffer.js:145