Class WebGLTextureUnitsWrapper

constructor

• new WebGLTextureUnitsWrapper(renderer: WebGLRenderer): WebGLTextureUnitsWrapper

  Parameters

  • renderer: WebGLRenderer

    The WebGLRenderer instance that owns this wrapper.

  Returns WebGLTextureUnitsWrapper

renderer

unitIndices

units

bind

• bind(
      texture: WebGLTextureWrapper | null,
      unit: number,
      force?: boolean,
      forceActive?: boolean,
  ): void

  Binds a texture to a texture unit.

  This will change the active texture unit to the given unit, unless forceActive is false.

  This should be the only way to bind a texture to a unit.

  Parameters

  • texture: WebGLTextureWrapper | null

    The texture to bind, or null to unbind the unit.

  • unit: number

    The texture unit to bind the texture to.

  • Optionalforce: boolean

    If true, it will bind the texture even if it is already bound. Default false.

  • OptionalforceActive: boolean

    If true, it will change the active texture unit to the given unit even if it is already active. Otherwise, it will only change the active texture unit if it is not already active. Default true.

  Returns void

bindUnits

• bindUnits(
      textures: (WebGLTextureWrapper | null | undefined)[],
      force?: boolean,
  ): void

  Set specific texture units to specific textures.

  The active texture unit may change to accommodate the bindings.

  Parameters

  • textures: (WebGLTextureWrapper | null | undefined)[]

    The textures to bind. Null values will be unbound. Undefined values will be skipped.

  • Optionalforce: boolean

    If true, it will bind all textures, even if they are already bound. Default false.

  Returns void

init

• init(): void

  Initializes the texture units to null. The active texture unit will be 0 after this runs.

  This populates every texture unit with a 1x1 texture. This stops WebGL errors on MacOS. These textures are not wrapped, and are not intended to be used, so the texture units are recorded as null.

  Returns void

unbindAllUnits

• unbindAllUnits(): void

  Unbinds all textures from all texture units. This will change the active texture unit to 0.

  Returns void

unbindTexture

• unbindTexture(texture: WebGLTextureWrapper): void

  Unbinds a specific texture from all texture units it is currently bound to.

  Iterates over all texture units and replaces any binding that matches the given texture with null. This is typically called when a texture is about to be destroyed, to ensure no unit holds a stale reference.

  Parameters

  • texture: WebGLTextureWrapper

    The texture to unbind from all units.

  Returns void