Scaler time elapsed in milliseconds from last frame to this frame. This value is capped by setting PIXI.Ticker#minFPS and is scaled with PIXI.Ticker#speed. Note: The cap may be exceeded by scaling. If the platform supports DOMHighResTimeStamp, this value will have a precision of 1 µs. Defaults to target frame time
Scalar time value from last frame to this frame. This value is capped by setting PIXI.Ticker#minFPS and is scaled with PIXI.Ticker#speed. Note: The cap may be exceeded by scaling.
Time elapsed in milliseconds from last frame to this frame. Opposed to what the scalar PIXI.Ticker#deltaTime is based, this value is neither capped nor scaled. If the platform supports DOMHighResTimeStamp, this value will have a precision of 1 µs. Defaults to target frame time
The last time PIXI.Ticker#update was invoked. This value is also reset internally outside of invoking update, but only when a new animation frame is requested. If the platform supports DOMHighResTimeStamp, this value will have a precision of 1 µs.
Factor of current PIXI.Ticker#deltaTime.
Whether or not this ticker has been started.
true if PIXI.Ticker#start has been called.
false if PIXI.Ticker#stop has been called.
While false, this value may change to true in the
event of PIXI.Ticker#autoStart being true
and a listener is added.
StatictargetTarget frames per millisecond.
Manages the minimum amount of milliseconds required to
elapse between invoking PIXI.Ticker#update.
This will effect the measured value of PIXI.Ticker#FPS.
If it is set to 0, then there is no limit; PixiJS will render as many frames as it can.
Otherwise it will be at least minFPS
Manages the maximum amount of milliseconds allowed to
elapse between invoking PIXI.Ticker#update.
This value is used to cap PIXI.Ticker#deltaTime,
but does not effect the measured value of PIXI.Ticker#FPS.
When setting this property it is clamped to a value between
0 and Ticker.targetFPMS * 1000.
StaticsharedThe shared ticker instance used by PIXI.AnimatedSprite and by PIXI.VideoResource to update animation frames / video textures.
It may also be used by PIXI.Application if created with the sharedTicker option property set to true.
The property PIXI.Ticker#autoStart is set to true for this instance.
Please follow the examples for usage, including how to opt-out of auto-starting the shared ticker.
import { Ticker } from 'pixi.js';
const ticker = Ticker.shared;
// Set this to prevent starting this ticker when listeners are added.
// By default this is true only for the PIXI.Ticker.shared instance.
ticker.autoStart = false;
// FYI, call this to ensure the ticker is stopped. It should be stopped
// if you have not attempted to render anything yet.
ticker.stop();
// Call this when you are ready for a running shared ticker.
ticker.start();
import { autoDetectRenderer, Container } from 'pixi.js';
// You may use the shared ticker to render...
const renderer = autoDetectRenderer();
const stage = new Container();
document.body.appendChild(renderer.view);
ticker.add((time) => renderer.render(stage));
// Or you can just update it manually.
ticker.autoStart = false;
ticker.stop();
const animate = (time) => {
ticker.update(time);
renderer.render(stage);
requestAnimationFrame(animate);
};
animate(performance.now());
StaticsystemThe system ticker instance used by PIXI.BasePrepare for core timing
functionality that shouldn't usually need to be paused, unlike the shared
ticker which drives visual animations and rendering which may want to be paused.
The property PIXI.Ticker#autoStart is set to true for this instance.
Register a handler for tick events. Calls continuously unless it is removed or the ticker is stopped.
This instance of a ticker
Destroy the ticker and don't use after this. Calling this method removes all references to internal events.
Removes any handlers matching the function and context parameters. If no handlers are left after removing, then it cancels the animation frame.
This instance of a ticker
Starts the ticker. If the ticker has listeners a new animation frame is requested at this point.
Stops the ticker. If the ticker has requested an animation frame it is canceled at this point.
Triggers an update. An update entails setting the current PIXI.Ticker#elapsedMS, the current PIXI.Ticker#deltaTime, invoking all listeners with current deltaTime, and then finally setting PIXI.Ticker#lastTime with the value of currentTime that was provided. This method will be called automatically by animation frame callbacks if the ticker instance has been started and listeners are added.
OptionalcurrentTime: numberthe current time of execution
Whether or not this ticker should invoke the method PIXI.Ticker#start automatically when a listener is added.