The CanvasRenderer draws the scene and all its content onto a 2d canvas. This renderer should
be used for browsers that do not support WebGL. Don't forget to add the CanvasRenderer.view to
your DOM or you will not see anything :)
| Public methods | |
|---|---|
| public | render(displayObject: PIXI.DisplayObject, renderTexture: PIXI.RenderTexture, clear: boolean, transform: PIXI.Transform, skipUpdateTransform: boolean): void |
| public | clear(clearColor: string): void |
| public | setBlendMode(blendMode: number): void |
| public | destroy(removeView: boolean): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | render(displayObject: PIXI.DisplayObject, renderTexture: PIXI.RenderTexture, clear: boolean, transform: PIXI.Transform, skipUpdateTransform: boolean): void |
| public | clear(clearColor: string): void |
| public | setBlendMode(blendMode: number): void |
| public | destroy(removeView: boolean): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | width(): void |
| public | height(): void |
| public | generateTexture(displayObject: PIXI.DisplayObject, scaleMode: number, resolution: number): PIXI.Texture |
| public | backgroundColor(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| rootContext | CanvasRenderingContext2D | public | The canvas 2d context that everything is drawn with. |
| refresh | boolean | public | Boolean flag controlling canvas refresh. |
| maskManager | PIXI.CanvasMaskManager | public | Instance of a CanvasMaskManager, handles masking when using the canvas renderer. |
| smoothProperty | string | public | The canvas property used to set the canvas smoothing property. |
| extract | PIXI.CanvasExtract | public | Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture |
| rootContext | CanvasRenderingContext2D | public | The canvas 2d context that everything is drawn with. |
| refresh | boolean | public | Boolean flag controlling canvas refresh. |
| maskManager | PIXI.CanvasMaskManager | public | Instance of a CanvasMaskManager, handles masking when using the canvas renderer. |
| smoothProperty | string | public | The canvas property used to set the canvas smoothing property. |
| extract | PIXI.CanvasExtract | public | Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture |
| 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. |
Renders the object to this canvas view
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The object to be rendered |
||
| renderTexture | A render texture to be rendered to. |
||
| clear | Whether to clear the canvas before drawing |
||
| transform | A transformation to be applied |
||
| skipUpdateTransform | Whether to skip the update transform |
void
Clear the canvas of renderer.
| Name | Type | Attribute | Description |
|---|---|---|---|
| clearColor | Clear the canvas with this color, except the canvas is transparent. |
void
Sets the blend mode of the renderer.
| Name | Type | Attribute | Description |
|---|---|---|---|
| blendMode | See {@link PIXI.BLEND_MODES} for valid values. |
void
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
Resizes the canvas view to the specified width and height.
| Name | Type | Attribute | Description |
|---|---|---|---|
| screenWidth | the new width of the screen |
||
| screenHeight | the new height of the screen |
void
Renders the object to this canvas view
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | The object to be rendered |
||
| renderTexture | A render texture to be rendered to. |
||
| clear | Whether to clear the canvas before drawing |
||
| transform | A transformation to be applied |
||
| skipUpdateTransform | Whether to skip the update transform |
void
Clear the canvas of renderer.
| Name | Type | Attribute | Description |
|---|---|---|---|
| clearColor | Clear the canvas with this color, except the canvas is transparent. |
void
Sets the blend mode of the renderer.
| Name | Type | Attribute | Description |
|---|---|---|---|
| blendMode | See {@link PIXI.BLEND_MODES} for valid values. |
void
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
Resizes the canvas view to the specified width and height.
| Name | Type | Attribute | Description |
|---|---|---|---|
| screenWidth | the new width of the screen |
||
| screenHeight | the new height of the screen |
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
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
The background color to fill if not transparent
void
{
"comment": "/**\n * The CanvasRenderer draws the scene and all its content onto a 2d canvas. This renderer should\n * be used for browsers that do not support WebGL. Don't forget to add the CanvasRenderer.view to\n * your DOM or you will not see anything :)\n *\n * @class\n * @memberof PIXI\n * @extends PIXI.SystemRenderer\n */",
"meta": {
"range": [
740,
9992
],
"filename": "CanvasRenderer.js",
"lineno": 20,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100020646",
"name": "CanvasRenderer",
"type": "ClassDeclaration",
"paramnames": [
"options",
"arg2",
"arg3"
]
}
},
"classdesc": "The CanvasRenderer draws the scene and all its content onto a 2d canvas. This renderer should
be used for browsers that do not support WebGL. Don't forget to add the CanvasRenderer.view to
your DOM or you will not see anything :)
",
"kind": "class",
"memberof": "PIXI",
"augments": [
"PIXI.SystemRenderer"
],
"name": "CanvasRenderer",
"longname": "PIXI.CanvasRenderer",
"scope": "static",
"params": [
{
"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": "T000002R001955",
"___s": true,
"$methods": [
{
"comment": "/**\n * Renders the object to this canvas view\n *\n * @param {PIXI.DisplayObject} displayObject - The object to be rendered\n * @param {PIXI.RenderTexture} [renderTexture] - A render texture to be rendered to.\n * If unset, it will render to the root context.\n * @param {boolean} [clear=false] - Whether to clear the canvas before drawing\n * @param {PIXI.Transform} [transform] - A transformation to be applied\n * @param {boolean} [skipUpdateTransform=false] - Whether to skip the update transform\n */",
"meta": {
"range": [
4637,
7841
],
"filename": "CanvasRenderer.js",
"lineno": 115,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100020814",
"name": "CanvasRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"renderTexture",
"clear",
"transform",
"skipUpdateTransform"
]
},
"vars": {
"": null
}
},
"description": "Renders the object to this canvas view
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The object to be rendered
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"optional": true,
"description": "A render texture to be rendered to.
If unset, it will render to the root context.
",
"name": "renderTexture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to clear the canvas before drawing
",
"name": "clear"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"optional": true,
"description": "A transformation to be applied
",
"name": "transform"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to skip the update transform
",
"name": "skipUpdateTransform"
}
],
"name": "render",
"longname": "PIXI.CanvasRenderer#render",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R001975",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrender",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Clear the canvas of renderer.\n *\n * @param {string} [clearColor] - Clear the canvas with this color, except the canvas is transparent.\n */",
"meta": {
"range": [
8013,
8411
],
"filename": "CanvasRenderer.js",
"lineno": 229,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100021150",
"name": "CanvasRenderer#clear",
"type": "MethodDefinition",
"paramnames": [
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Clear the canvas of renderer.
",
"params": [
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": "Clear the canvas with this color, except the canvas is transparent.
",
"name": "clearColor"
}
],
"name": "clear",
"longname": "PIXI.CanvasRenderer#clear",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R002000",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererclear",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Sets the blend mode of the renderer.\n *\n * @param {number} blendMode - See {@link PIXI.BLEND_MODES} for valid values.\n */",
"meta": {
"range": [
8566,
8810
],
"filename": "CanvasRenderer.js",
"lineno": 251,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100021210",
"name": "CanvasRenderer#setBlendMode",
"type": "MethodDefinition",
"paramnames": [
"blendMode"
]
},
"vars": {
"": null
}
},
"description": "Sets the blend mode of the renderer.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "See {@link PIXI.BLEND_MODES} for valid values.
",
"name": "blendMode"
}
],
"name": "setBlendMode",
"longname": "PIXI.CanvasRenderer#setBlendMode",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R002004",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderersetBlendMode",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.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": [
9016,
9314
],
"filename": "CanvasRenderer.js",
"lineno": 267,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100021241",
"name": "CanvasRenderer#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.CanvasRenderer#destroy",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#destroy",
"___id": "T000002R002007",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererdestroy",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Resizes the canvas view to the specified width and height.\n *\n * @extends PIXI.SystemRenderer#resize\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
9591,
9990
],
"filename": "CanvasRenderer.js",
"lineno": 292,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100021288",
"name": "CanvasRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the canvas view to the specified width and height.
",
"augments": [
"PIXI.SystemRenderer#resize"
],
"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.CanvasRenderer#resize",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#resize",
"___id": "T000002R002012",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererresize",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Renders the object to this canvas view\n *\n * @param {PIXI.DisplayObject} displayObject - The object to be rendered\n * @param {PIXI.RenderTexture} [renderTexture] - A render texture to be rendered to.\n * If unset, it will render to the root context.\n * @param {boolean} [clear=false] - Whether to clear the canvas before drawing\n * @param {PIXI.Transform} [transform] - A transformation to be applied\n * @param {boolean} [skipUpdateTransform=false] - Whether to skip the update transform\n */",
"meta": {
"range": [
4637,
7841
],
"filename": "CanvasRenderer.js",
"lineno": 115,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100095493",
"name": "CanvasRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"renderTexture",
"clear",
"transform",
"skipUpdateTransform"
]
},
"vars": {
"": null
}
},
"description": "Renders the object to this canvas view
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "The object to be rendered
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"optional": true,
"description": "A render texture to be rendered to.
If unset, it will render to the root context.
",
"name": "renderTexture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to clear the canvas before drawing
",
"name": "clear"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"optional": true,
"description": "A transformation to be applied
",
"name": "transform"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to skip the update transform
",
"name": "skipUpdateTransform"
}
],
"name": "render",
"longname": "PIXI.CanvasRenderer#render",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R008909",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrender",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Clear the canvas of renderer.\n *\n * @param {string} [clearColor] - Clear the canvas with this color, except the canvas is transparent.\n */",
"meta": {
"range": [
8013,
8411
],
"filename": "CanvasRenderer.js",
"lineno": 229,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100095829",
"name": "CanvasRenderer#clear",
"type": "MethodDefinition",
"paramnames": [
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Clear the canvas of renderer.
",
"params": [
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": "Clear the canvas with this color, except the canvas is transparent.
",
"name": "clearColor"
}
],
"name": "clear",
"longname": "PIXI.CanvasRenderer#clear",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R008934",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererclear",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Sets the blend mode of the renderer.\n *\n * @param {number} blendMode - See {@link PIXI.BLEND_MODES} for valid values.\n */",
"meta": {
"range": [
8566,
8810
],
"filename": "CanvasRenderer.js",
"lineno": 251,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100095889",
"name": "CanvasRenderer#setBlendMode",
"type": "MethodDefinition",
"paramnames": [
"blendMode"
]
},
"vars": {
"": null
}
},
"description": "Sets the blend mode of the renderer.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "See {@link PIXI.BLEND_MODES} for valid values.
",
"name": "blendMode"
}
],
"name": "setBlendMode",
"longname": "PIXI.CanvasRenderer#setBlendMode",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"___id": "T000002R008938",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderersetBlendMode",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.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": [
9016,
9314
],
"filename": "CanvasRenderer.js",
"lineno": 267,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100095920",
"name": "CanvasRenderer#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.CanvasRenderer#destroy",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#destroy",
"___id": "T000002R008941",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererdestroy",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Resizes the canvas view to the specified width and height.\n *\n * @extends PIXI.SystemRenderer#resize\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
9591,
9990
],
"filename": "CanvasRenderer.js",
"lineno": 292,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {
"id": "astnode100095967",
"name": "CanvasRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the canvas view to the specified width and height.
",
"augments": [
"PIXI.SystemRenderer#resize"
],
"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.CanvasRenderer#resize",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#resize",
"___id": "T000002R008946",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererresize",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.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": "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.CanvasRenderer#width",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#width",
"inherited": true,
"overrides": "PIXI.SystemRenderer#width",
"___id": "T000002R013979",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererwidth",
"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.CanvasRenderer#height",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#height",
"inherited": true,
"overrides": "PIXI.SystemRenderer#height",
"___id": "T000002R013980",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererheight",
"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.CanvasRenderer#generateTexture",
"kind": "function",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#generateTexture",
"inherited": true,
"overrides": "PIXI.SystemRenderer#generateTexture",
"___id": "T000002R013981",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderergenerateTexture",
"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.CanvasRenderer#backgroundColor",
"memberof": "PIXI.CanvasRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#backgroundColor",
"inherited": true,
"overrides": "PIXI.SystemRenderer#backgroundColor",
"___id": "T000002R013982",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererbackgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
}
],
"$attributes": [
{
"comment": "/**\n * The canvas 2d context that everything is drawn with.\n *\n * @member {CanvasRenderingContext2D} PIXI.CanvasRenderer#rootContext\n */",
"meta": {
"range": [
2215,
2383
],
"filename": "CanvasRenderer.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "The canvas 2d context that everything is drawn with.
",
"kind": "member",
"name": "rootContext",
"type": {
"names": [
"CanvasRenderingContext2D"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#rootContext",
"scope": "instance",
"___id": "T000002R001958",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrootContext",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Boolean flag controlling canvas refresh.\n *\n * @member {boolean} PIXI.CanvasRenderer#refresh\n */",
"meta": {
"range": [
2477,
2612
],
"filename": "CanvasRenderer.js",
"lineno": 53,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "Boolean flag controlling canvas refresh.
",
"kind": "member",
"name": "refresh",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#refresh",
"scope": "instance",
"___id": "T000002R001961",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrefresh",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Instance of a CanvasMaskManager, handles masking when using the canvas renderer.\n *\n * @member {PIXI.CanvasMaskManager} PIXI.CanvasRenderer#maskManager\n */",
"meta": {
"range": [
2651,
2845
],
"filename": "CanvasRenderer.js",
"lineno": 60,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "Instance of a CanvasMaskManager, handles masking when using the canvas renderer.
",
"kind": "member",
"name": "maskManager",
"type": {
"names": [
"PIXI.CanvasMaskManager"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#maskManager",
"scope": "instance",
"___id": "T000002R001963",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderermaskManager",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * The canvas property used to set the canvas smoothing property.\n *\n * @member {string} PIXI.CanvasRenderer#smoothProperty\n */",
"meta": {
"range": [
2911,
3074
],
"filename": "CanvasRenderer.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "The canvas property used to set the canvas smoothing property.
",
"kind": "member",
"name": "smoothProperty",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#smoothProperty",
"scope": "instance",
"___id": "T000002R001965",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderersmoothProperty",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture\n *\n * @member {PIXI.CanvasExtract} extract\n * @memberof PIXI.CanvasRenderer#\n * @see PIXI.CanvasExtract\n */",
"meta": {
"range": [
541,
807
],
"filename": "CanvasExtract.js",
"lineno": 23,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extract\\canvas",
"code": {}
},
"description": "Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture
",
"kind": "member",
"name": "extract",
"type": {
"names": [
"PIXI.CanvasExtract"
]
},
"memberof": "PIXI.CanvasRenderer",
"see": [
"PIXI.CanvasExtract"
],
"longname": "PIXI.CanvasRenderer#extract",
"scope": "instance",
"___id": "T000002R004741",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererextract",
"filepath": "extract\\canvas\\CanvasExtract.js"
},
{
"comment": "/**\n * The canvas 2d context that everything is drawn with.\n *\n * @member {CanvasRenderingContext2D} PIXI.CanvasRenderer#rootContext\n */",
"meta": {
"range": [
2215,
2383
],
"filename": "CanvasRenderer.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "The canvas 2d context that everything is drawn with.
",
"kind": "member",
"name": "rootContext",
"type": {
"names": [
"CanvasRenderingContext2D"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#rootContext",
"scope": "instance",
"___id": "T000002R008892",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrootContext",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Boolean flag controlling canvas refresh.\n *\n * @member {boolean} PIXI.CanvasRenderer#refresh\n */",
"meta": {
"range": [
2477,
2612
],
"filename": "CanvasRenderer.js",
"lineno": 53,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "Boolean flag controlling canvas refresh.
",
"kind": "member",
"name": "refresh",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#refresh",
"scope": "instance",
"___id": "T000002R008895",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererrefresh",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Instance of a CanvasMaskManager, handles masking when using the canvas renderer.\n *\n * @member {PIXI.CanvasMaskManager} PIXI.CanvasRenderer#maskManager\n */",
"meta": {
"range": [
2651,
2845
],
"filename": "CanvasRenderer.js",
"lineno": 60,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "Instance of a CanvasMaskManager, handles masking when using the canvas renderer.
",
"kind": "member",
"name": "maskManager",
"type": {
"names": [
"PIXI.CanvasMaskManager"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#maskManager",
"scope": "instance",
"___id": "T000002R008897",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderermaskManager",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * The canvas property used to set the canvas smoothing property.\n *\n * @member {string} PIXI.CanvasRenderer#smoothProperty\n */",
"meta": {
"range": [
2911,
3074
],
"filename": "CanvasRenderer.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas",
"code": {}
},
"description": "The canvas property used to set the canvas smoothing property.
",
"kind": "member",
"name": "smoothProperty",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#smoothProperty",
"scope": "instance",
"___id": "T000002R008899",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderersmoothProperty",
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
},
{
"comment": "/**\n * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture\n *\n * @member {PIXI.CanvasExtract} extract\n * @memberof PIXI.CanvasRenderer#\n * @see PIXI.CanvasExtract\n */",
"meta": {
"range": [
541,
807
],
"filename": "CanvasExtract.js",
"lineno": 23,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extract\\canvas",
"code": {}
},
"description": "Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture
",
"kind": "member",
"name": "extract",
"type": {
"names": [
"PIXI.CanvasExtract"
]
},
"memberof": "PIXI.CanvasRenderer",
"see": [
"PIXI.CanvasExtract"
],
"longname": "PIXI.CanvasRenderer#extract",
"scope": "instance",
"___id": "T000002R011675",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererextract",
"filepath": "extract\\canvas\\CanvasExtract.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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#options",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#options",
"inherited": true,
"overrides": "PIXI.SystemRenderer#options",
"___id": "T000002R013963",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendereroptions",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#type",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#type",
"inherited": true,
"overrides": "PIXI.SystemRenderer#type",
"___id": "T000002R013964",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderertype",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#screen",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#screen",
"inherited": true,
"overrides": "PIXI.SystemRenderer#screen",
"___id": "T000002R013965",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererscreen",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#view",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#view",
"inherited": true,
"overrides": "PIXI.SystemRenderer#view",
"___id": "T000002R013966",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererview",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#resolution",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#resolution",
"inherited": true,
"overrides": "PIXI.SystemRenderer#resolution",
"___id": "T000002R013967",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererresolution",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#transparent",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#transparent",
"inherited": true,
"overrides": "PIXI.SystemRenderer#transparent",
"___id": "T000002R013968",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderertransparent",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#autoResize",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#autoResize",
"inherited": true,
"overrides": "PIXI.SystemRenderer#autoResize",
"___id": "T000002R013969",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererautoResize",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#blendModes",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#blendModes",
"inherited": true,
"overrides": "PIXI.SystemRenderer#blendModes",
"___id": "T000002R013970",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererblendModes",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#preserveDrawingBuffer",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#preserveDrawingBuffer",
"inherited": true,
"overrides": "PIXI.SystemRenderer#preserveDrawingBuffer",
"___id": "T000002R013971",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererpreserveDrawingBuffer",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#clearBeforeRender",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#clearBeforeRender",
"inherited": true,
"overrides": "PIXI.SystemRenderer#clearBeforeRender",
"___id": "T000002R013972",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererclearBeforeRender",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#roundPixels",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#roundPixels",
"inherited": true,
"overrides": "PIXI.SystemRenderer#roundPixels",
"___id": "T000002R013973",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRendererroundPixels",
"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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#_backgroundColor",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColor",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColor",
"___id": "T000002R013974",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderer_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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#_backgroundColorRgba",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColorRgba",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColorRgba",
"___id": "T000002R013975",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderer_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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#_backgroundColorString",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColorString",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColorString",
"___id": "T000002R013976",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderer_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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#_tempDisplayObjectParent",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"___id": "T000002R013977",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderer_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.CanvasRenderer",
"longname": "PIXI.CanvasRenderer#_lastObjectRendered",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_lastObjectRendered",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_lastObjectRendered",
"___id": "T000002R013978",
"___s": true,
"skip": true,
"slug": "PIXI.CanvasRenderer_lastObjectRendered",
"filepath": "core\\renderers\\SystemRenderer.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"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"
}
],
"$augmentedBy": [],
"filepath": "core\\renderers\\canvas\\CanvasRenderer.js"
}