The SystemRenderer is the base for a Pixi Renderer. It is extended by the {@link PIXI.CanvasRenderer}
and {@link PIXI.WebGLRenderer} which can be used for rendering a Pixi scene.
| Public methods | |
|---|---|
| public | width(): void |
| public | height(): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | generateTexture(displayObject: PIXI.DisplayObject, scaleMode: number, resolution: number): PIXI.Texture |
| public | destroy(removeView: boolean): void |
| public | backgroundColor(): void |
| public | width(): void |
| public | height(): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | generateTexture(displayObject: PIXI.DisplayObject, scaleMode: number, resolution: number): PIXI.Texture |
| public | destroy(removeView: boolean): void |
| public | backgroundColor(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| options | Object | public | The supplied constructor options. |
| type | number | public | The type of the renderer. |
| screen | PIXI.Rectangle | public | Measurements of the screen. (0, 0, screenWidth, screenHeight) Its safe to use as filterArea or hitArea for whole stage |
| view | HTMLCanvasElement | public | The canvas element that everything is drawn to |
| resolution | number | public | The resolution / device pixel ratio of the renderer |
| transparent | boolean | public | Whether the render view is transparent |
| autoResize | boolean | public | Whether css dimensions of canvas view should be resized to screen dimensions automatically |
| blendModes | object.<string, mixed> | public | Tracks the blend modes useful for this renderer. |
| preserveDrawingBuffer | boolean | public | The value of the preserveDrawingBuffer flag affects whether or not the contents of |
| clearBeforeRender | boolean | public | This sets if the CanvasRenderer will clear the canvas or not before the new render pass. |
| roundPixels | boolean | public | If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation. |
| _backgroundColor | number | private | The background color as a number. |
| _backgroundColorRgba | Array.<number> | private | The background color as an [R, G, B] array. |
| _backgroundColorString | string | private | The background color as a string. |
| _tempDisplayObjectParent | PIXI.DisplayObject | private | This temporary display object used as the parent of the currently being rendered item |
| _lastObjectRendered | PIXI.DisplayObject | private | The last root object that the renderer tried to render. |
| options | Object | public | The supplied constructor options. |
| type | number | public | The type of the renderer. |
| screen | PIXI.Rectangle | public | Measurements of the screen. (0, 0, screenWidth, screenHeight) Its safe to use as filterArea or hitArea for whole stage |
| view | HTMLCanvasElement | public | The canvas element that everything is drawn to |
| resolution | number | public | The resolution / device pixel ratio of the renderer |
| transparent | boolean | public | Whether the render view is transparent |
| autoResize | boolean | public | Whether css dimensions of canvas view should be resized to screen dimensions automatically |
| blendModes | object.<string, mixed> | public | Tracks the blend modes useful for this renderer. |
| preserveDrawingBuffer | boolean | public | The value of the preserveDrawingBuffer flag affects whether or not the contents of |
| clearBeforeRender | boolean | public | This sets if the CanvasRenderer will clear the canvas or not before the new render pass. |
| roundPixels | boolean | public | If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation. |
| _backgroundColor | number | private | The background color as a number. |
| _backgroundColorRgba | Array.<number> | private | The background color as an [R, G, B] array. |
| _backgroundColorString | string | private | The background color as a string. |
| _tempDisplayObjectParent | PIXI.DisplayObject | private | This temporary display object used as the parent of the currently being rendered item |
| _lastObjectRendered | PIXI.DisplayObject | private | The last root object that the renderer tried to render. |
Same as view.width, actual number of pixels in the canvas by horizontal
void
Same as view.height, actual number of pixels in the canvas by vertical
void
Resizes the screen and canvas to the specified width and height
Canvas dimensions are multiplied by resolution
| Name | Type | Attribute | Description |
|---|---|---|---|
| screenWidth | the new width of the screen |
||
| screenHeight | the new height of the screen |
void
Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The displayObject the object will be generated from |
||
| scaleMode | Should be one of the scaleMode consts |
||
| resolution | The resolution / device pixel ratio of the texture being generated |
PIXI.Texture
Removes everything from the renderer and optionally removes the Canvas DOM element.
| Name | Type | Attribute | Description |
|---|---|---|---|
| removeView | Removes the Canvas element from the DOM. |
void
The background color to fill if not transparent
void
Same as view.width, actual number of pixels in the canvas by horizontal
void
Same as view.height, actual number of pixels in the canvas by vertical
void
Resizes the screen and canvas to the specified width and height
Canvas dimensions are multiplied by resolution
| Name | Type | Attribute | Description |
|---|---|---|---|
| screenWidth | the new width of the screen |
||
| screenHeight | the new height of the screen |
void
Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The displayObject the object will be generated from |
||
| scaleMode | Should be one of the scaleMode consts |
||
| resolution | The resolution / device pixel ratio of the texture being generated |
PIXI.Texture
Removes everything from the renderer and optionally removes the Canvas DOM element.
| Name | Type | Attribute | Description |
|---|---|---|---|
| removeView | Removes the Canvas element from the DOM. |
void
The background color to fill if not transparent
void
{
"comment": "/**\n * The SystemRenderer is the base for a Pixi Renderer. It is extended by the {@link PIXI.CanvasRenderer}\n * and {@link PIXI.WebGLRenderer} which can be used for rendering a Pixi scene.\n *\n * @abstract\n * @class\n * @extends EventEmitter\n * @memberof PIXI\n */",
"meta": {
"range": [
653,
10648
],
"filename": "SystemRenderer.js",
"lineno": 22,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100022705",
"name": "SystemRenderer",
"type": "ClassDeclaration",
"paramnames": [
"system",
"options",
"arg2",
"arg3"
]
}
},
"classdesc": "The SystemRenderer is the base for a Pixi Renderer. It is extended by the {@link PIXI.CanvasRenderer}
and {@link PIXI.WebGLRenderer} which can be used for rendering a Pixi scene.
",
"virtual": true,
"kind": "class",
"augments": [
"EventEmitter"
],
"memberof": "PIXI",
"name": "SystemRenderer",
"longname": "PIXI.SystemRenderer",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The name of the system this renderer is for.
",
"name": "system"
},
{
"type": {
"names": [
"object"
]
},
"optional": true,
"description": "The optional renderer parameters
",
"name": "options"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 800,
"description": "the width of the screen
",
"name": "options.width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 600,
"description": "the height of the screen
",
"name": "options.height"
},
{
"type": {
"names": [
"HTMLCanvasElement"
]
},
"optional": true,
"description": "the canvas to use as a view, optional
",
"name": "options.view"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "If the render view is transparent, default false
",
"name": "options.transparent"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "If the render view is automatically resized, default false
",
"name": "options.autoResize"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "sets antialias (only applicable in chrome at the moment)
",
"name": "options.antialias"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 1,
"description": "The resolution / device pixel ratio of the renderer. The
resolution of the renderer retina would be 2.
",
"name": "options.resolution"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": true,
"description": "This sets if the CanvasRenderer will clear the canvas or
not before the new render pass.
",
"name": "options.clearBeforeRender"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "0x000000",
"description": "The background color of the rendered area
(shown if not transparent).
",
"name": "options.backgroundColor"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "If true Pixi will Math.floor() x/y values when rendering,
stopping pixel interpolation.
",
"name": "options.roundPixels"
}
],
"___id": "T000002R002129",
"___s": true,
"$methods": [
{
"comment": "/**\n * Same as view.width, actual number of pixels in the canvas by horizontal\n *\n * @member {number}\n * @readonly\n * @default 800\n */",
"meta": {
"range": [
7276,
7331
],
"filename": "SystemRenderer.js",
"lineno": 201,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100022913",
"name": "SystemRenderer#width",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Same as view.width, actual number of pixels in the canvas by horizontal
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "800",
"name": "width",
"longname": "PIXI.SystemRenderer#width",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002168",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererwidth",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Same as view.height, actual number of pixels in the canvas by vertical\n *\n * @member {number}\n * @readonly\n * @default 600\n */",
"meta": {
"range": [
7499,
7556
],
"filename": "SystemRenderer.js",
"lineno": 213,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100022923",
"name": "SystemRenderer#height",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Same as view.height, actual number of pixels in the canvas by vertical
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "600",
"name": "height",
"longname": "PIXI.SystemRenderer#height",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002169",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererheight",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Resizes the screen and canvas to the specified width and height\n * Canvas dimensions are multiplied by resolution\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
7842,
8252
],
"filename": "SystemRenderer.js",
"lineno": 225,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100022933",
"name": "SystemRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the screen and canvas to the specified width and height
Canvas dimensions are multiplied by resolution
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "the new width of the screen
",
"name": "screenWidth"
},
{
"type": {
"names": [
"number"
]
},
"description": "the new height of the screen
",
"name": "screenHeight"
}
],
"name": "resize",
"longname": "PIXI.SystemRenderer#resize",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R002170",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererresize",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Useful function that returns a texture of the display object that can then be used to create sprites\n * This can be quite useful if your displayObject is complicated and needs to be reused multiple times.\n *\n * @param {PIXI.DisplayObject} displayObject - The displayObject the object will be generated from\n * @param {number} scaleMode - Should be one of the scaleMode consts\n * @param {number} resolution - The resolution / device pixel ratio of the texture being generated\n * @return {PIXI.Texture} a texture of the graphics object\n */",
"meta": {
"range": [
8839,
9251
],
"filename": "SystemRenderer.js",
"lineno": 249,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100023010",
"name": "SystemRenderer#generateTexture",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"scaleMode",
"resolution"
]
},
"vars": {
"": null
}
},
"description": "Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The displayObject the object will be generated from
",
"name": "displayObject"
},
{
"type": {
"names": [
"number"
]
},
"description": "Should be one of the scaleMode consts
",
"name": "scaleMode"
},
{
"type": {
"names": [
"number"
]
},
"description": "The resolution / device pixel ratio of the texture being generated
",
"name": "resolution"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "a texture of the graphics object
"
}
],
"name": "generateTexture",
"longname": "PIXI.SystemRenderer#generateTexture",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R002177",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderergenerateTexture",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Removes everything from the renderer and optionally removes the Canvas DOM element.\n *\n * @param {boolean} [removeView=false] - Removes the Canvas element from the DOM.\n */",
"meta": {
"range": [
9457,
10239
],
"filename": "SystemRenderer.js",
"lineno": 268,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100023073",
"name": "SystemRenderer#destroy",
"type": "MethodDefinition",
"paramnames": [
"removeView"
]
},
"vars": {
"": null
}
},
"description": "Removes everything from the renderer and optionally removes the Canvas DOM element.
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Removes the Canvas element from the DOM.
",
"name": "removeView"
}
],
"name": "destroy",
"longname": "PIXI.SystemRenderer#destroy",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R002182",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererdestroy",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color to fill if not transparent\n *\n * @member {number}\n */",
"meta": {
"range": [
10347,
10418
],
"filename": "SystemRenderer.js",
"lineno": 310,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100023203",
"name": "SystemRenderer#backgroundColor",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The background color to fill if not transparent
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "backgroundColor",
"longname": "PIXI.SystemRenderer#backgroundColor",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002200",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererbackgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Same as view.width, actual number of pixels in the canvas by horizontal\n *\n * @member {number}\n * @readonly\n * @default 800\n */",
"meta": {
"range": [
7276,
7331
],
"filename": "SystemRenderer.js",
"lineno": 201,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097592",
"name": "SystemRenderer#width",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Same as view.width, actual number of pixels in the canvas by horizontal
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "800",
"name": "width",
"longname": "PIXI.SystemRenderer#width",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009102",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererwidth",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Same as view.height, actual number of pixels in the canvas by vertical\n *\n * @member {number}\n * @readonly\n * @default 600\n */",
"meta": {
"range": [
7499,
7556
],
"filename": "SystemRenderer.js",
"lineno": 213,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097602",
"name": "SystemRenderer#height",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Same as view.height, actual number of pixels in the canvas by vertical
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"readonly": true,
"defaultvalue": "600",
"name": "height",
"longname": "PIXI.SystemRenderer#height",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009103",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererheight",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Resizes the screen and canvas to the specified width and height\n * Canvas dimensions are multiplied by resolution\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
7842,
8252
],
"filename": "SystemRenderer.js",
"lineno": 225,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097612",
"name": "SystemRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the screen and canvas to the specified width and height
Canvas dimensions are multiplied by resolution
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "the new width of the screen
",
"name": "screenWidth"
},
{
"type": {
"names": [
"number"
]
},
"description": "the new height of the screen
",
"name": "screenHeight"
}
],
"name": "resize",
"longname": "PIXI.SystemRenderer#resize",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R009104",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererresize",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Useful function that returns a texture of the display object that can then be used to create sprites\n * This can be quite useful if your displayObject is complicated and needs to be reused multiple times.\n *\n * @param {PIXI.DisplayObject} displayObject - The displayObject the object will be generated from\n * @param {number} scaleMode - Should be one of the scaleMode consts\n * @param {number} resolution - The resolution / device pixel ratio of the texture being generated\n * @return {PIXI.Texture} a texture of the graphics object\n */",
"meta": {
"range": [
8839,
9251
],
"filename": "SystemRenderer.js",
"lineno": 249,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097689",
"name": "SystemRenderer#generateTexture",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"scaleMode",
"resolution"
]
},
"vars": {
"": null
}
},
"description": "Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The displayObject the object will be generated from
",
"name": "displayObject"
},
{
"type": {
"names": [
"number"
]
},
"description": "Should be one of the scaleMode consts
",
"name": "scaleMode"
},
{
"type": {
"names": [
"number"
]
},
"description": "The resolution / device pixel ratio of the texture being generated
",
"name": "resolution"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "a texture of the graphics object
"
}
],
"name": "generateTexture",
"longname": "PIXI.SystemRenderer#generateTexture",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R009111",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderergenerateTexture",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Removes everything from the renderer and optionally removes the Canvas DOM element.\n *\n * @param {boolean} [removeView=false] - Removes the Canvas element from the DOM.\n */",
"meta": {
"range": [
9457,
10239
],
"filename": "SystemRenderer.js",
"lineno": 268,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097752",
"name": "SystemRenderer#destroy",
"type": "MethodDefinition",
"paramnames": [
"removeView"
]
},
"vars": {
"": null
}
},
"description": "Removes everything from the renderer and optionally removes the Canvas DOM element.
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Removes the Canvas element from the DOM.
",
"name": "removeView"
}
],
"name": "destroy",
"longname": "PIXI.SystemRenderer#destroy",
"kind": "function",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"___id": "T000002R009116",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererdestroy",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color to fill if not transparent\n *\n * @member {number}\n */",
"meta": {
"range": [
10347,
10418
],
"filename": "SystemRenderer.js",
"lineno": 310,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {
"id": "astnode100097882",
"name": "SystemRenderer#backgroundColor",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The background color to fill if not transparent
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "backgroundColor",
"longname": "PIXI.SystemRenderer#backgroundColor",
"memberof": "PIXI.SystemRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009134",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererbackgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
}
],
"$attributes": [
{
"comment": "/**\n * The supplied constructor options.\n *\n * @member {Object} PIXI.SystemRenderer#options\n * @readOnly\n */",
"meta": {
"range": [
2577,
2725
],
"filename": "SystemRenderer.js",
"lineno": 61,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The supplied constructor options.
",
"kind": "member",
"name": "options",
"type": {
"names": [
"Object"
]
},
"readonly": true,
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#options",
"scope": "instance",
"___id": "T000002R002135",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendereroptions",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The type of the renderer.\n *\n * @member {number} PIXI.SystemRenderer#type\n * @default PIXI.RENDERER_TYPE.UNKNOWN\n * @see PIXI.RENDERER_TYPE\n */",
"meta": {
"range": [
2767,
2965
],
"filename": "SystemRenderer.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The type of the renderer.
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"defaultvalue": "PIXI.RENDERER_TYPE.UNKNOWN",
"see": [
"PIXI.RENDERER_TYPE"
],
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#type",
"scope": "instance",
"___id": "T000002R002137",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderertype",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Measurements of the screen. (0, 0, screenWidth, screenHeight)\n *\n * Its safe to use as filterArea or hitArea for whole stage\n *\n * @member {PIXI.Rectangle} PIXI.SystemRenderer#screen\n */",
"meta": {
"range": [
3018,
3259
],
"filename": "SystemRenderer.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Measurements of the screen. (0, 0, screenWidth, screenHeight)
\nIts safe to use as filterArea or hitArea for whole stage
",
"kind": "member",
"name": "screen",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#screen",
"scope": "instance",
"___id": "T000002R002139",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererscreen",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The canvas element that everything is drawn to\n *\n * @member {HTMLCanvasElement} PIXI.SystemRenderer#view\n */",
"meta": {
"range": [
3343,
3491
],
"filename": "SystemRenderer.js",
"lineno": 87,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The canvas element that everything is drawn to
",
"kind": "member",
"name": "view",
"type": {
"names": [
"HTMLCanvasElement"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#view",
"scope": "instance",
"___id": "T000002R002141",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererview",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The resolution / device pixel ratio of the renderer\n *\n * @member {number} PIXI.SystemRenderer#resolution\n * @default 1\n */",
"meta": {
"range": [
3571,
3741
],
"filename": "SystemRenderer.js",
"lineno": 94,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The resolution / device pixel ratio of the renderer
",
"kind": "member",
"name": "resolution",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#resolution",
"scope": "instance",
"___id": "T000002R002143",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererresolution",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Whether the render view is transparent\n *\n * @member {boolean} PIXI.SystemRenderer#transparent\n */",
"meta": {
"range": [
3820,
3957
],
"filename": "SystemRenderer.js",
"lineno": 102,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Whether the render view is transparent
",
"kind": "member",
"name": "transparent",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#transparent",
"scope": "instance",
"___id": "T000002R002145",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderertransparent",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Whether css dimensions of canvas view should be resized to screen dimensions automatically\n *\n * @member {boolean} PIXI.SystemRenderer#autoResize\n */",
"meta": {
"range": [
4015,
4203
],
"filename": "SystemRenderer.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Whether css dimensions of canvas view should be resized to screen dimensions automatically
",
"kind": "member",
"name": "autoResize",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#autoResize",
"scope": "instance",
"___id": "T000002R002147",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererautoResize",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Tracks the blend modes useful for this renderer.\n *\n * @member {object} PIXI.SystemRenderer#blendModes\n */",
"meta": {
"range": [
4268,
4428
],
"filename": "SystemRenderer.js",
"lineno": 116,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Tracks the blend modes useful for this renderer.
",
"kind": "member",
"name": "blendModes",
"type": {
"names": [
"object."
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#blendModes",
"scope": "instance",
"___id": "T000002R002149",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererblendModes",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The value of the preserveDrawingBuffer flag affects whether or not the contents of\n * the stencil buffer is retained after rendering.\n *\n * @member {boolean} PIXI.SystemRenderer#preserveDrawingBuffer\n */",
"meta": {
"range": [
4470,
4720
],
"filename": "SystemRenderer.js",
"lineno": 123,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The value of the preserveDrawingBuffer flag affects whether or not the contents of
the stencil buffer is retained after rendering.
",
"kind": "member",
"name": "preserveDrawingBuffer",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#preserveDrawingBuffer",
"scope": "instance",
"___id": "T000002R002151",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererpreserveDrawingBuffer",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * This sets if the CanvasRenderer will clear the canvas or not before the new render pass.\n * If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every\n * frame to set the canvas background color. If the scene is transparent Pixi will use clearRect\n * to clear the canvas every frame. Disable this by setting this to false. For example if\n * your game has a canvas filling background image you often don't need this set.\n *\n * @member {boolean} PIXI.SystemRenderer#clearBeforeRender\n * @default\n */",
"meta": {
"range": [
4798,
5401
],
"filename": "SystemRenderer.js",
"lineno": 131,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every
frame to set the canvas background color. If the scene is transparent Pixi will use clearRect
to clear the canvas every frame. Disable this by setting this to false. For example if
your game has a canvas filling background image you often don't need this set.
",
"kind": "member",
"name": "clearBeforeRender",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#clearBeforeRender",
"scope": "instance",
"___id": "T000002R002153",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererclearBeforeRender",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.\n * Handy for crisp pixel art and speed on legacy devices.\n *\n * @member {boolean} PIXI.SystemRenderer#roundPixels\n */",
"meta": {
"range": [
5471,
5723
],
"filename": "SystemRenderer.js",
"lineno": 143,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.
Handy for crisp pixel art and speed on legacy devices.
",
"kind": "member",
"name": "roundPixels",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#roundPixels",
"scope": "instance",
"___id": "T000002R002155",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererroundPixels",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as a number.\n *\n * @member {number} PIXI.SystemRenderer#_backgroundColor\n * @private\n */",
"meta": {
"range": [
5781,
5937
],
"filename": "SystemRenderer.js",
"lineno": 151,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as a number.
",
"kind": "member",
"name": "_backgroundColor",
"type": {
"names": [
"number"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColor",
"scope": "instance",
"___id": "T000002R002157",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as an [R, G, B] array.\n *\n * @member {number[]} PIXI.SystemRenderer#_backgroundColorRgba\n * @private\n */",
"meta": {
"range": [
5989,
6161
],
"filename": "SystemRenderer.js",
"lineno": 159,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as an [R, G, B] array.
",
"kind": "member",
"name": "_backgroundColorRgba",
"type": {
"names": [
"Array."
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColorRgba",
"scope": "instance",
"___id": "T000002R002159",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColorRgba",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as a string.\n *\n * @member {string} PIXI.SystemRenderer#_backgroundColorString\n * @private\n */",
"meta": {
"range": [
6221,
6383
],
"filename": "SystemRenderer.js",
"lineno": 167,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as a string.
",
"kind": "member",
"name": "_backgroundColorString",
"type": {
"names": [
"string"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColorString",
"scope": "instance",
"___id": "T000002R002161",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColorString",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * This temporary display object used as the parent of the currently being rendered item\n *\n * @member {PIXI.DisplayObject} PIXI.SystemRenderer#_tempDisplayObjectParent\n * @private\n */",
"meta": {
"range": [
6547,
6775
],
"filename": "SystemRenderer.js",
"lineno": 177,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "This temporary display object used as the parent of the currently being rendered item
",
"kind": "member",
"name": "_tempDisplayObjectParent",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"scope": "instance",
"___id": "T000002R002164",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_tempDisplayObjectParent",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The last root object that the renderer tried to render.\n *\n * @member {PIXI.DisplayObject} PIXI.SystemRenderer#_lastObjectRendered\n * @private\n */",
"meta": {
"range": [
6842,
7035
],
"filename": "SystemRenderer.js",
"lineno": 185,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The last root object that the renderer tried to render.
",
"kind": "member",
"name": "_lastObjectRendered",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_lastObjectRendered",
"scope": "instance",
"___id": "T000002R002166",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_lastObjectRendered",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The supplied constructor options.\n *\n * @member {Object} PIXI.SystemRenderer#options\n * @readOnly\n */",
"meta": {
"range": [
2577,
2725
],
"filename": "SystemRenderer.js",
"lineno": 61,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The supplied constructor options.
",
"kind": "member",
"name": "options",
"type": {
"names": [
"Object"
]
},
"readonly": true,
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#options",
"scope": "instance",
"___id": "T000002R009069",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendereroptions",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The type of the renderer.\n *\n * @member {number} PIXI.SystemRenderer#type\n * @default PIXI.RENDERER_TYPE.UNKNOWN\n * @see PIXI.RENDERER_TYPE\n */",
"meta": {
"range": [
2767,
2965
],
"filename": "SystemRenderer.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The type of the renderer.
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"defaultvalue": "PIXI.RENDERER_TYPE.UNKNOWN",
"see": [
"PIXI.RENDERER_TYPE"
],
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#type",
"scope": "instance",
"___id": "T000002R009071",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderertype",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Measurements of the screen. (0, 0, screenWidth, screenHeight)\n *\n * Its safe to use as filterArea or hitArea for whole stage\n *\n * @member {PIXI.Rectangle} PIXI.SystemRenderer#screen\n */",
"meta": {
"range": [
3018,
3259
],
"filename": "SystemRenderer.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Measurements of the screen. (0, 0, screenWidth, screenHeight)
\nIts safe to use as filterArea or hitArea for whole stage
",
"kind": "member",
"name": "screen",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#screen",
"scope": "instance",
"___id": "T000002R009073",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererscreen",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The canvas element that everything is drawn to\n *\n * @member {HTMLCanvasElement} PIXI.SystemRenderer#view\n */",
"meta": {
"range": [
3343,
3491
],
"filename": "SystemRenderer.js",
"lineno": 87,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The canvas element that everything is drawn to
",
"kind": "member",
"name": "view",
"type": {
"names": [
"HTMLCanvasElement"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#view",
"scope": "instance",
"___id": "T000002R009075",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererview",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The resolution / device pixel ratio of the renderer\n *\n * @member {number} PIXI.SystemRenderer#resolution\n * @default 1\n */",
"meta": {
"range": [
3571,
3741
],
"filename": "SystemRenderer.js",
"lineno": 94,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The resolution / device pixel ratio of the renderer
",
"kind": "member",
"name": "resolution",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#resolution",
"scope": "instance",
"___id": "T000002R009077",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererresolution",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Whether the render view is transparent\n *\n * @member {boolean} PIXI.SystemRenderer#transparent\n */",
"meta": {
"range": [
3820,
3957
],
"filename": "SystemRenderer.js",
"lineno": 102,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Whether the render view is transparent
",
"kind": "member",
"name": "transparent",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#transparent",
"scope": "instance",
"___id": "T000002R009079",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderertransparent",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Whether css dimensions of canvas view should be resized to screen dimensions automatically\n *\n * @member {boolean} PIXI.SystemRenderer#autoResize\n */",
"meta": {
"range": [
4015,
4203
],
"filename": "SystemRenderer.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Whether css dimensions of canvas view should be resized to screen dimensions automatically
",
"kind": "member",
"name": "autoResize",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#autoResize",
"scope": "instance",
"___id": "T000002R009081",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererautoResize",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * Tracks the blend modes useful for this renderer.\n *\n * @member {object} PIXI.SystemRenderer#blendModes\n */",
"meta": {
"range": [
4268,
4428
],
"filename": "SystemRenderer.js",
"lineno": 116,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "Tracks the blend modes useful for this renderer.
",
"kind": "member",
"name": "blendModes",
"type": {
"names": [
"object."
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#blendModes",
"scope": "instance",
"___id": "T000002R009083",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererblendModes",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The value of the preserveDrawingBuffer flag affects whether or not the contents of\n * the stencil buffer is retained after rendering.\n *\n * @member {boolean} PIXI.SystemRenderer#preserveDrawingBuffer\n */",
"meta": {
"range": [
4470,
4720
],
"filename": "SystemRenderer.js",
"lineno": 123,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The value of the preserveDrawingBuffer flag affects whether or not the contents of
the stencil buffer is retained after rendering.
",
"kind": "member",
"name": "preserveDrawingBuffer",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#preserveDrawingBuffer",
"scope": "instance",
"___id": "T000002R009085",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererpreserveDrawingBuffer",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * This sets if the CanvasRenderer will clear the canvas or not before the new render pass.\n * If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every\n * frame to set the canvas background color. If the scene is transparent Pixi will use clearRect\n * to clear the canvas every frame. Disable this by setting this to false. For example if\n * your game has a canvas filling background image you often don't need this set.\n *\n * @member {boolean} PIXI.SystemRenderer#clearBeforeRender\n * @default\n */",
"meta": {
"range": [
4798,
5401
],
"filename": "SystemRenderer.js",
"lineno": 131,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every
frame to set the canvas background color. If the scene is transparent Pixi will use clearRect
to clear the canvas every frame. Disable this by setting this to false. For example if
your game has a canvas filling background image you often don't need this set.
",
"kind": "member",
"name": "clearBeforeRender",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#clearBeforeRender",
"scope": "instance",
"___id": "T000002R009087",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererclearBeforeRender",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.\n * Handy for crisp pixel art and speed on legacy devices.\n *\n * @member {boolean} PIXI.SystemRenderer#roundPixels\n */",
"meta": {
"range": [
5471,
5723
],
"filename": "SystemRenderer.js",
"lineno": 143,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.
Handy for crisp pixel art and speed on legacy devices.
",
"kind": "member",
"name": "roundPixels",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#roundPixels",
"scope": "instance",
"___id": "T000002R009089",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRendererroundPixels",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as a number.\n *\n * @member {number} PIXI.SystemRenderer#_backgroundColor\n * @private\n */",
"meta": {
"range": [
5781,
5937
],
"filename": "SystemRenderer.js",
"lineno": 151,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as a number.
",
"kind": "member",
"name": "_backgroundColor",
"type": {
"names": [
"number"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColor",
"scope": "instance",
"___id": "T000002R009091",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as an [R, G, B] array.\n *\n * @member {number[]} PIXI.SystemRenderer#_backgroundColorRgba\n * @private\n */",
"meta": {
"range": [
5989,
6161
],
"filename": "SystemRenderer.js",
"lineno": 159,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as an [R, G, B] array.
",
"kind": "member",
"name": "_backgroundColorRgba",
"type": {
"names": [
"Array."
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColorRgba",
"scope": "instance",
"___id": "T000002R009093",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColorRgba",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The background color as a string.\n *\n * @member {string} PIXI.SystemRenderer#_backgroundColorString\n * @private\n */",
"meta": {
"range": [
6221,
6383
],
"filename": "SystemRenderer.js",
"lineno": 167,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The background color as a string.
",
"kind": "member",
"name": "_backgroundColorString",
"type": {
"names": [
"string"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_backgroundColorString",
"scope": "instance",
"___id": "T000002R009095",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_backgroundColorString",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * This temporary display object used as the parent of the currently being rendered item\n *\n * @member {PIXI.DisplayObject} PIXI.SystemRenderer#_tempDisplayObjectParent\n * @private\n */",
"meta": {
"range": [
6547,
6775
],
"filename": "SystemRenderer.js",
"lineno": 177,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "This temporary display object used as the parent of the currently being rendered item
",
"kind": "member",
"name": "_tempDisplayObjectParent",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"scope": "instance",
"___id": "T000002R009098",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_tempDisplayObjectParent",
"filepath": "core\\renderers\\SystemRenderer.js"
},
{
"comment": "/**\n * The last root object that the renderer tried to render.\n *\n * @member {PIXI.DisplayObject} PIXI.SystemRenderer#_lastObjectRendered\n * @private\n */",
"meta": {
"range": [
6842,
7035
],
"filename": "SystemRenderer.js",
"lineno": 185,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers",
"code": {}
},
"description": "The last root object that the renderer tried to render.
",
"kind": "member",
"name": "_lastObjectRendered",
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"access": "private",
"memberof": "PIXI.SystemRenderer",
"longname": "PIXI.SystemRenderer#_lastObjectRendered",
"scope": "instance",
"___id": "T000002R009100",
"___s": true,
"skip": true,
"slug": "PIXI.SystemRenderer_lastObjectRendered",
"filepath": "core\\renderers\\SystemRenderer.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"name": "EventEmitter"
}
],
"$augmentedBy": [
{
"name": "CanvasRenderer"
},
{
"name": "WebGLRenderer"
},
{
"name": "CanvasRenderer"
},
{
"name": "WebGLRenderer"
}
],
"filepath": "core\\renderers\\SystemRenderer.js"
}