Class Compositor

constructor

• new Compositor(
      renderer: WebGLRenderer,
      settings: {
          attribute: {
              name: string;
              normalized: boolean;
              offset: number;
              size: number;
              type: number;
          }[];
          shader: { fragment: string; vertex: string };
      },
  ): Compositor

  Parameters

  • renderer: WebGLRenderer

    the current WebGL renderer session

  • settings: {
        attribute: {
            name: string;
            normalized: boolean;
            offset: number;
            size: number;
            type: number;
        }[];
        shader: { fragment: string; vertex: string };
    }

    additional settings to initialize this compositors

    • attribute: {
          name: string;
          normalized: boolean;
          offset: number;
          size: number;
          type: number;
      }[]

      an array of attributes definition

    • shader: { fragment: string; vertex: string }

      an array of attributes definition

      • fragment: string

        a string containing the GLSL source code to set

      • vertex: string

        a string containing the GLSL source code to set

  Returns Compositor

attributes

color

currentShader

defaultShader

gl

mode

gl.TRIANGLES
Copy

renderer

vertexByteSize

vertexData

vertexSize

viewMatrix

addAttribute

• addAttribute(
      name: string,
      size: number,
      type: number,
      normalized: boolean,
      offset: number,
  ): void

  add vertex attribute property definition to the compositor

  Parameters

  • name: string

    name of the attribute in the vertex shader

  • size: number

    number of components per vertex attribute. Must be 1, 2, 3, or 4.

  • type: number

    data type of each component in the array

  • normalized: boolean

    whether integer data values should be normalized into a certain range when being cast to a float

  • offset: number

    offset in bytes of the first component in the vertex attribute array

  Returns void

bind

• bind(): void

  called by the WebGL renderer when a compositor become the current one

  Returns void

flush

• flush(mode?: number): void

  Flush batched vertex data to the GPU

  Parameters

  • Optionalmode: number = ...

    the GL drawing mode

  Returns void

setProjection

• setProjection(matrix: Matrix3d): void

  set/change the current projection matrix

  Parameters

  • matrix: Matrix3d

    the new projection matrix

  Returns void

useShader

• useShader(shader: GLShader): void

  Select the shader to use for compositing

  Parameters

  • shader: GLShader

    a reference to a GLShader instance

  Returns void

  See

  GLShader