Skip to main content

Pixi Stage

This node creates the main rendering stage for PixiJS content. It serves as the root container and manages the PIXI.Application instance.

The Pixi Stage is the foundation for all PixiJS graphics and animations in your application.

The Pixi Stage node initializes a PIXI.Application instance and provides the rendering context for all other Pixi nodes. It manages the WebGL or Canvas renderer, handles the animation loop, and serves as the root container for the Pixi scene graph.

Inputs

Dimensions

DataDescription
WidthSpecifies the width of the stage in pixels (default: 800)
HeightSpecifies the height of the stage in pixels (default: 600)

Appearance

DataDescription
Bg ColorSets the background color of the stage
Bg AlphaSets the background alpha transparency (0-1)
Transparent BackgroundEnables transparent background mode

Rendering

DataDescription
ResolutionSets the renderer resolution (default: 1)
AntialiasEnables antialiasing for smoother graphics
Force Canvas RendererForces the use of Canvas renderer instead of WebGL
Render On DemandEnables manual render control

Animation

DataDescription
Ticker EnabledEnables automatic animation ticker
Ticker SpeedControls animation speed multiplier
Animation TypeSelects animation type (none, pulseBackground, colorCycleBackground, stageEffects, custom)
Custom Animation CodeJavaScript code for custom animations

Outputs

SignalDescription
Stage CreatedSignal emitted when stage is initialized
DataDescription
App InstanceReference to the PIXI.Application instance
Node ReferenceReference to this node instance
Current WidthCurrent stage width
Current HeightCurrent stage height

Usage

The Pixi Stage node should be placed at the root of your Pixi scene. All other Pixi nodes (Pixi Container, Pixi Sprite, etc.) should be children of this stage node to be rendered properly.

Example Setup

  1. Add a Pixi Stage node to your component
  2. Configure the dimensions and background settings
  3. Add child Pixi nodes (containers, sprites, graphics) to build your scene
  4. Connect the Stage Created signal to initialize your scene logic

Performance Tips

  • Use Render On Demand for static scenes to improve performance
  • Adjust Resolution based on device capabilities
  • Enable Antialias for smoother graphics on high-DPI displays
  • Use Transparent Background when integrating with other UI elements