CountLimiter limits the number of items handled by a {@link PIXI.prepare.BasePrepare} to a specified
number of items per frame.
| Public methods | |
|---|---|
| public | beginFrame(): void |
| public | allowedToUpload(): boolean |
| public | beginFrame(): void |
| public | allowedToUpload(): boolean |
Resets any counting properties to start fresh on a new frame.
void
Checks to see if another item can be uploaded. This should only be called once per item.
Resets any counting properties to start fresh on a new frame.
void
Checks to see if another item can be uploaded. This should only be called once per item.
{
"comment": "/**\n * CountLimiter limits the number of items handled by a {@link PIXI.prepare.BasePrepare} to a specified\n * number of items per frame.\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
203,
1139
],
"filename": "CountLimiter.js",
"lineno": 10,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters",
"code": {
"id": "astnode100074420",
"name": "CountLimiter",
"type": "ClassDeclaration",
"paramnames": [
"maxItemsPerFrame"
]
}
},
"classdesc": "CountLimiter limits the number of items handled by a {@link PIXI.prepare.BasePrepare} to a specified
number of items per frame.
",
"kind": "class",
"memberof": "PIXI",
"name": "CountLimiter",
"longname": "PIXI.CountLimiter",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The maximum number of items that can be prepared each frame.
",
"name": "maxItemsPerFrame"
}
],
"___id": "T000002R006914",
"___s": true,
"$methods": [
{
"comment": "/**\n * Resets any counting properties to start fresh on a new frame.\n */",
"meta": {
"range": [
817,
889
],
"filename": "CountLimiter.js",
"lineno": 33,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters",
"code": {
"id": "astnode100074440",
"name": "CountLimiter#beginFrame",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets any counting properties to start fresh on a new frame.
",
"name": "beginFrame",
"longname": "PIXI.CountLimiter#beginFrame",
"kind": "function",
"memberof": "PIXI.CountLimiter",
"scope": "instance",
"params": [],
"___id": "T000002R006918",
"___s": true,
"skip": true,
"slug": "PIXI.CountLimiterbeginFrame",
"filepath": "prepare\\limiters\\CountLimiter.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": [
1071,
1137
],
"filename": "CountLimiter.js",
"lineno": 42,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters",
"code": {
"id": "astnode100074452",
"name": "CountLimiter#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.CountLimiter#allowedToUpload",
"kind": "function",
"memberof": "PIXI.CountLimiter",
"scope": "instance",
"params": [],
"___id": "T000002R006920",
"___s": true,
"skip": true,
"slug": "PIXI.CountLimiterallowedToUpload",
"filepath": "prepare\\limiters\\CountLimiter.js"
},
{
"comment": "/**\n * Resets any counting properties to start fresh on a new frame.\n */",
"meta": {
"range": [
817,
889
],
"filename": "CountLimiter.js",
"lineno": 33,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters",
"code": {
"id": "astnode100149119",
"name": "CountLimiter#beginFrame",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets any counting properties to start fresh on a new frame.
",
"name": "beginFrame",
"longname": "PIXI.CountLimiter#beginFrame",
"kind": "function",
"memberof": "PIXI.CountLimiter",
"scope": "instance",
"params": [],
"___id": "T000002R013852",
"___s": true,
"skip": true,
"slug": "PIXI.CountLimiterbeginFrame",
"filepath": "prepare\\limiters\\CountLimiter.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": [
1071,
1137
],
"filename": "CountLimiter.js",
"lineno": 42,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\prepare\\limiters",
"code": {
"id": "astnode100149131",
"name": "CountLimiter#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.CountLimiter#allowedToUpload",
"kind": "function",
"memberof": "PIXI.CountLimiter",
"scope": "instance",
"params": [],
"___id": "T000002R013854",
"___s": true,
"skip": true,
"slug": "PIXI.CountLimiterallowedToUpload",
"filepath": "prepare\\limiters\\CountLimiter.js"
}
],
"$attributes": [],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "prepare\\limiters\\CountLimiter.js"
}