The depth mask which contains a mapping of elevation. Needed to know if we must render objects according to depth. Red channel: Lighting occlusion (top). Green channel: Lighting occlusion (bottom). Blue channel: Weather occlusion.

Hierarchy (view full)

Properties

roofs: Container

Container in which roofs are rendered with depth data.

clearColor: number[] = ...
_elevationDirty: boolean = false

Update the elevation-to-depth mapping?

displayed: boolean = false

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

autoRender: boolean = true

If true, the Container is rendered every frame. If false, the Container is rendered only if CachedContainer#renderDirty is true.

renderDirty: boolean = true

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

_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[]
#elevations: Float64Array = ...

The elevations of the elevation-to-depth mapping. Supported are up to 255 unique elevations.

textureConfiguration: {
    scaleMode: any;
    format: any;
    multisample: any;
} = ...

Type declaration

  • scaleMode: any
  • format: any
  • multisample: 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

  • Map an elevation to a value in the range [0, 1] with 8-bit precision. The depth-rendered object are rendered with these values into the render texture.

    Parameters

    • elevation: number

      The elevation in distance units

    Returns number

    The value for this elevation in the range [0, 1] with 8-bit precision

  • Internal

    Update the elevation-to-depth mapping. Needs to be called after the children have been sorted and the canvas transform phase.

    Returns void

  • 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

  • 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

  • Initialize the depth mask with the roofs container and token graphics.

    Returns void

  • Create the roofs container.

    Returns Container

  • 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