Internally adds the event handler so that it can be sorted by priority. Priority allows certain handler (user, AnimatedSprite, Interaction) to be run before the rendering.
Conditionally cancels a pending animation frame.
The first listener. All new listeners added are chained on this.
The last time keyframe was executed. Maintains a relatively fixed interval with the previous value.
Internal value managed by minFPS property setter and getter. This is the maximum allowed milliseconds between updates.
Internal value managed by minFPS property setter and getter. This is the maximum allowed milliseconds between updates.
If enabled, deleting is disabled.
Internal current frame request ID
Conditionally requests a new animation frame. If a frame has not already been requested, and if the internal emitter has listeners, a new frame is requested.
Conditionally requests a new animation frame.
If the ticker has been started it checks if a frame has not already
been requested, and if the internal emitter has listeners. If these
conditions are met, a new frame is requested. If the ticker has not
been started, but autoStart is true, then the ticker starts now,
and continues with the previous conditions to request a new frame.
Internal tick method bound to ticker instance. This is because in early 2015, Function.bind is still 60% slower in high performance scenarios. Also separating frame requests from update method so listeners may be called at any time and with any animation API, just invoke ticker.update(time).
Whether or not this ticker should invoke the method {@link PIXI.Ticker#start} automatically when a listener is added.
Scaler time elapsed in milliseconds from last frame to this frame. This value is capped by setting {@link PIXI.Ticker#minFPS} and is scaled with {@link 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 {@link PIXI.Ticker#minFPS} and is scaled with {@link 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 {@link 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 {@link 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 {@link PIXI.Ticker#deltaTime}.
Whether or not this ticker has been started.
true if {@link PIXI.Ticker#start} has been called.
false if {@link PIXI.Ticker#stop} has been called.
While false, this value may change to true in the
event of {@link PIXI.Ticker#autoStart} being true
and a listener is added.
The private shared ticker instance
The private system ticker instance
The frames per second at which this ticker is running. The default is approximately 60 in most modern browsers. Note: This does not factor in the value of {@link PIXI.Ticker#speed}, which is specific to scaling {@link PIXI.Ticker#deltaTime}.
The number of listeners on this ticker, calculated by walking through linked list
Manages the minimum amount of milliseconds required to
elapse between invoking {@link PIXI.Ticker#update}.
This will effect the measured value of {@link 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 minimum amount of milliseconds required to
elapse between invoking {@link PIXI.Ticker#update}.
This will effect the measured value of {@link 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 {@link PIXI.Ticker#update}.
This value is used to cap {@link PIXI.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.
Manages the maximum amount of milliseconds allowed to
elapse between invoking {@link PIXI.Ticker#update}.
This value is used to cap {@link PIXI.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.
The 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 {@link 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.
The system ticker instance used by PIXI.InteractionManager and 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 {@link 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.
The listener function to be added for updates
The listener context
This instance of a ticker
Add a handler for the tick event which is only execute once.
The listener function to be added for one update
The listener context
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.
The listener function to be removed
The listener context to be removed
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 {@link PIXI.Ticker#elapsedMS}, the current {@link PIXI.Ticker#deltaTime}, invoking all listeners with current deltaTime, and then finally setting {@link 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.
Generated using TypeDoc
A Ticker class that runs an update loop that other objects listen to.
This class is composed around listeners meant for execution on the next requested animation frame. Animation frames are requested only when necessary, e.g. When the ticker is started and the emitter has listeners.
PIXI