Base for a common object renderer that can be used as a system renderer plugin.
| Public methods | |
|---|---|
| public | start(): void |
| public | stop(): void |
| public | flush(): void |
| public | render(object: PIXI.DisplayObject): void |
| public | start(): void |
| public | stop(): void |
| public | flush(): void |
| public | render(object: PIXI.DisplayObject): void |
| public | onContextChange(): void |
| public | destroy(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderer | PIXI.WebGLRenderer | public | The renderer this manager works for. |
Starts the renderer and sets the shader
void
Stops the renderer
void
Stub method for rendering content and emptying the current batch.
void
Renders an object
| Name | Type | Attribute | Description |
|---|---|---|---|
| object | The object to render. |
void
Starts the renderer and sets the shader
void
Stops the renderer
void
Stub method for rendering content and emptying the current batch.
void
Renders an object
| Name | Type | Attribute | Description |
|---|---|---|---|
| object | The object to render. |
void
Generic method called when there is a WebGL context change.
void
Generic destroy methods to be overridden by the subclass
void
{
"comment": "/**\n * Base for a common object renderer that can be used as a system renderer plugin.\n *\n * @class\n * @extends PIXI.WebGLManager\n * @memberof PIXI\n */",
"meta": {
"range": [
238,
852
],
"filename": "ObjectRenderer.js",
"lineno": 12,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100028384",
"name": "ObjectRenderer",
"type": "ClassDeclaration",
"paramnames": []
}
},
"classdesc": "Base for a common object renderer that can be used as a system renderer plugin.
",
"kind": "class",
"augments": [
"PIXI.WebGLManager"
],
"memberof": "PIXI",
"name": "ObjectRenderer",
"longname": "PIXI.ObjectRenderer",
"scope": "static",
"___id": "T000002R002604",
"___s": true,
"$methods": [
{
"comment": "/**\n * Starts the renderer and sets the shader\n *\n */",
"meta": {
"range": [
356,
403
],
"filename": "ObjectRenderer.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100028388",
"name": "ObjectRenderer#start",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Starts the renderer and sets the shader
",
"name": "start",
"longname": "PIXI.ObjectRenderer#start",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002605",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererstart",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Stops the renderer\n *\n */",
"meta": {
"range": [
458,
498
],
"filename": "ObjectRenderer.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100028392",
"name": "ObjectRenderer#stop",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Stops the renderer
",
"name": "stop",
"longname": "PIXI.ObjectRenderer#stop",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002606",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererstop",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Stub method for rendering content and emptying the current batch.\n *\n */",
"meta": {
"range": [
600,
637
],
"filename": "ObjectRenderer.js",
"lineno": 36,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100028401",
"name": "ObjectRenderer#flush",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Stub method for rendering content and emptying the current batch.
",
"name": "flush",
"longname": "PIXI.ObjectRenderer#flush",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002607",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererflush",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Renders an object\n *\n * @param {PIXI.DisplayObject} object - The object to render.\n */",
"meta": {
"range": [
757,
850
],
"filename": "ObjectRenderer.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100028405",
"name": "ObjectRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"object"
]
},
"vars": {
"": null
}
},
"description": "Renders an object
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The object to render.
",
"name": "object"
}
],
"name": "render",
"longname": "PIXI.ObjectRenderer#render",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"___id": "T000002R002608",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererrender",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Starts the renderer and sets the shader\n *\n */",
"meta": {
"range": [
356,
403
],
"filename": "ObjectRenderer.js",
"lineno": 18,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100103067",
"name": "ObjectRenderer#start",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Starts the renderer and sets the shader
",
"name": "start",
"longname": "PIXI.ObjectRenderer#start",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009539",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererstart",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Stops the renderer\n *\n */",
"meta": {
"range": [
458,
498
],
"filename": "ObjectRenderer.js",
"lineno": 27,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100103071",
"name": "ObjectRenderer#stop",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Stops the renderer
",
"name": "stop",
"longname": "PIXI.ObjectRenderer#stop",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009540",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererstop",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Stub method for rendering content and emptying the current batch.\n *\n */",
"meta": {
"range": [
600,
637
],
"filename": "ObjectRenderer.js",
"lineno": 36,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100103080",
"name": "ObjectRenderer#flush",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Stub method for rendering content and emptying the current batch.
",
"name": "flush",
"longname": "PIXI.ObjectRenderer#flush",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009541",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererflush",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Renders an object\n *\n * @param {PIXI.DisplayObject} object - The object to render.\n */",
"meta": {
"range": [
757,
850
],
"filename": "ObjectRenderer.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
"code": {
"id": "astnode100103084",
"name": "ObjectRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"object"
]
},
"vars": {
"": null
}
},
"description": "Renders an object
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The object to render.
",
"name": "object"
}
],
"name": "render",
"longname": "PIXI.ObjectRenderer#render",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"___id": "T000002R009542",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererrender",
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
},
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026924",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.ObjectRenderer#onContextChange",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.WebGLManager#onContextChange",
"inherited": true,
"overrides": "PIXI.WebGLManager#onContextChange",
"___id": "T000002R013957",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendereronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */",
"meta": {
"range": [
722,
840
],
"filename": "WebGLManager.js",
"lineno": 37,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026928",
"name": "WebGLManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic destroy methods to be overridden by the subclass
",
"name": "destroy",
"longname": "PIXI.ObjectRenderer#destroy",
"kind": "function",
"memberof": "PIXI.ObjectRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.WebGLManager#destroy",
"inherited": true,
"overrides": "PIXI.WebGLManager#destroy",
"___id": "T000002R013958",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererdestroy",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$attributes": [
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.ObjectRenderer",
"longname": "PIXI.ObjectRenderer#renderer",
"scope": "instance",
"inherits": "PIXI.WebGLManager#renderer",
"inherited": true,
"overrides": "PIXI.WebGLManager#renderer",
"___id": "T000002R013956",
"___s": true,
"skip": true,
"slug": "PIXI.ObjectRendererrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"comment": "/**\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
66,
842
],
"filename": "WebGLManager.js",
"lineno": 7,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026898",
"name": "WebGLManager",
"type": "ClassDeclaration",
"paramnames": [
"renderer"
]
}
},
"kind": "class",
"memberof": "PIXI",
"name": "WebGLManager",
"longname": "PIXI.WebGLManager",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "The renderer this manager works for.
",
"name": "renderer"
}
],
"___id": "T000002R002488",
"___s": true,
"$methods": [
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026924",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.WebGLManager#onContextChange",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R002492",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManageronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */",
"meta": {
"range": [
722,
840
],
"filename": "WebGLManager.js",
"lineno": 37,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026928",
"name": "WebGLManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic destroy methods to be overridden by the subclass
",
"name": "destroy",
"longname": "PIXI.WebGLManager#destroy",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R002493",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101603",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.WebGLManager#onContextChange",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R009426",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManageronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */",
"meta": {
"range": [
722,
840
],
"filename": "WebGLManager.js",
"lineno": 37,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101607",
"name": "WebGLManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic destroy methods to be overridden by the subclass
",
"name": "destroy",
"longname": "PIXI.WebGLManager#destroy",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R009427",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$attributes": [
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.WebGLManager",
"longname": "PIXI.WebGLManager#renderer",
"scope": "instance",
"___id": "T000002R002490",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.WebGLManager",
"longname": "PIXI.WebGLManager#renderer",
"scope": "instance",
"___id": "T000002R009424",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [
{
"name": "BlendModeManager"
},
{
"name": "FilterManager"
},
{
"name": "MaskManager"
},
{
"name": "StencilManager"
},
{
"name": "ObjectRenderer"
},
{
"name": "BlendModeManager"
},
{
"name": "FilterManager"
},
{
"name": "MaskManager"
},
{
"name": "StencilManager"
},
{
"name": "ObjectRenderer"
}
],
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$augmentedBy": [
{
"name": "GraphicsRenderer"
},
{
"name": "SpriteRenderer"
},
{
"name": "TilingSpriteRenderer"
},
{
"name": "MeshRenderer"
},
{
"name": "GraphicsRenderer"
},
{
"name": "SpriteRenderer"
},
{
"name": "TilingSpriteRenderer"
},
{
"name": "MeshRenderer"
}
],
"filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js"
}