PixiJS

Class: Program

PIXI.Program

Helper class to create a shader program.

new PIXI.Program (vertexSrc, fragmentSrc, name, extra)

Program.ts:84
Name Type Attributes Default Description
vertexSrc string <optional>

The source of the vertex shader.
fragmentSrc string <optional>

The source of the fragment shader.
name string 'pixi-shader'

Name for shader
extra IProgramExtraData

Extra data for shader

Members

PIXI.Program.defaultFragmentPrecision PIXI.PRECISION static

Default specify float precision in fragment shader. iOS is best set at highp due to https://github.com/pixijs/pixijs/issues/3742

Default Value:
  • PIXI.PRECISION.MEDIUM

PIXI.Program.defaultFragmentSrc string staticreadonly

The default fragment shader source.

PIXI.Program.defaultVertexPrecision PIXI.PRECISION static

Default specify float precision in vertex shader.

Default Value:
  • PIXI.PRECISION.HIGH

PIXI.Program.defaultVertexSrc string staticreadonly

The default vertex shader source.

attributeData { [key: string]: IAttributeData }

Assigned when a program is first bound to the shader system.

fragmentSrc string

Source code for the fragment shader.

uniformData { [key: string]: IUniformData }

Assigned when a program is first bound to the shader system.

vertexSrc string

Source code for the vertex shader.

Methods

PIXI.Program.from (vertexSrc, fragmentSrc, name) PIXI.Program static

Program.ts:155

A short hand function to create a program based of a vertex and fragment shader.

This method will also check to see if there is a cached program.

Name Type Attributes Description
vertexSrc string <optional>

The source of the vertex shader.
fragmentSrc string <optional>

The source of the fragment shader.
name string <optional>

Name for shader
Returns:
Type Description
PIXI.Program A shiny new PixiJS shader program!