Skip to main content
Version: Phaser v4.0.0-rc.6

WebGLVertexBufferLayoutWrapper

Wrapper for a vertex buffer layout.

This contains the buffer itself, the attribute layout information,

and the ArrayBuffer and associate views that the layout is based on.

Constructor

new WebGLVertexBufferLayoutWrapper(renderer, program, layout, [buffer])

Parameters

nametypeoptionaldescription
rendererPhaser.Renderer.WebGL.WebGLRendererNoThe WebGLRenderer instance that owns this wrapper.
programPhaser.Renderer.WebGL.Wrappers.WebGLProgramWrapperNoThe program that this layout is associated with.
layoutPartial.<Phaser.Types.Renderer.WebGL.WebGLAttributeBufferLayout>NoThe 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.
bufferPhaser.Renderer.WebGL.Wrappers.WebGLBufferWrapperYesThe 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 WebGLBuffer that this layout is based on.

Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L56
Since: 4.0.0


layout

layout: Phaser.Types.Renderer.WebGL.WebGLAttributeBufferLayout

Description:

The layout of the buffer.

Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L37
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#L28
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:

nametypeoptionaldescription
attributeBufferLayoutPhaser.Types.Renderer.WebGL.WebGLAttributeBufferLayoutNoThe layout to complete.

Source: src/renderer/webgl/wrappers/WebGLVertexBufferLayoutWrapper.js#L66
Since: 4.0.0