PixiJS

Class: ShaderSystem

PIXI.ShaderSystem

System plugin to the renderer to manage shaders.

new PIXI.ShaderSystem (renderer) overrides

ShaderSystem.ts:38
Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Extends

Implements

Members

gl WebGLRenderingContext

The current WebGL rendering context

Default Value:
  • undefined

Methods

bind (shader, dontSync) PIXI.GLProgram

ShaderSystem.ts:90

Changes the current shader to the one given in parameter

Name Type Attributes Description
shader PIXI.Shader

the new shader
dontSync boolean <optional>

false if the shader should automatically sync its uniforms.
Returns:
Type Description
PIXI.GLProgram the glProgram that belongs to the shader.

destroy () void overrides

ShaderSystem.ts:330

Destroys this System and removes all its textures

getGlProgram () PIXI.GLProgram

ShaderSystem.ts:286

Returns the underlying GLShade rof the currently bound shader. This can be handy for when you to have a little more control over the setting of your uniforms.

Returns:
Type Description
PIXI.GLProgram the glProgram for the currently bound Shader for this context

reset () void

ShaderSystem.ts:321

Resets ShaderSystem state, does not affect WebGL state

setUniforms (uniforms) void

ShaderSystem.ts:124

Uploads the uniforms values to the currently bound shader.

Name Type Description
uniforms object

the uniforms values that be applied to the current shader

syncUniformBufferGroup (group, name)

ShaderSystem.ts:183

Syncs uniform buffers

Name Type Attributes Description
group PIXI.UniformGroup

the uniform buffer group to sync
name string <optional>

the name of the uniform buffer

syncUniformGroup (group, syncData) void

ShaderSystem.ts:138

syncs uniforms on the group

Name Type Attributes Description
group PIXI.UniformGroup

the uniform group to sync
syncData any <optional>

this is data that is passed to the sync function and any nested sync functions

createSyncBufferGroup (group, glProgram, name) UniformsSyncCallback protected

ShaderSystem.ts:214

Will create a function that uploads a uniform buffer using the STD140 standard. The upload function will then be cached for future calls If a group is manually managed, then a simple upload function is generated

Name Type Description
group PIXI.UniformGroup

the uniform buffer group to sync
glProgram PIXI.GLProgram

the gl program to attach the uniform bindings to
name string

the name of the uniform buffer (must exist on the shader)
Returns:
Type Description
UniformsSyncCallback

Inherited Properties

From class PIXI.System

renderer Renderer inherited

Reference to the main renderer