Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    The occlusion mask which contains radial occlusion and vision occlusion from tokens. Red channel: Fade occlusion. Green channel: Radial occlusion. Blue channel: Vision occlusion. Alpha channel: Surface occlusion.

    Hierarchy (View Summary)

    Index

    Properties

    autoRender: boolean = false
    clearColor: number[] = ...
    displayed: boolean = false

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

    renderDirty: boolean = true

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

    surfaces: Graphics

    Graphics in which surface occlusion shapes are drawn.

    tokens: Graphics

    Graphics in which token radial and vision occlusion shapes are drawn.

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

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

    textureConfiguration: {
        format: FORMATS;
        multisample: MSAA_QUALITY;
        scaleMode: SCALE_MODES;
    } = ...

    Accessors

    • set alphaMode(mode: ALPHA_MODES): void

      Set the alpha mode of the cached container render texture.

      Parameters

      • mode: ALPHA_MODES

      Returns void

    • get occluded(): Set<PrimaryCanvasObject>

      The set of currently occluded canvas objects.

      Returns Set<PrimaryCanvasObject>

    • get renderTexture(): RenderTexture

      The primary render texture bound to this cached container.

      Returns RenderTexture

    • get sprite(): SpriteMesh | Sprite

      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 SpriteMesh | Sprite

    • get vision(): boolean

      Is vision occlusion active?

      Returns boolean

    Methods

    • Internal

      Update the occludable tokens.

      Returns void

    • Internal

      Update the current occlusion status of all PCOs.

      Returns void

    • Internal

      Determine the occluded surfaces.

      Parameters

      • flags: object

        The perception render flags that are processed

      Returns void

    • Internal

      Draw occlusion shapes to the occlusion mask. Fade occlusion draws to the red channel with varying intensity from [0, 1] based on elevation. Radial occlusion draws to the green channel with varying intensity from [0, 1] based on elevation. Vision occlusion draws to the blue channel with varying intensity from [0, 1] based on elevation. Surface occlusion draws to the alpha channel with varying intensity from [0, 1] based on elevation.

      Returns void

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

      Parameters

      • Optionaloptions: { clearColor?: number[]; renderFunction?: Function } = {}

        Optional parameters.

        • OptionalclearColor?: number[]

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

        • OptionalrenderFunction?: Function

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

      Returns RenderTexture

      A reference to the created render texture.

    • Parameters

      • options: any

      Returns void

    • Map an elevation to a value in the range [0, 1] with 8-bit precision. The radial and vision shapes are drawn 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

    • Remove a previously created render texture.

      Parameters

      • renderTexture: RenderTexture

        The render texture to remove.

      • Optionaldestroy: boolean = true

        Should the render texture be destroyed?

      Returns void

    • Parameters

      • renderer: any

      Returns void

    • Protected

      Determine the set of objects which should be currently occluded by a Token.

      Parameters

      • tokens: Token[]

        The occludable Tokens

      Returns Set<PrimaryCanvasObjectMixin>

      The PCO objects which should be currently occluded

    • 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.

      • OptionalclearColor: number[]

        A custom clear color.

      Returns void

    • Protected

      Custom rendering for secondary render textures

      Parameters

      • renderer: Renderer

        The active canvas renderer.

      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