WebGLBufferWrapper
Wrapper for a WebGL buffer, containing all the information that was used
to create it. This can be a VertexBuffer or IndexBuffer.
A WebGLBuffer should never be exposed outside the WebGLRenderer, so the
WebGLRenderer can handle context loss and other events without other
systems having to be aware of it. Always use WebGLBufferWrapper instead.
Constructor
new WebGLBufferWrapper(renderer, dataBuffer, bufferType, bufferUsage)
Parameters
| name | type | optional | description |
|---|---|---|---|
| renderer | Phaser.Renderer.WebGL.WebGLRenderer | No | The WebGLRenderer instance that owns this wrapper. |
| dataBuffer | ArrayBuffer | No | An ArrayBuffer of data to store. The buffer will be permanently associated with this data. |
| bufferType | GLenum | No | The type of the buffer being created. |
| bufferUsage | GLenum | No | The usage of the buffer being created. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW. |
Scope: static
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L9
Since: 3.80.0
Public Members
bufferType
bufferType: GLenum
Description:
The type of the buffer.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L116
Since: 3.80.0
bufferUsage
bufferUsage: GLenum
Description:
The usage of the buffer. gl.DYNAMIC_DRAW, gl.STATIC_DRAW or gl.STREAM_DRAW.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L125
Since: 3.80.0
dataBuffer
dataBuffer: ArrayBuffer
Description:
The data associated with the buffer.
Note that this will be used to recreate the buffer if the WebGL context is lost.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L57
Since: 4.0.0
renderer
renderer: Phaser.Renderer.WebGL.WebGLRenderer
Description:
The WebGLRenderer instance that owns this wrapper.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L34
Since: 4.0.0
viewF32
viewF32: Float32Array, null
Description:
A Float32Array view of the dataBuffer.
This will be null if the byte length of the dataBuffer
is not divisible by Float32Array.BYTES_PER_ELEMENT (4).
Such a buffer is only suited for use with 16-bit indices.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L68
Since: 4.0.0
viewU16
viewU16: Uint16Array, null
Description:
A Uint16Array view of the dataBuffer.
This will be null if the byte length of the dataBuffer
is not divisible by Uint16Array.BYTES_PER_ELEMENT (2).
Such a buffer is only suited for use with byte data.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L90
Since: 4.0.0
viewU32
viewU32: Uint32Array, null
Description:
A Uint32Array view of the dataBuffer.
This will be null if the byte length of the dataBuffer
is not divisible by Uint32Array.BYTES_PER_ELEMENT (4).
Such a buffer is only suited for use with 16-bit indices.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L103
Since: 4.0.0
viewU8
viewU8: Uint8Array
Description:
A Uint8Array view of the dataBuffer.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L81
Since: 4.0.0
webGLBuffer
webGLBuffer: WebGLBuffer
Description:
The WebGLBuffer being wrapped by this class.
This property could change at any time.
Therefore, you should never store a reference to this value.
It should only be passed directly to the WebGL API for drawing.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L43
Since: 3.80.0
Public Methods
bind
<instance> bind([unbind])
Description:
Binds this WebGLBufferWrapper to the current WebGLRenderingContext.
It uses the bufferType of this wrapper to determine which binding point to use.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| unbind | boolean | Yes | false | Whether to unbind the buffer instead. |
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L162
Since: 4.0.0
createResource
<instance> createResource()
Description:
Creates a WebGLBuffer for this WebGLBufferWrapper.
This is called automatically by the constructor. It may also be
called again if the WebGLBuffer needs re-creating.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L139
Since: 3.80.0
destroy
<instance> destroy()
Description:
Remove this WebGLBufferWrapper from the GL context.
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L284
Since: 3.80.0
resize
<instance> resize(bytes)
Description:
Resizes the dataBuffer of this WebGLBufferWrapper.
This will recreate dataBuffer and the views into it.
All data will be lost.
All views into dataBuffer will be destroyed and recreated.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| bytes | number | No | The new size of the buffer in bytes. |
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L229
Since: 4.0.0
update
<instance> update([bytes], [offset])
Description:
Updates the data in this WebGLBufferWrapper.
The dataBuffer must contain the new data to be uploaded to the GPU.
Data will preserve its range from dataBuffer to the WebGLBuffer.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| bytes | number | Yes | The number of bytes to update in the buffer. If not specified, the entire buffer will be updated. | |
| offset | number | Yes | 0 | The offset into the buffer to start updating data at. |
Source: src/renderer/webgl/wrappers/WebGLBufferWrapper.js#L190
Since: 4.0.0