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

    An interface for defining shader-based weather effects

    The config object to create the shader effect

    Hierarchy (View Summary)

    Index

    Accessors

    • get blendMode(): BLEND_MODES

      Assigned blend mode to this mesh.

      Returns BLEND_MODES

    Methods

    • Parameters

      • renderer: any

      Returns void

    • Set shader parameters.

      Parameters

      • Optionalconfig: object = {}

      Returns void

    • Tests if a point is inside this QuadMesh.

      Parameters

      • point: IPointData

      Returns boolean

    • Parameters

      • options: any

      Returns void

    • Begin animation

      Returns void

    • Stop animation

      Returns void

    • Protected

      Initialize the weather effect.

      Parameters

      • config: object

        Config object.

      Returns void