Phaser API Documentation

A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer. A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.

The minFilter mode of the texture. 0 is LINEAR, 1 is NEAREST.

Controls if this Render Target is automatically cleared (via gl.COLOR_BUFFER_BIT) during the bind.

The data type of the attribute, i.e. gl.BYTE, gl.SHORT, gl.UNSIGNED_BYTE, gl.FLOAT, etc.

The size, in bytes, of the data type.

The name of the attribute as defined in the vertex shader.

The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.

The data type of the attribute. Either gl.BYTE, gl.SHORT, gl.UNSIGNED_BYTE, gl.UNSIGNED_SHORT or gl.FLOAT.

The offset, in bytes, of this attribute data in the vertex array. Equivalent to offsetof(vertex, attrib) in C.

Should the attribute data be normalized?

You should set this to false by default. The pipeline will enable it on boot.

You should set this to -1 by default. The pipeline will set it on boot.

The name of the attribute as defined in the vertex shader.

The number of components in the attribute, i.e. 1 for a float, 2 for a vec2, 3 for a vec3, etc.

The data type of the attribute, one of the WEBGL_CONST values, i.e. WEBGL_CONST.FLOAT, WEBGL_CONST.UNSIGNED_BYTE, etc.

Should the attribute data be normalized?

The Phaser.Game instance that owns this pipeline.

The name of the pipeline.

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).

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

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.

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

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

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

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

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.

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

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.

The name of the shader. Doesn't have to be unique, but makes shader look-up easier if it is.

The source code, as a string, for the vertex shader. If not given, uses the Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.vertShader property instead.

The source code, as a string, for the fragment shader. Can include %count% and %forloop% declarations for multi-texture support. If not given, uses the Phaser.Types.Renderer.WebGL.WebGLPipelineConfig.fragShader property instead.

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

The name of the uniform as defined in the shader.

The location of the uniform.

The first cached value of the uniform.

The first cached value of the uniform.

The first cached value of the uniform.

The first cached value of the uniform.

Indicates if ETC1 compression is supported on current device (mostly Android).

Indicates if PVRTC compression is supported on current device (mostly iOS).

Indicates if S3TC compression is supported on current device.