Home

class: TimeLimiter

TimeLimiter limits the number of items handled by a {@link PIXI.BasePrepare} to a specified
number of milliseconds per frame.

Methods summary

Public methods
public	beginFrame(): void
public	allowedToUpload(): boolean
public	beginFrame(): void
public	allowedToUpload(): boolean

Methods

beginFrame(): void

prepare\limiters\TimeLimiter.js, line 33

Resets any counting properties to start fresh on a new frame.

Returns:

void

allowedToUpload(): boolean

prepare\limiters\TimeLimiter.js, line 42

Checks to see if another item can be uploaded. This should only be called once per item.

Returns:

boolean

beginFrame(): void

prepare\limiters\TimeLimiter.js, line 33

Resets any counting properties to start fresh on a new frame.

Returns:

void

allowedToUpload(): boolean

prepare\limiters\TimeLimiter.js, line 42

Checks to see if another item can be uploaded. This should only be called once per item.

Returns:

boolean

{ "comment": "/**\n * TimeLimiter limits the number of items handled by a {@link PIXI.BasePrepare} to a specified\n * number of milliseconds per frame.\n *\n * @class\n * @memberof PIXI\n */", "meta": { "range": [ 200, 1147 ], "filename": "TimeLimiter.js", "lineno": 10, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters", "code": { "id": "astnode100074466", "name": "TimeLimiter", "type": "ClassDeclaration", "paramnames": [ "maxMilliseconds" ] } }, "classdesc": "

TimeLimiter limits the number of items handled by a {@link PIXI.BasePrepare} to a specified
number of milliseconds per frame.

", "kind": "class", "memberof": "PIXI", "name": "TimeLimiter", "longname": "PIXI.TimeLimiter", "scope": "static", "params": [ { "type": { "names": [ "number" ] }, "description": "

The maximum milliseconds that can be spent preparing items each frame.

", "name": "maxMilliseconds" } ], "___id": "T000002R006922", "___s": true, "$methods": [ { "comment": "/**\n * Resets any counting properties to start fresh on a new frame.\n */", "meta": { "range": [ 804, 866 ], "filename": "TimeLimiter.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters", "code": { "id": "astnode100074486", "name": "TimeLimiter#beginFrame", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Resets any counting properties to start fresh on a new frame.

", "name": "beginFrame", "longname": "PIXI.TimeLimiter#beginFrame", "kind": "function", "memberof": "PIXI.TimeLimiter", "scope": "instance", "params": [], "___id": "T000002R006926", "___s": true, "skip": true, "slug": "PIXI.TimeLimiterbeginFrame", "filepath": "prepare\\limiters\\TimeLimiter.js" }, { "comment": "/**\n * Checks to see if another item can be uploaded. This should only be called once per item.\n * @return {boolean} If the item is allowed to be uploaded.\n */", "meta": { "range": [ 1048, 1145 ], "filename": "TimeLimiter.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters", "code": { "id": "astnode100074499", "name": "TimeLimiter#allowedToUpload", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Checks to see if another item can be uploaded. This should only be called once per item.

", "returns": [ { "type": { "names": [ "boolean" ] }, "description": "

If the item is allowed to be uploaded.

" } ], "name": "allowedToUpload", "longname": "PIXI.TimeLimiter#allowedToUpload", "kind": "function", "memberof": "PIXI.TimeLimiter", "scope": "instance", "params": [], "___id": "T000002R006928", "___s": true, "skip": true, "slug": "PIXI.TimeLimiterallowedToUpload", "filepath": "prepare\\limiters\\TimeLimiter.js" }, { "comment": "/**\n * Resets any counting properties to start fresh on a new frame.\n */", "meta": { "range": [ 804, 866 ], "filename": "TimeLimiter.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters", "code": { "id": "astnode100149165", "name": "TimeLimiter#beginFrame", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Resets any counting properties to start fresh on a new frame.

", "name": "beginFrame", "longname": "PIXI.TimeLimiter#beginFrame", "kind": "function", "memberof": "PIXI.TimeLimiter", "scope": "instance", "params": [], "___id": "T000002R013860", "___s": true, "skip": true, "slug": "PIXI.TimeLimiterbeginFrame", "filepath": "prepare\\limiters\\TimeLimiter.js" }, { "comment": "/**\n * Checks to see if another item can be uploaded. This should only be called once per item.\n * @return {boolean} If the item is allowed to be uploaded.\n */", "meta": { "range": [ 1048, 1145 ], "filename": "TimeLimiter.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters", "code": { "id": "astnode100149178", "name": "TimeLimiter#allowedToUpload", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Checks to see if another item can be uploaded. This should only be called once per item.

", "returns": [ { "type": { "names": [ "boolean" ] }, "description": "

If the item is allowed to be uploaded.