Home

namespace: ticker


  {
    "comment": "/**\n * @namespace PIXI.ticker\n */",
    "meta": {
        "range": [
            1699,
            1732
        ],
        "filename": "index.js",
        "lineno": 55,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker",
        "code": {}
    },
    "kind": "namespace",
    "name": "ticker",
    "memberof": "PIXI",
    "longname": "PIXI.ticker",
    "scope": "static",
    "___id": "T000002R011142",
    "___s": true,
    "filepath": "core\\ticker\\index.js"
}
tr> private _startIfPossible(): void public add(fn: function, context: function, priority: number): PIXI.ticker.Ticker public addOnce(fn: function, context: function, priority: number): PIXI.ticker.Ticker private _addListener(listener: TickerListener): PIXI.ticker.Ticker public remove(fn: function, context: function): PIXI.ticker.Ticker public start(): void public stop(): void public destroy(): void public update(currentTime: number): void public FPS(): void public minFPS(): void

Properties


Name Type Attribute Description
autoStart boolean public

Whether or not this ticker should invoke the method
{@link PIXI.ticker.Ticker#start} automatically
when a listener is added.

deltaTime number public

Scalar time value from last frame to this frame.
This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}
and is scaled with {@link PIXI.ticker.Ticker#speed}.
Note: The cap may be exceeded by scaling.

elapsedMS number public

Time elapsed in milliseconds from last frame to this frame.
Opposed to what the scalar {@link PIXI.ticker.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

lastTime number public

The last time {@link PIXI.ticker.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.

speed number public

Factor of current {@link PIXI.ticker.Ticker#deltaTime}.

started boolean public

Whether or not this ticker has been started.
true if {@link PIXI.ticker.Ticker#start} has been called.
false if {@link PIXI.ticker.Ticker#stop} has been called.
While false, this value may change to true in the
event of {@link PIXI.ticker.Ticker#autoStart} being true
and a listener is added.

autoStart boolean public

Whether or not this ticker should invoke the method
{@link PIXI.ticker.Ticker#start} automatically
when a listener is added.

deltaTime number public

Scalar time value from last frame to this frame.
This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}
and is scaled with {@link PIXI.ticker.Ticker#speed}.
Note: The cap may be exceeded by scaling.

elapsedMS number public

Time elapsed in milliseconds from last frame to this frame.
Opposed to what the scalar {@link PIXI.ticker.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

lastTime number public

The last time {@link PIXI.ticker.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.

speed number public

Factor of current {@link PIXI.ticker.Ticker#deltaTime}.

started boolean public

Whether or not this ticker has been started.
true if {@link PIXI.ticker.Ticker#start} has been called.
false if {@link PIXI.ticker.Ticker#stop} has been called.
While false, this value may change to true in the
event of {@link PIXI.ticker.Ticker#autoStart} being true
and a listener is added.

Methods


_requestIfNeeded(): void

core\ticker\Ticker.js, line 150

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.

Returns:

void


_cancelIfNeeded(): void

core\ticker\Ticker.js, line 165

Conditionally cancels a pending animation frame.

Returns:

void


_startIfPossible(): void

core\ticker\Ticker.js, line 184

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.

Returns:

void


add(fn: function, context: function, priority: number): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 205

Register a handler for tick events. Calls continuously unless
it is removed or the ticker is stopped.

Params:

Name Type Attribute Description
fn

The listener function to be added for updates

context

The listener context

priority

The priority for emitting

Returns:

PIXI.ticker.Ticker


addOnce(fn: function, context: function, priority: number): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 218

Add a handler for the tick event which is only execute once.

Params:

Name Type Attribute Description
fn

The listener function to be added for one update

context

The listener context

priority

The priority for emitting

Returns:

PIXI.ticker.Ticker


_addListener(listener: TickerListener): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 232

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.

Params:

Name Type Attribute Description
listener

Current listener being added.

Returns:

PIXI.ticker.Ticker


remove(fn: function, context: function): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 277

Removes any handlers matching the function and context parameters.
If no handlers are left after removing, then it cancels the animation frame.

Params:

Name Type Attribute Description
fn

The listener function to be removed

context

The listener context to be removed

Returns:

PIXI.ticker.Ticker


start(): void

core\ticker\Ticker.js, line 308

Starts the ticker. If the ticker has listeners
a new animation frame is requested at this point.

Returns:

void


stop(): void

core\ticker\Ticker.js, line 321

Stops the ticker. If the ticker has requested
an animation frame it is canceled at this point.

Returns:

void


destroy(): void

core\ticker\Ticker.js, line 334

Destroy the ticker and don't use after this. Calling
this method removes all references to internal events.

Returns:

void


update(currentTime: number): void

core\ticker\Ticker.js, line 362

Triggers an update. An update entails setting the
current {@link PIXI.ticker.Ticker#elapsedMS},
the current {@link PIXI.ticker.Ticker#deltaTime},
invoking all listeners with current deltaTime,
and then finally setting {@link PIXI.ticker.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.

Params:

Name Type Attribute Description
currentTime

the current time of execution

Returns:

void


FPS(): void

core\ticker\Ticker.js, line 425

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.Ticker#speed}, which is specific
to scaling {@link PIXI.ticker.Ticker#deltaTime}.

Returns:

void


minFPS(): void

core\ticker\Ticker.js, line 441

Manages the maximum amount of milliseconds allowed to
elapse between invoking {@link PIXI.ticker.Ticker#update}.
This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.

Returns:

void


_requestIfNeeded(): void

core\ticker\Ticker.js, line 150

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.

Returns:

void


_cancelIfNeeded(): void

core\ticker\Ticker.js, line 165

Conditionally cancels a pending animation frame.

Returns:

void


_startIfPossible(): void

core\ticker\Ticker.js, line 184

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.

Returns:

void


add(fn: function, context: function, priority: number): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 205

Register a handler for tick events. Calls continuously unless
it is removed or the ticker is stopped.

Params:

Name Type Attribute Description
fn

The listener function to be added for updates

context

The listener context

priority

The priority for emitting

Returns:

PIXI.ticker.Ticker


addOnce(fn: function, context: function, priority: number): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 218

Add a handler for the tick event which is only execute once.

Params:

Name Type Attribute Description
fn

The listener function to be added for one update

context

The listener context

priority

The priority for emitting

Returns:

PIXI.ticker.Ticker


_addListener(listener: TickerListener): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 232

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.

Params:

Name Type Attribute Description
listener

Current listener being added.

Returns:

PIXI.ticker.Ticker


remove(fn: function, context: function): PIXI.ticker.Ticker

core\ticker\Ticker.js, line 277

Removes any handlers matching the function and context parameters.
If no handlers are left after removing, then it cancels the animation frame.

Params:

Name Type Attribute Description
fn

The listener function to be removed

context

The listener context to be removed

Returns:

PIXI.ticker.Ticker


start(): void

core\ticker\Ticker.js, line 308

Starts the ticker. If the ticker has listeners
a new animation frame is requested at this point.

Returns:

void


stop(): void

core\ticker\Ticker.js, line 321

Stops the ticker. If the ticker has requested
an animation frame it is canceled at this point.

Returns:

void


destroy(): void

core\ticker\Ticker.js, line 334

Destroy the ticker and don't use after this. Calling
this method removes all references to internal events.

Returns:

void


update(currentTime: number): void

core\ticker\Ticker.js, line 362

Triggers an update. An update entails setting the
current {@link PIXI.ticker.Ticker#elapsedMS},
the current {@link PIXI.ticker.Ticker#deltaTime},
invoking all listeners with current deltaTime,
and then finally setting {@link PIXI.ticker.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.

Params:

Name Type Attribute Description
currentTime

the current time of execution

Returns:

void


FPS(): void

core\ticker\Ticker.js, line 425

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.Ticker#speed}, which is specific
to scaling {@link PIXI.ticker.Ticker#deltaTime}.

Returns:

void


minFPS(): void

core\ticker\Ticker.js, line 441

Manages the maximum amount of milliseconds allowed to
elapse between invoking {@link PIXI.ticker.Ticker#update}.
This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.

Returns:

void


  {
    "comment": "/**\n * A Ticker class that runs an update loop that other objects listen to.\n * This class is composed around listeners\n * meant for execution on the next requested animation frame.\n * Animation frames are requested only when necessary,\n * e.g. When the ticker is started and the emitter has listeners.\n *\n * @class\n * @memberof PIXI.ticker\n */",
    "meta": {
        "range": [
            497,
            14257
        ],
        "filename": "Ticker.js",
        "lineno": 17,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker",
        "code": {
            "id": "astnode100046076",
            "name": "Ticker",
            "type": "ClassDeclaration",
            "paramnames": []
        }
    },
    "classdesc": "

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.

", "kind": "class", "memberof": "PIXI.ticker", "name": "Ticker", "longname": "PIXI.ticker.Ticker", "scope": "static", "params": [], "___id": "T000002R004212", "___s": true, "$methods": [ { "comment": "/**\n * Conditionally requests a new animation frame.\n * If a frame has not already been requested, and if the internal\n * emitter has listeners, a new frame is requested.\n *\n * @private\n */", "meta": { "range": [ 4879, 5148 ], "filename": "Ticker.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046197", "name": "Ticker#_requestIfNeeded", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "name": "_requestIfNeeded", "longname": "PIXI.ticker.Ticker#_requestIfNeeded", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004232", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_requestIfNeeded", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Conditionally cancels a pending animation frame.\n *\n * @private\n */", "meta": { "range": [ 5249, 5423 ], "filename": "Ticker.js", "lineno": 165, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046233", "name": "Ticker#_cancelIfNeeded", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Conditionally cancels a pending animation frame.

", "access": "private", "name": "_cancelIfNeeded", "longname": "PIXI.ticker.Ticker#_cancelIfNeeded", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004235", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_cancelIfNeeded", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Conditionally requests a new animation frame.\n * If the ticker has been started it checks if a frame has not already\n * been requested, and if the internal emitter has listeners. If these\n * conditions are met, a new frame is requested. If the ticker has not\n * been started, but autoStart is `true`, then the ticker starts now,\n * and continues with the previous conditions to request a new frame.\n *\n * @private\n */", "meta": { "range": [ 5894, 6086 ], "filename": "Ticker.js", "lineno": 184, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046256", "name": "Ticker#_startIfPossible", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "name": "_startIfPossible", "longname": "PIXI.ticker.Ticker#_startIfPossible", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004237", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_startIfPossible", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Register a handler for tick events. Calls continuously unless\n * it is removed or the ticker is stopped.\n *\n * @param {Function} fn - The listener function to be added for updates\n * @param {Function} [context] - The listener context\n * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 6518, 6658 ], "filename": "Ticker.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046280", "name": "Ticker#add", "type": "MethodDefinition", "paramnames": [ "fn", "context", "priority" ] }, "vars": { "": null } }, "description": "

Register a handler for tick events. Calls continuously unless
it is removed or the ticker is stopped.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be added for updates

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context

", "name": "context" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.UPDATE_PRIORITY.NORMAL", "description": "

The priority for emitting

", "name": "priority" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "add", "longname": "PIXI.ticker.Ticker#add", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R004238", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickeradd", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Add a handler for the tick event which is only execute once.\n *\n * @param {Function} fn - The listener function to be added for one update\n * @param {Function} [context] - The listener context\n * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 7045, 7195 ], "filename": "Ticker.js", "lineno": 218, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046301", "name": "Ticker#addOnce", "type": "MethodDefinition", "paramnames": [ "fn", "context", "priority" ] }, "vars": { "": null } }, "description": "

Add a handler for the tick event which is only execute once.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be added for one update

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context

", "name": "context" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.UPDATE_PRIORITY.NORMAL", "description": "

The priority for emitting

", "name": "priority" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "addOnce", "longname": "PIXI.ticker.Ticker#addOnce", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R004239", "___s": true, "skip": true, "slug": "PIXI.ticker.TickeraddOnce", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Internally adds the event handler so that it can be sorted by priority.\n * Priority allows certain handler (user, AnimatedSprite, Interaction) to be run\n * before the rendering.\n *\n * @private\n * @param {TickerListener} listener - Current listener being added.\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 7568, 8405 ], "filename": "Ticker.js", "lineno": 232, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046323", "name": "Ticker#_addListener", "type": "MethodDefinition", "paramnames": [ "listener" ] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "params": [ { "type": { "names": [ "TickerListener" ] }, "description": "

Current listener being added.

", "name": "listener" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "_addListener", "longname": "PIXI.ticker.Ticker#_addListener", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R004240", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_addListener", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Removes any handlers matching the function and context parameters.\n * If no handlers are left after removing, then it cancels the animation frame.\n *\n * @param {Function} fn - The listener function to be removed\n * @param {Function} [context] - The listener context to be removed\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 8793, 9381 ], "filename": "Ticker.js", "lineno": 277, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046401", "name": "Ticker#remove", "type": "MethodDefinition", "paramnames": [ "fn", "context" ] }, "vars": { "": null } }, "description": "

Removes any handlers matching the function and context parameters.
If no handlers are left after removing, then it cancels the animation frame.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be removed

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context to be removed

", "name": "context" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "remove", "longname": "PIXI.ticker.Ticker#remove", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R004245", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerremove", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Starts the ticker. If the ticker has listeners\n * a new animation frame is requested at this point.\n */", "meta": { "range": [ 9514, 9650 ], "filename": "Ticker.js", "lineno": 308, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046455", "name": "Ticker#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts the ticker. If the ticker has listeners
a new animation frame is requested at this point.

", "name": "start", "longname": "PIXI.ticker.Ticker#start", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004249", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstart", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Stops the ticker. If the ticker has requested\n * an animation frame it is canceled at this point.\n */", "meta": { "range": [ 9781, 9915 ], "filename": "Ticker.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046476", "name": "Ticker#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops the ticker. If the ticker has requested
an animation frame it is canceled at this point.

", "name": "stop", "longname": "PIXI.ticker.Ticker#stop", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004251", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstop", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Destroy the ticker and don't use after this. Calling\n * this method removes all references to internal events.\n */", "meta": { "range": [ 10059, 10293 ], "filename": "Ticker.js", "lineno": 334, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046496", "name": "Ticker#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroy the ticker and don't use after this. Calling
this method removes all references to internal events.

", "name": "destroy", "longname": "PIXI.ticker.Ticker#destroy", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004253", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerdestroy", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Triggers an update. An update entails setting the\n * current {@link PIXI.ticker.Ticker#elapsedMS},\n * the current {@link PIXI.ticker.Ticker#deltaTime},\n * invoking all listeners with current deltaTime,\n * and then finally setting {@link PIXI.ticker.Ticker#lastTime}\n * with the value of currentTime that was provided.\n * This method will be called automatically by animation\n * frame callbacks if the ticker instance has been started\n * and listeners are added.\n *\n * @param {number} [currentTime=performance.now()] - the current time of execution\n */", "meta": { "range": [ 10910, 13067 ], "filename": "Ticker.js", "lineno": 362, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046537", "name": "Ticker#update", "type": "MethodDefinition", "paramnames": [ "currentTime" ] }, "vars": { "": null } }, "description": "

Triggers an update. An update entails setting the
current {@link PIXI.ticker.Ticker#elapsedMS},
the current {@link PIXI.ticker.Ticker#deltaTime},
invoking all listeners with current deltaTime,
and then finally setting {@link PIXI.ticker.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.

", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "performance.now()", "description": "

the current time of execution

", "name": "currentTime" } ], "name": "update", "longname": "PIXI.ticker.Ticker#update", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R004257", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerupdate", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * The frames per second at which this ticker is running.\n * The default is approximately 60 in most modern browsers.\n * **Note:** This does not factor in the value of\n * {@link PIXI.ticker.Ticker#speed}, which is specific\n * to scaling {@link PIXI.ticker.Ticker#deltaTime}.\n *\n * @member {number}\n * @readonly\n */", "meta": { "range": [ 13432, 13491 ], "filename": "Ticker.js", "lineno": 425, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046647", "name": "Ticker#FPS", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.Ticker#speed}, which is specific
to scaling {@link PIXI.ticker.Ticker#deltaTime}.

", "kind": "member", "type": { "names": [ "number" ] }, "readonly": true, "name": "FPS", "longname": "PIXI.ticker.Ticker#FPS", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004268", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerFPS", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Manages the maximum amount of milliseconds allowed to\n * elapse between invoking {@link PIXI.ticker.Ticker#update}.\n * This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},\n * but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.\n * When setting this property it is clamped to a value between\n * `0` and `PIXI.settings.TARGET_FPMS * 1000`.\n *\n * @member {number}\n * @default 10\n */", "meta": { "range": [ 13960, 14026 ], "filename": "Ticker.js", "lineno": 441, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100046657", "name": "Ticker#minFPS", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Manages the maximum amount of milliseconds allowed to
elapse between invoking {@link PIXI.ticker.Ticker#update}.
This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.

", "kind": "member", "type": { "names": [ "number" ] }, "defaultvalue": "10", "name": "minFPS", "longname": "PIXI.ticker.Ticker#minFPS", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R004269", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerminFPS", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Conditionally requests a new animation frame.\n * If a frame has not already been requested, and if the internal\n * emitter has listeners, a new frame is requested.\n *\n * @private\n */", "meta": { "range": [ 4879, 5148 ], "filename": "Ticker.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100120876", "name": "Ticker#_requestIfNeeded", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "name": "_requestIfNeeded", "longname": "PIXI.ticker.Ticker#_requestIfNeeded", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011166", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_requestIfNeeded", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Conditionally cancels a pending animation frame.\n *\n * @private\n */", "meta": { "range": [ 5249, 5423 ], "filename": "Ticker.js", "lineno": 165, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100120912", "name": "Ticker#_cancelIfNeeded", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Conditionally cancels a pending animation frame.

", "access": "private", "name": "_cancelIfNeeded", "longname": "PIXI.ticker.Ticker#_cancelIfNeeded", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011169", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_cancelIfNeeded", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Conditionally requests a new animation frame.\n * If the ticker has been started it checks if a frame has not already\n * been requested, and if the internal emitter has listeners. If these\n * conditions are met, a new frame is requested. If the ticker has not\n * been started, but autoStart is `true`, then the ticker starts now,\n * and continues with the previous conditions to request a new frame.\n *\n * @private\n */", "meta": { "range": [ 5894, 6086 ], "filename": "Ticker.js", "lineno": 184, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100120935", "name": "Ticker#_startIfPossible", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "name": "_startIfPossible", "longname": "PIXI.ticker.Ticker#_startIfPossible", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011171", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_startIfPossible", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Register a handler for tick events. Calls continuously unless\n * it is removed or the ticker is stopped.\n *\n * @param {Function} fn - The listener function to be added for updates\n * @param {Function} [context] - The listener context\n * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 6518, 6658 ], "filename": "Ticker.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100120959", "name": "Ticker#add", "type": "MethodDefinition", "paramnames": [ "fn", "context", "priority" ] }, "vars": { "": null } }, "description": "

Register a handler for tick events. Calls continuously unless
it is removed or the ticker is stopped.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be added for updates

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context

", "name": "context" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.UPDATE_PRIORITY.NORMAL", "description": "

The priority for emitting

", "name": "priority" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "add", "longname": "PIXI.ticker.Ticker#add", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R011172", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickeradd", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Add a handler for the tick event which is only execute once.\n *\n * @param {Function} fn - The listener function to be added for one update\n * @param {Function} [context] - The listener context\n * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 7045, 7195 ], "filename": "Ticker.js", "lineno": 218, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100120980", "name": "Ticker#addOnce", "type": "MethodDefinition", "paramnames": [ "fn", "context", "priority" ] }, "vars": { "": null } }, "description": "

Add a handler for the tick event which is only execute once.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be added for one update

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context

", "name": "context" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.UPDATE_PRIORITY.NORMAL", "description": "

The priority for emitting

", "name": "priority" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "addOnce", "longname": "PIXI.ticker.Ticker#addOnce", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R011173", "___s": true, "skip": true, "slug": "PIXI.ticker.TickeraddOnce", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Internally adds the event handler so that it can be sorted by priority.\n * Priority allows certain handler (user, AnimatedSprite, Interaction) to be run\n * before the rendering.\n *\n * @private\n * @param {TickerListener} listener - Current listener being added.\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 7568, 8405 ], "filename": "Ticker.js", "lineno": 232, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121002", "name": "Ticker#_addListener", "type": "MethodDefinition", "paramnames": [ "listener" ] }, "vars": { "": null } }, "description": "

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.

", "access": "private", "params": [ { "type": { "names": [ "TickerListener" ] }, "description": "

Current listener being added.

", "name": "listener" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "_addListener", "longname": "PIXI.ticker.Ticker#_addListener", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R011174", "___s": true, "skip": true, "slug": "PIXI.ticker.Ticker_addListener", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Removes any handlers matching the function and context parameters.\n * If no handlers are left after removing, then it cancels the animation frame.\n *\n * @param {Function} fn - The listener function to be removed\n * @param {Function} [context] - The listener context to be removed\n * @returns {PIXI.ticker.Ticker} This instance of a ticker\n */", "meta": { "range": [ 8793, 9381 ], "filename": "Ticker.js", "lineno": 277, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121080", "name": "Ticker#remove", "type": "MethodDefinition", "paramnames": [ "fn", "context" ] }, "vars": { "": null } }, "description": "

Removes any handlers matching the function and context parameters.
If no handlers are left after removing, then it cancels the animation frame.

", "params": [ { "type": { "names": [ "function" ] }, "description": "

The listener function to be removed

", "name": "fn" }, { "type": { "names": [ "function" ] }, "optional": true, "description": "

The listener context to be removed

", "name": "context" } ], "returns": [ { "type": { "names": [ "PIXI.ticker.Ticker" ] }, "description": "

This instance of a ticker

" } ], "name": "remove", "longname": "PIXI.ticker.Ticker#remove", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R011179", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerremove", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Starts the ticker. If the ticker has listeners\n * a new animation frame is requested at this point.\n */", "meta": { "range": [ 9514, 9650 ], "filename": "Ticker.js", "lineno": 308, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121134", "name": "Ticker#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts the ticker. If the ticker has listeners
a new animation frame is requested at this point.

", "name": "start", "longname": "PIXI.ticker.Ticker#start", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011183", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstart", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Stops the ticker. If the ticker has requested\n * an animation frame it is canceled at this point.\n */", "meta": { "range": [ 9781, 9915 ], "filename": "Ticker.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121155", "name": "Ticker#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops the ticker. If the ticker has requested
an animation frame it is canceled at this point.

", "name": "stop", "longname": "PIXI.ticker.Ticker#stop", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011185", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstop", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Destroy the ticker and don't use after this. Calling\n * this method removes all references to internal events.\n */", "meta": { "range": [ 10059, 10293 ], "filename": "Ticker.js", "lineno": 334, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121175", "name": "Ticker#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroy the ticker and don't use after this. Calling
this method removes all references to internal events.

", "name": "destroy", "longname": "PIXI.ticker.Ticker#destroy", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011187", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerdestroy", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Triggers an update. An update entails setting the\n * current {@link PIXI.ticker.Ticker#elapsedMS},\n * the current {@link PIXI.ticker.Ticker#deltaTime},\n * invoking all listeners with current deltaTime,\n * and then finally setting {@link PIXI.ticker.Ticker#lastTime}\n * with the value of currentTime that was provided.\n * This method will be called automatically by animation\n * frame callbacks if the ticker instance has been started\n * and listeners are added.\n *\n * @param {number} [currentTime=performance.now()] - the current time of execution\n */", "meta": { "range": [ 10910, 13067 ], "filename": "Ticker.js", "lineno": 362, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121216", "name": "Ticker#update", "type": "MethodDefinition", "paramnames": [ "currentTime" ] }, "vars": { "": null } }, "description": "

Triggers an update. An update entails setting the
current {@link PIXI.ticker.Ticker#elapsedMS},
the current {@link PIXI.ticker.Ticker#deltaTime},
invoking all listeners with current deltaTime,
and then finally setting {@link PIXI.ticker.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.

", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "performance.now()", "description": "

the current time of execution

", "name": "currentTime" } ], "name": "update", "longname": "PIXI.ticker.Ticker#update", "kind": "function", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "___id": "T000002R011191", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerupdate", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * The frames per second at which this ticker is running.\n * The default is approximately 60 in most modern browsers.\n * **Note:** This does not factor in the value of\n * {@link PIXI.ticker.Ticker#speed}, which is specific\n * to scaling {@link PIXI.ticker.Ticker#deltaTime}.\n *\n * @member {number}\n * @readonly\n */", "meta": { "range": [ 13432, 13491 ], "filename": "Ticker.js", "lineno": 425, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121326", "name": "Ticker#FPS", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.Ticker#speed}, which is specific
to scaling {@link PIXI.ticker.Ticker#deltaTime}.

", "kind": "member", "type": { "names": [ "number" ] }, "readonly": true, "name": "FPS", "longname": "PIXI.ticker.Ticker#FPS", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011202", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerFPS", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Manages the maximum amount of milliseconds allowed to\n * elapse between invoking {@link PIXI.ticker.Ticker#update}.\n * This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},\n * but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.\n * When setting this property it is clamped to a value between\n * `0` and `PIXI.settings.TARGET_FPMS * 1000`.\n *\n * @member {number}\n * @default 10\n */", "meta": { "range": [ 13960, 14026 ], "filename": "Ticker.js", "lineno": 441, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": { "id": "astnode100121336", "name": "Ticker#minFPS", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Manages the maximum amount of milliseconds allowed to
elapse between invoking {@link PIXI.ticker.Ticker#update}.
This value is used to cap {@link PIXI.ticker.Ticker#deltaTime},
but does not effect the measured value of {@link PIXI.ticker.Ticker#FPS}.
When setting this property it is clamped to a value between
0 and PIXI.settings.TARGET_FPMS * 1000.

", "kind": "member", "type": { "names": [ "number" ] }, "defaultvalue": "10", "name": "minFPS", "longname": "PIXI.ticker.Ticker#minFPS", "memberof": "PIXI.ticker.Ticker", "scope": "instance", "params": [], "___id": "T000002R011203", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerminFPS", "filepath": "core\\ticker\\Ticker.js" } ], "$attributes": [ { "comment": "/**\n * Whether or not this ticker should invoke the method\n * {@link PIXI.ticker.Ticker#start} automatically\n * when a listener is added.\n *\n * @member {boolean} PIXI.ticker.Ticker#autoStart\n * @default false\n */", "meta": { "range": [ 1127, 1395 ], "filename": "Ticker.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Whether or not this ticker should invoke the method
{@link PIXI.ticker.Ticker#start} automatically
when a listener is added.

", "kind": "member", "name": "autoStart", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#autoStart", "scope": "instance", "___id": "T000002R004217", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerautoStart", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Scalar time value from last frame to this frame.\n * This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}\n * and is scaled with {@link PIXI.ticker.Ticker#speed}.\n * **Note:** The cap may be exceeded by scaling.\n *\n * @member {number} PIXI.ticker.Ticker#deltaTime\n * @default 1\n */", "meta": { "range": [ 1437, 1800 ], "filename": "Ticker.js", "lineno": 54, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Scalar time value from last frame to this frame.
This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}
and is scaled with {@link PIXI.ticker.Ticker#speed}.
Note: The cap may be exceeded by scaling.

", "kind": "member", "name": "deltaTime", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#deltaTime", "scope": "instance", "___id": "T000002R004219", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerdeltaTime", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Time elapsed in milliseconds from last frame to this frame.\n * Opposed to what the scalar {@link PIXI.ticker.Ticker#deltaTime}\n * is based, this value is neither capped nor scaled.\n * If the platform supports DOMHighResTimeStamp,\n * this value will have a precision of 1 µs.\n * Defaults to target frame time\n *\n * @member {number} PIXI.ticker.Ticker#elapsedMS\n * @default 16.66\n */", "meta": { "range": [ 1838, 2306 ], "filename": "Ticker.js", "lineno": 65, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Time elapsed in milliseconds from last frame to this frame.
Opposed to what the scalar {@link PIXI.ticker.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

", "kind": "member", "name": "elapsedMS", "type": { "names": [ "number" ] }, "defaultvalue": "16.66", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#elapsedMS", "scope": "instance", "___id": "T000002R004221", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerelapsedMS", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * The last time {@link PIXI.ticker.Ticker#update} was invoked.\n * This value is also reset internally outside of invoking\n * update, but only when a new animation frame is requested.\n * If the platform supports DOMHighResTimeStamp,\n * this value will have a precision of 1 µs.\n *\n * @member {number} PIXI.ticker.Ticker#lastTime\n * @default 0\n */", "meta": { "range": [ 2367, 2789 ], "filename": "Ticker.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

The last time {@link PIXI.ticker.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.

", "kind": "member", "name": "lastTime", "type": { "names": [ "number" ] }, "defaultvalue": "0", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#lastTime", "scope": "instance", "___id": "T000002R004223", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerlastTime", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Factor of current {@link PIXI.ticker.Ticker#deltaTime}.\n * @example\n * // Scales ticker.deltaTime to what would be\n * // the equivalent of approximately 120 FPS\n * ticker.speed = 2;\n *\n * @member {number} PIXI.ticker.Ticker#speed\n * @default 1\n */", "meta": { "range": [ 2826, 3152 ], "filename": "Ticker.js", "lineno": 90, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Factor of current {@link PIXI.ticker.Ticker#deltaTime}.

", "examples": [ "// Scales ticker.deltaTime to what would be\n// the equivalent of approximately 120 FPS\nticker.speed = 2;" ], "kind": "member", "name": "speed", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#speed", "scope": "instance", "___id": "T000002R004225", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerspeed", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Whether or not this ticker has been started.\n * `true` if {@link PIXI.ticker.Ticker#start} has been called.\n * `false` if {@link PIXI.ticker.Ticker#stop} has been called.\n * While `false`, this value may change to `true` in the\n * event of {@link PIXI.ticker.Ticker#autoStart} being `true`\n * and a listener is added.\n *\n * @member {boolean} PIXI.ticker.Ticker#started\n * @default false\n */", "meta": { "range": [ 3186, 3663 ], "filename": "Ticker.js", "lineno": 102, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Whether or not this ticker has been started.
true if {@link PIXI.ticker.Ticker#start} has been called.
false if {@link PIXI.ticker.Ticker#stop} has been called.
While false, this value may change to true in the
event of {@link PIXI.ticker.Ticker#autoStart} being true
and a listener is added.

", "kind": "member", "name": "started", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#started", "scope": "instance", "___id": "T000002R004227", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstarted", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Whether or not this ticker should invoke the method\n * {@link PIXI.ticker.Ticker#start} automatically\n * when a listener is added.\n *\n * @member {boolean} PIXI.ticker.Ticker#autoStart\n * @default false\n */", "meta": { "range": [ 1127, 1395 ], "filename": "Ticker.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Whether or not this ticker should invoke the method
{@link PIXI.ticker.Ticker#start} automatically
when a listener is added.

", "kind": "member", "name": "autoStart", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#autoStart", "scope": "instance", "___id": "T000002R011151", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerautoStart", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Scalar time value from last frame to this frame.\n * This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}\n * and is scaled with {@link PIXI.ticker.Ticker#speed}.\n * **Note:** The cap may be exceeded by scaling.\n *\n * @member {number} PIXI.ticker.Ticker#deltaTime\n * @default 1\n */", "meta": { "range": [ 1437, 1800 ], "filename": "Ticker.js", "lineno": 54, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Scalar time value from last frame to this frame.
This value is capped by setting {@link PIXI.ticker.Ticker#minFPS}
and is scaled with {@link PIXI.ticker.Ticker#speed}.
Note: The cap may be exceeded by scaling.

", "kind": "member", "name": "deltaTime", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#deltaTime", "scope": "instance", "___id": "T000002R011153", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerdeltaTime", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Time elapsed in milliseconds from last frame to this frame.\n * Opposed to what the scalar {@link PIXI.ticker.Ticker#deltaTime}\n * is based, this value is neither capped nor scaled.\n * If the platform supports DOMHighResTimeStamp,\n * this value will have a precision of 1 µs.\n * Defaults to target frame time\n *\n * @member {number} PIXI.ticker.Ticker#elapsedMS\n * @default 16.66\n */", "meta": { "range": [ 1838, 2306 ], "filename": "Ticker.js", "lineno": 65, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Time elapsed in milliseconds from last frame to this frame.
Opposed to what the scalar {@link PIXI.ticker.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

", "kind": "member", "name": "elapsedMS", "type": { "names": [ "number" ] }, "defaultvalue": "16.66", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#elapsedMS", "scope": "instance", "___id": "T000002R011155", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerelapsedMS", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * The last time {@link PIXI.ticker.Ticker#update} was invoked.\n * This value is also reset internally outside of invoking\n * update, but only when a new animation frame is requested.\n * If the platform supports DOMHighResTimeStamp,\n * this value will have a precision of 1 µs.\n *\n * @member {number} PIXI.ticker.Ticker#lastTime\n * @default 0\n */", "meta": { "range": [ 2367, 2789 ], "filename": "Ticker.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

The last time {@link PIXI.ticker.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.

", "kind": "member", "name": "lastTime", "type": { "names": [ "number" ] }, "defaultvalue": "0", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#lastTime", "scope": "instance", "___id": "T000002R011157", "___s": true, "skip": true, "slug": "PIXI.ticker.TickerlastTime", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Factor of current {@link PIXI.ticker.Ticker#deltaTime}.\n * @example\n * // Scales ticker.deltaTime to what would be\n * // the equivalent of approximately 120 FPS\n * ticker.speed = 2;\n *\n * @member {number} PIXI.ticker.Ticker#speed\n * @default 1\n */", "meta": { "range": [ 2826, 3152 ], "filename": "Ticker.js", "lineno": 90, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Factor of current {@link PIXI.ticker.Ticker#deltaTime}.

", "examples": [ "// Scales ticker.deltaTime to what would be\n// the equivalent of approximately 120 FPS\nticker.speed = 2;" ], "kind": "member", "name": "speed", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#speed", "scope": "instance", "___id": "T000002R011159", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerspeed", "filepath": "core\\ticker\\Ticker.js" }, { "comment": "/**\n * Whether or not this ticker has been started.\n * `true` if {@link PIXI.ticker.Ticker#start} has been called.\n * `false` if {@link PIXI.ticker.Ticker#stop} has been called.\n * While `false`, this value may change to `true` in the\n * event of {@link PIXI.ticker.Ticker#autoStart} being `true`\n * and a listener is added.\n *\n * @member {boolean} PIXI.ticker.Ticker#started\n * @default false\n */", "meta": { "range": [ 3186, 3663 ], "filename": "Ticker.js", "lineno": 102, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\ticker", "code": {} }, "description": "

Whether or not this ticker has been started.
true if {@link PIXI.ticker.Ticker#start} has been called.
false if {@link PIXI.ticker.Ticker#stop} has been called.
While false, this value may change to true in the
event of {@link PIXI.ticker.Ticker#autoStart} being true
and a listener is added.

", "kind": "member", "name": "started", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.ticker.Ticker", "longname": "PIXI.ticker.Ticker#started", "scope": "instance", "___id": "T000002R011161", "___s": true, "skip": true, "slug": "PIXI.ticker.Tickerstarted", "filepath": "core\\ticker\\Ticker.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [], "$augmentedBy": [], "filepath": "core\\ticker\\Ticker.js" }