Phaser API Documentation

  Version: 
WebGLPipelineConfig
Properties:
name type arguments Default description
game Phaser.Game

The Phaser.Game instance that owns this pipeline.

name string <optional>

The name of the pipeline.

topology GLenum <optional> gl.TRIANGLES

How the primitives are rendered. The default value is GL_TRIANGLES. Here is the full list of rendering primitives: (https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Constants).

vertShader string <optional>

The source code, as a string, for the vertex shader. If you need to assign multiple shaders, see the shaders property.

fragShader string <optional>

The source code, as a string, for the fragment shader. Can include %count% and %forloop% declarations for multi-texture support. If you need to assign multiple shaders, see the shaders property.

batchSize number <optional>

The number of quads to hold in the batch. Defaults to RenderConfig.batchSize. This amount * 6 gives the vertex capacity.

vertexSize number <optional>

The size, in bytes, of a single entry in the vertex buffer. Defaults to Float32Array.BYTES_PER_ELEMENT * 6 + Uint8Array.BYTES_PER_ELEMENT * 4.

vertices Array.<number> | Float32Array <optional>

An optional Array or Typed Array of pre-calculated vertices data that is copied into the vertex data.

attributes Array.<Phaser.Types.Renderer.WebGL.WebGLPipelineAttributeConfig> <optional>

An array of shader attribute data. All shaders bound to this pipeline must use the same attributes.

shaders Array.<Phaser.Types.Renderer.WebGL.WebGLPipelineShaderConfig> <optional>

An array of shaders, all of which are created for this one pipeline. Uses the vertShader, fragShader, attributes and uniforms properties of this object as defaults.

forceZero boolean <optional> false

Force the shader to use just a single sampler2d? Set for anything that extends the Single Pipeline.

renderTarget boolean | number | Array.<Phaser.Types.Renderer.WebGL.RenderTargetConfig> <optional>

Create Render Targets for this pipeline. Can be a number, which determines the quantity, a boolean (sets quantity to 1), or an array of Render Target configuration objects.

Type:
object