phaser - v3.90.0
    Preparing search index...

    Class BaseShader

    A BaseShader is a small resource class that contains the data required for a WebGL Shader to be created.

    It contains the raw source code to the fragment and vertex shader, as well as an object that defines the uniforms the shader requires, if any.

    BaseShaders are stored in the Shader Cache, available in a Scene via this.cache.shaders and are referenced by a unique key-based string. Retrieve them via this.cache.shaders.get(key).

    BaseShaders are created automatically by the GLSL File Loader when loading an external shader resource. They can also be created at runtime, allowing you to use dynamically generated shader source code.

    Default fragment and vertex source is used if not provided in the constructor, setting-up a basic shader, suitable for debug rendering.

    Index

    Constructors

    constructor

    Properties

    fragmentSrc key uniforms vertexSrc

    Constructors

    • Parameters

      • key: string

        The key of this shader. Must be unique within the shader cache.

      • OptionalfragmentSrc: string

        The fragment source for the shader.

      • OptionalvertexSrc: string

        The vertex source for the shader.

      • Optionaluniforms: any

        Optional object defining the uniforms the shader uses.

      Returns BaseShader

    Properties

    fragmentSrc: string

    The source code, as a string, of the fragment shader being used.

    key: string

    The key of this shader, unique within the shader cache of this Phaser game instance.

    uniforms: any

    The default uniforms for this shader.

    vertexSrc: string

    The source code, as a string, of the vertex shader being used.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties