Cached container used for dynamic darkness level. Display objects (of any type) added to this cached container will contribute to computing the darkness level of the masked area. Only the red channel is utilized, which corresponds to the desired darkness level. Other channels are ignored.

Hierarchy (view full)

Properties

renderDirty: boolean = true

Does the Container need to be rendered? Set to false after the Container is rendered.

clearColor: number[] = ...

An RGBA array used to define the clear color of the RenderTexture

displayed: boolean = false

Should our Container also be displayed on screen, in addition to being drawn to the cached RenderTexture?

_renderPaths: Map<RenderTexture, {
    renderFunction: Function;
    clearColor: number[];
}> = ...

A map of render textures, linked to their render function and an optional RGBA clear color.

Type declaration

  • renderFunction: Function
  • clearColor: number[]
textureConfiguration: {
    scaleMode: any;
    format: any;
    multisample: any;
    mipmap: any;
} = ...

Type declaration

  • scaleMode: any
  • format: any
  • multisample: any
  • mipmap: any

Accessors

  • get sprite(): any
  • A PIXI.Sprite or SpriteMesh which is bound to this CachedContainer. The RenderTexture from this Container is associated with the Sprite which is automatically rendered.

    Returns any

  • get renderTexture(): RenderTexture
  • The primary render texture bound to this cached container.

    Returns RenderTexture

  • set alphaMode(mode): void
  • Set the alpha mode of the cached container render texture.

    Parameters

    • mode: ALPHA_MODES

    Returns void

Methods

  • Create a render texture, provide a render method and an optional clear color.

    Parameters

    • Optional options: {
          renderFunction: Function;
          clearColor: number[];
      } = {}

      Optional parameters.

      • renderFunction: Function

        Render function that will be called to render into the RT.

      • clearColor: number[]

        An optional clear color to clear the RT before rendering into it.

    Returns RenderTexture

    A reference to the created render texture.

  • Remove a previously created render texture.

    Parameters

    • renderTexture: RenderTexture

      The render texture to remove.

    • Optional destroy: boolean = true

      Should the render texture be destroyed?

    Returns void

  • Clear the cached container, removing its current contents.

    Parameters

    • Optional destroy: boolean = true

      Tell children that we should destroy texture as well.

    Returns CachedContainer

    A reference to the cleared container for chaining.

  • Parameters

    • renderer: any

    Returns void

    Inherit Doc

  • Protected

    Custom rendering for secondary render textures

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    Returns void

  • Protected

    Bind a render texture to this renderer. Must be called after bindPrimaryBuffer and before bindInitialBuffer.

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    • tex: RenderTexture

      The texture to bind.

    • Optional clearColor: number[]

      A custom clear color.

    Returns void

  • Called when a display object is added or removed from this container.

    Returns void

  • Resize a render texture passed as a parameter with the renderer.

    Parameters

    • renderer: Renderer

      The active canvas renderer.

    • rt: RenderTexture

      The render texture to resize.

    Returns void