WebGLVertexBufferLayoutWrapper
Wraps a WebGL vertex buffer together with its attribute layout description. This class manages the relationship between a WebGLBufferWrapper (the raw GPU buffer) and the attribute layout that describes how vertex data is arranged within it, including the stride, per-attribute byte counts, and byte offsets. It is used by Phaser's WebGL renderer to bind vertex data to shader attribute locations when drawing geometry. On construction, the layout is completed by computing stride, byte counts, and offsets from the provided attribute definitions, and any GL enum values specified as strings are resolved to their numeric equivalents.
Constructor
new WebGLVertexBufferLayoutWrapper(renderer, program, layout, [buffer])
Parameters
| name | type | optional | description |
|---|---|---|---|
| renderer | Phaser.Renderer.WebGL.WebGLRenderer | No | The WebGLRenderer instance that owns this wrapper. |
| program | Phaser.Renderer.WebGL.Wrappers.WebGLProgramWrapper | No | The program that this layout is associated with. |
| layout | Partial.<Phaser.Types.Renderer.WebGL.WebGLAttributeBufferLayout> | No | The layout of the buffer. At construction, this should be incomplete. The stride and per-attribute location, bytes, and offset will be filled in during construction. This will mutate the object. |
| buffer | Phaser.Renderer.WebGL.Wrappers.WebGLBufferWrapper | Yes | The buffer that this layout should use. If not provided, a new buffer will be created. If the buffer is too small, an exception is thrown. |
Scope: static
Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L9
Since: 4.0.0
Public Members
buffer
buffer: Phaser.Renderer.WebGL.Wrappers.WebGLBufferWrapper
Description:
The WebGLBufferWrapper holding the vertex data for this layout.
Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L64
Since: 4.0.0
layout
layout: Phaser.Types.Renderer.WebGL.WebGLAttributeBufferLayout
Description:
The completed attribute buffer layout, describing the stride, attributes, their types, sizes, byte counts, and byte offsets within the vertex buffer.
Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L43
Since: 4.0.0
renderer
renderer: Phaser.Renderer.WebGL.WebGLRenderer
Description:
The WebGLRenderer instance that owns this wrapper.
Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L34
Since: 4.0.0
Public Methods
completeLayout
<instance> completeLayout(attributeBufferLayout)
Description:
Complete the layout of the provided attribute buffer layout. This will fill in the stride, byte counts, and offsets. In addition, it will convert any GLenums specified as strings to their numeric values. This mutates the layout.
The order of attributes within the layout forms the order of the buffer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| attributeBufferLayout | Phaser.Types.Renderer.WebGL.WebGLAttributeBufferLayout | No | The layout to complete. |
Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L74
Since: 4.0.0