Internal_The ambience filter which is applying post-processing effects.
Internal_The background color in RGB.
If true, the Container is rendered every frame. If false, the Container is rendered only if CachedContainer#renderDirty is true.
The primary background image configured for the Scene, rendered as a SpriteMesh.
Should our Container also be displayed on screen, in addition to being drawn to the cached RenderTexture?
The collection of PrimaryDrawingContainer objects which are rendered in the Scene.
The primary foreground image configured for the Scene, rendered as a SpriteMesh.
Occludable objects above this elevation are faded on hover.
The level texture meshes, sorted in ascending order.
A Quadtree which partitions and organizes primary canvas objects.
Does the Container need to be rendered? Set to false after the Container is rendered.
The collection of SpriteMesh objects which are rendered in the Scene.
The collection of SpriteMesh objects which are rendered in the Scene.
Track the set of HTMLVideoElements which are currently playing as part of this group.
Protected_A map of render textures, linked to their render function and an optional RGBA clear color.
StaticBACKGROUND_Allow API users to override the default elevation of the background layer. This is a temporary solution until more formal support for scene levels is added in a future release.
StaticgroupStaticSORT_Sort order to break ties on the group/layer level.
StatictextureSet the alpha mode of the cached container render texture.
Return the base HTML image or video element which provides the background texture.
Return the base HTML image or video element which provides the foreground texture.
The primary render texture bound to this cached container.
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.
InternalHandle mousemove events on the primary group to update the hovered state of its children.
Current mouse position
Has the mouse been moved (or it is a simulated mouse move event)?
Add a PrimaryGraphics to the group.
The Drawing being added
The created PrimaryGraphics instance
Draw the SpriteMesh for a specific Token object.
The Tile being added
The added PrimarySpriteMesh
Draw the SpriteMesh for a specific Token object.
The Token being added
The added PrimarySpriteMesh
Clear the cached container, removing its current contents.
Optionaldestroy: boolean = trueTell children that we should destroy texture as well.
A reference to the cleared container for chaining.
Create a render texture, provide a render method and an optional clear color.
Optionaloptions: { clearColor?: number[]; renderFunction?: Function } = {}Optional parameters.
OptionalclearColor?: number[]An optional clear color to clear the RT before rendering into it.
OptionalrenderFunction?: FunctionRender function that will be called to render into the RT.
A reference to the created render texture.
Refresh the primary mesh.
Remove a PrimaryGraphics from the group.
The Drawing being removed
Remove a previously created render texture.
The render texture to remove.
Optionaldestroy: boolean = trueShould the render texture be destroyed?
Remove a TokenMesh from the group.
The Tile being removed
Remove a TokenMesh from the group.
The Token being removed
Override the default PIXI.Container behavior for how objects in this container are sorted.
Update this group. Calculates the canvas transform and bounds of all its children and updates the quadtree.
Protected#bindProtectedBind a render texture to this renderer. Must be called after bindPrimaryBuffer and before bindInitialBuffer.
The active canvas renderer.
The texture to bind.
OptionalclearColor: number[]A custom clear color.
Protected#renderProtectedCustom rendering for secondary render textures
The active canvas renderer.
Static_InternalThe sorting function used to order objects inside the Primary Canvas Group. Overrides the default sorting function defined for the PIXI.Container. Sort Tokens PCO above other objects except WeatherEffects, then Drawings PCO, all else held equal.
An object to display
Some other object to display
StaticresizeResize a render texture passed as a parameter with the renderer.
The active canvas renderer.
The render texture to resize.
The primary Canvas group which generally contains tangible physical objects which exist within the Scene. This group is a foundry.canvas.containers.CachedContainer which is rendered to the Scene as a foundry.canvas.containers.SpriteMesh. This allows the rendered result of the Primary Canvas Group to be affected by a foundry.canvas.rendering.shaders.BaseSamplerShader.
Mixes
CanvasGroupMixin