VertexBuffer
A vertex buffer is the mechanism via which the application specifies vertex data to the graphics hardware.
Summary
Methods
| destroy | Frees resources associated with this vertex buffer. |
| getFormat | Returns the data format of the specified vertex buffer. |
| getNumVertices | Returns the number of vertices stored in the specified vertex buffer. |
| getUsage | Returns the usage type of the specified vertex buffer. |
| lock | Returns a mapped memory block representing the content of the vertex buffer. |
| setData | Copies data into vertex buffer's memory. |
| unlock | 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. |
Details
Constructor
VertexBuffer(graphicsDevice, format, numVertices, [usage], [initialData])
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. |
| usage | number | The usage type of the vertex buffer (see BUFFER_*). Defaults to BUFFER_STATIC. |
| initialData | ArrayBuffer | Initial data. |
Methods
destroy()
Frees resources associated with this vertex buffer.
getFormat()
Returns the data format of the specified vertex buffer.
Returns
VertexFormatThe data format of the specified vertex buffer.
getNumVertices()
Returns the number of vertices stored in the specified vertex buffer.
Returns
numberThe number of vertices stored in the vertex buffer.
getUsage()
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
numberThe usage type of the vertex buffer (see BUFFER_*).
lock()
Returns a mapped memory block representing the content of the vertex buffer.
Returns
ArrayBufferAn array containing the byte data stored in the vertex buffer.
setData([data])
Copies data into vertex buffer's memory.
Parameters
| data | ArrayBuffer | Source data to copy. |
Returns
booleanTrue if function finished successfully, false otherwise.
unlock()
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.