Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a shader program used to control low-level graphics rendering.

Hierarchy

  • Shader

Index

Constructors

constructor

  • Construct a new shader program. The shader can be used immediately, but will not have an effect on rendering until it's fully loaded.

    Parameters

    • options: ShaderOptions

      Options for creating the new shader program.

    Returns Shader

Properties

Static Default

Default: Shader

The default shader program provided by the engine.

Methods

clone

  • Get a new Shader using the same program as this one but with an independent set of uniform variables.

    Returns Shader

setBoolean

  • setBoolean(name: string, value: boolean): void
  • Set the value of a bool uniform.

    Parameters

    • name: string

      Name of the uniform variable in the GLSL source text.

    • value: boolean

      Value to set: either true or false.

    Returns void

setColorVector

  • setColorVector(name: string, color: Color): void
  • Set the values of a vec4 uniform from the components of a Color (RGBA).

    Parameters

    • name: string

      Name of a uniform variable in the GLSL source text.

    • color: Color

      A Color object whose RGBA values will be used.

    Returns void

setFloat

  • setFloat(name: string, value: number): void
  • Set the value of a float (floating point) uniform.

    Parameters

    • name: string

      Name of a uniform variable in the GLSL source text.

    • value: number

      Value to set.

    Returns void

setFloatVector

  • setFloatVector(name: string, values: [number, number] | [number, number, number] | [number, number, number, number]): void
  • Parameters

    • name: string
    • values: [number, number] | [number, number, number] | [number, number, number, number]

    Returns void

setInt

  • setInt(name: string, value: number): void
  • Set the value of an int (integer) uniform.

    Parameters

    • name: string

      Name of a uniform variable in the GLSL source text.

    • value: number

      Value to set. Anything after the decimal point will be ignored.

    Returns void

setIntVector

  • setIntVector(name: string, values: [number, number] | [number, number, number] | [number, number, number, number]): void
  • Parameters

    • name: string
    • values: [number, number] | [number, number, number] | [number, number, number, number]

    Returns void

setMatrix

  • setMatrix(name: string, transform: Transform): void
  • Set the values of a mat4 (4x4 matrix) uniform from the matrix cells of a Transform.

    Parameters

    • name: string

      Name of the uniform in the GLSL source text.

    • transform: Transform

      A Transform object whose 4x4 matrix cells will be used.

    Returns void

Static fromFiles

  • Load the given shader files in the background and construct a new shader program from them.

    async

    Parameters

    • options: ShaderOptions

      Options for creating the new shader program.

    Returns Promise<Shader>

    A promise for the new Shader object.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc