Class QuadCompositor

constructor

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

  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 QuadCompositor

boundTextures

currentTextureUnit

addQuad

• addQuad(
      texture: TextureAtlas,
      x: number,
      y: number,
      w: number,
      h: number,
      u0: number,
      v0: number,
      u1: number,
      v1: number,
      tint: number,
      reupload?: boolean,
  ): void

  Add a textured quad

  Parameters

  • texture: TextureAtlas

    Source texture atlas

  • x: number

    Destination x-coordinate

  • y: number

    Destination y-coordinate

  • w: number

    Destination width

  • h: number

    Destination height

  • u0: number

    Texture UV (u0) value.

  • v0: number

    Texture UV (v0) value.

  • u1: number

    Texture UV (u1) value.

  • v1: number

    Texture UV (v1) value.

  • tint: number

    tint color to be applied to the texture in UINT32 (argb) format

  • reupload: boolean = false

    Force the texture to be reuploaded even if already bound

  Returns void

bindTexture2D

• bindTexture2D(texture: WebGLTexture, unit: number): void

  assign the given WebGL texture to the current batch

  Parameters

  • texture: WebGLTexture

    a WebGL texture

  • unit: number

    Texture unit to which the given texture is bound

  Returns void

createTexture2D

• createTexture2D(
      unit: number,
      pixels?:
          | HTMLCanvasElement
          | ImageData
          | (new (width?: number, height?: number) => HTMLImageElement)
          | Uint8Array<ArrayBufferLike>[]
          | Float32Array<ArrayBufferLike>[],
      filter: number,
      repeat?: string,
      w?: number,
      h?: number,
      premultipliedAlpha?: boolean,
      mipmap?: boolean,
      texture: any,
  ): WebGLTexture

  Create a WebGL texture from an image

  Parameters

  • unit: number

    Destination texture unit

  • Optionalpixels:
        | HTMLCanvasElement
        | ImageData
        | (new (width?: number, height?: number) => HTMLImageElement)
        | Uint8Array<ArrayBufferLike>[]
        | Float32Array<ArrayBufferLike>[] = null

    Source image

  • filter: number

    gl.LINEAR or gl.NEAREST

  • Optionalrepeat: string = "no-repeat"

    Image repeat behavior (see ImageLayer#repeat)

  • Optionalw: number = pixels.width

    Source image width (Only use with UInt8Array[] or Float32Array[] source image)

  • Optionalh: number = pixels.height

    Source image height (Only use with UInt8Array[] or Float32Array[] source image)

  • OptionalpremultipliedAlpha: boolean = true

    Multiplies the alpha channel into the other color channels

  • Optionalmipmap: boolean = true

    Whether mipmap levels should be generated for this texture

  • texture: any

  Returns WebGLTexture

  a WebGL texture

deleteTexture2D

• deleteTexture2D(texture?: WebGLTexture): void

  delete the given WebGL texture

  Parameters

  • Optionaltexture: WebGLTexture

    a WebGL texture to delete

  Returns void

getTexture2D

• getTexture2D(unit: number): WebGLTexture

  returns the WebGL texture associated to the given texture unit

  Parameters

  • unit: number

    Texture unit to which a texture is bound

  Returns WebGLTexture

  texture a WebGL texture

unbindTexture2D

• unbindTexture2D(texture?: WebGLTexture, unit?: number): number

  unbind the given WebGL texture, forcing it to be reuploaded

  Parameters

  • Optionaltexture: WebGLTexture

    a WebGL texture

  • Optionalunit: number

    a WebGL texture

  Returns number

  unit the unit number that was associated with the given texture