The WebGLRenderer draws the scene and all its content onto a webGL enabled canvas. This renderer
should be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.
So no need for Sprite Batches or Sprite Clouds.
Don't forget to add the view to your DOM or you will not see anything :)
| Public methods | |
|---|---|
| private | _initContext(): void |
| public | render(displayObject: PIXI.DisplayObject, renderTexture: PIXI.RenderTexture, clear: boolean, transform: PIXI.Transform, skipUpdateTransform: boolean): void |
| public | setObjectRenderer(objectRenderer: PIXI.ObjectRenderer): void |
| public | flush(): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | setBlendMode(blendMode: number): void |
| public | clear(clearColor: number): void |
| public | setTransform(matrix: PIXI.Matrix): void |
| public | clearRenderTexture(renderTexture: PIXI.RenderTexture, clearColor: number): PIXI.WebGLRenderer |
| public | bindRenderTexture(renderTexture: PIXI.RenderTexture, transform: PIXI.Transform): PIXI.WebGLRenderer |
| public | bindRenderTarget(renderTarget: PIXI.RenderTarget): PIXI.WebGLRenderer |
| public | bindShader(shader: PIXI.Shader, autoProject: boolean): PIXI.WebGLRenderer |
| public | bindTexture(texture: PIXI.Texture, location: number, forceLocation: boolean): PIXI.WebGLRenderer |
| public | unbindTexture(texture: PIXI.Texture): PIXI.WebGLRenderer |
| public | createVao(): VertexArrayObject |
| public | bindVao(vao: PIXI.VertexArrayObject): PIXI.WebGLRenderer |
| public | reset(): PIXI.WebGLRenderer |
| private | handleContextLost(event: WebGLContextEvent): void |
| private | handleContextRestored(): void |
| public | destroy(removeView: boolean): void |
| private | _initContext(): void |
| public | render(displayObject: PIXI.DisplayObject, renderTexture: PIXI.RenderTexture, clear: boolean, transform: PIXI.Transform, skipUpdateTransform: boolean): void |
| public | setObjectRenderer(objectRenderer: PIXI.ObjectRenderer): void |
| public | flush(): void |
| public | resize(screenWidth: number, screenHeight: number): void |
| public | setBlendMode(blendMode: number): void |
| public | clear(clearColor: number): void |
| public | setTransform(matrix: PIXI.Matrix): void |
| public | clearRenderTexture(renderTexture: PIXI.RenderTexture, clearColor: number): PIXI.WebGLRenderer |
| public | bindRenderTexture(renderTexture: PIXI.RenderTexture, transform: PIXI.Transform): PIXI.WebGLRenderer |
| public | bindRenderTarget(renderTarget: PIXI.RenderTarget): PIXI.WebGLRenderer |
| public | bindShader(shader: PIXI.Shader, autoProject: boolean): PIXI.WebGLRenderer |
| public | bindTexture(texture: PIXI.Texture, location: number, forceLocation: boolean): PIXI.WebGLRenderer |
| public | unbindTexture(texture: PIXI.Texture): PIXI.WebGLRenderer |
| public | createVao(): VertexArrayObject |
| public | bindVao(vao: PIXI.VertexArrayObject): PIXI.WebGLRenderer |
| public | reset(): PIXI.WebGLRenderer |
| private | handleContextLost(event: WebGLContextEvent): void |
| private | handleContextRestored(): void |
| public | destroy(removeView: boolean): 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 |
|---|---|---|---|
| type | number | public | The type of this renderer as a standardised const |
| _contextOptions | object | private | The options passed in to create a new webgl context. |
| maskManager | PIXI.MaskManager | public | Manages the masks using the stencil buffer. |
| stencilManager | PIXI.StencilManager | public | Manages the stencil buffer. |
| emptyRenderer | PIXI.ObjectRenderer | public | An empty renderer. |
| currentRenderer | PIXI.ObjectRenderer | public | The currently active ObjectRenderer. |
| state | PIXI.WebGLState | public | The currently active ObjectRenderer. |
| _activeShader | PIXI.Shader | public | Holds the current shader |
| _activeRenderTarget | PIXI.RenderTarget | public | Holds the current render target |
| filterManager | PIXI.FilterManager | public | Manages the filters. |
| extract | PIXI.WebGLExtract | public | Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture |
| type | number | public | The type of this renderer as a standardised const |
| _contextOptions | object | private | The options passed in to create a new webgl context. |
| maskManager | PIXI.MaskManager | public | Manages the masks using the stencil buffer. |
| stencilManager | PIXI.StencilManager | public | Manages the stencil buffer. |
| emptyRenderer | PIXI.ObjectRenderer | public | An empty renderer. |
| currentRenderer | PIXI.ObjectRenderer | public | The currently active ObjectRenderer. |
| state | PIXI.WebGLState | public | The currently active ObjectRenderer. |
| _activeShader | PIXI.Shader | public | Holds the current shader |
| _activeRenderTarget | PIXI.RenderTarget | public | Holds the current render target |
| filterManager | PIXI.FilterManager | public | Manages the filters. |
| extract | PIXI.WebGLExtract | public | Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture |
| options | Object | public | The supplied constructor options. |
| 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. |
Creates the WebGL context
void
Renders the object to its webGL view
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | the object to be rendered |
||
| renderTexture | The render texture to render to. |
||
| clear | Should the canvas be cleared before the new render |
||
| transform | A transform to apply to the render texture before rendering. |
||
| skipUpdateTransform | Should we skip the update transform pass? |
void
Changes the current renderer to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| objectRenderer | The object renderer to use. |
void
This should be called if you wish to do some custom rendering
It will basically render anything that may be batched up such as sprites
void
Resizes the webGL 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
Resizes the webGL view to the specified width and height.
| Name | Type | Attribute | Description |
|---|---|---|---|
| blendMode | the desired blend mode |
void
Erases the active render target and fills the drawing area with a colour
| Name | Type | Attribute | Description |
|---|---|---|---|
| clearColor | The colour |
void
Sets the transform of the active render target to the given matrix
| Name | Type | Attribute | Description |
|---|---|---|---|
| matrix | The transformation matrix |
void
Erases the render texture and fills the drawing area with a colour
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTexture | The render texture to clear |
||
| clearColor | The colour |
PIXI.WebGLRenderer
Binds a render texture for rendering
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTexture | The render texture to render |
||
| transform | The transform to be applied to the render texture |
PIXI.WebGLRenderer
Changes the current render target to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTarget | the new render target |
PIXI.WebGLRenderer
Changes the current shader to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| shader | the new shader |
||
| autoProject | Whether automatically set the projection matrix |
PIXI.WebGLRenderer
Binds the texture. This will return the location of the bound texture.
It may not be the same as the one you pass in. This is due to optimisation that prevents
needless binding of textures. For example if the texture is already bound it will return the
current location of the texture instead of the one provided. To bypass this use force location
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the new texture |
||
| location | the suggested texture location |
||
| forceLocation | force the location |
PIXI.WebGLRenderer
unbinds the texture ...
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to unbind |
PIXI.WebGLRenderer
Creates a new VAO from this renderer's context and state.
Changes the current Vao to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| vao | the new Vao |
PIXI.WebGLRenderer
Resets the WebGL state so you can render things however you fancy!
PIXI.WebGLRenderer
Handles a lost webgl context
| Name | Type | Attribute | Description |
|---|---|---|---|
| event | The context lost event. |
void
Handles a restored webgl context
void
Removes everything from the renderer (event listeners, spritebatch, etc...)
| Name | Type | Attribute | Description |
|---|---|---|---|
| removeView | Removes the Canvas element from the DOM. |
void
Creates the WebGL context
void
Renders the object to its webGL view
| Name | Type | Attribute | Description |
|---|---|---|---|
| displayObject | the object to be rendered |
||
| renderTexture | The render texture to render to. |
||
| clear | Should the canvas be cleared before the new render |
||
| transform | A transform to apply to the render texture before rendering. |
||
| skipUpdateTransform | Should we skip the update transform pass? |
void
Changes the current renderer to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| objectRenderer | The object renderer to use. |
void
This should be called if you wish to do some custom rendering
It will basically render anything that may be batched up such as sprites
void
Resizes the webGL 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
Resizes the webGL view to the specified width and height.
| Name | Type | Attribute | Description |
|---|---|---|---|
| blendMode | the desired blend mode |
void
Erases the active render target and fills the drawing area with a colour
| Name | Type | Attribute | Description |
|---|---|---|---|
| clearColor | The colour |
void
Sets the transform of the active render target to the given matrix
| Name | Type | Attribute | Description |
|---|---|---|---|
| matrix | The transformation matrix |
void
Erases the render texture and fills the drawing area with a colour
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTexture | The render texture to clear |
||
| clearColor | The colour |
PIXI.WebGLRenderer
Binds a render texture for rendering
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTexture | The render texture to render |
||
| transform | The transform to be applied to the render texture |
PIXI.WebGLRenderer
Changes the current render target to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderTarget | the new render target |
PIXI.WebGLRenderer
Changes the current shader to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| shader | the new shader |
||
| autoProject | Whether automatically set the projection matrix |
PIXI.WebGLRenderer
Binds the texture. This will return the location of the bound texture.
It may not be the same as the one you pass in. This is due to optimisation that prevents
needless binding of textures. For example if the texture is already bound it will return the
current location of the texture instead of the one provided. To bypass this use force location
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the new texture |
||
| location | the suggested texture location |
||
| forceLocation | force the location |
PIXI.WebGLRenderer
unbinds the texture ...
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to unbind |
PIXI.WebGLRenderer
Creates a new VAO from this renderer's context and state.
Changes the current Vao to the one given in parameter
| Name | Type | Attribute | Description |
|---|---|---|---|
| vao | the new Vao |
PIXI.WebGLRenderer
Resets the WebGL state so you can render things however you fancy!
PIXI.WebGLRenderer
Handles a lost webgl context
| Name | Type | Attribute | Description |
|---|---|---|---|
| event | The context lost event. |
void
Handles a restored webgl context
void
Removes everything from the renderer (event listeners, spritebatch, etc...)
| Name | Type | Attribute | Description |
|---|---|---|---|
| removeView | Removes the Canvas element from the DOM. |
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 WebGLRenderer draws the scene and all its content onto a webGL enabled canvas. This renderer\n * should be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.\n * So no need for Sprite Batches or Sprite Clouds.\n * Don't forget to add the view to your DOM or you will not see anything :)\n *\n * @class\n * @memberof PIXI\n * @extends PIXI.SystemRenderer\n */",
"meta": {
"range": [
1225,
21762
],
"filename": "WebGLRenderer.js",
"lineno": 31,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100029846",
"name": "WebGLRenderer",
"type": "ClassDeclaration",
"paramnames": [
"options",
"arg2",
"arg3"
]
}
},
"classdesc": "The WebGLRenderer draws the scene and all its content onto a webGL enabled canvas. This renderer
should be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.
So no need for Sprite Batches or Sprite Clouds.
Don't forget to add the view to your DOM or you will not see anything :)
",
"kind": "class",
"memberof": "PIXI",
"augments": [
"PIXI.SystemRenderer"
],
"name": "WebGLRenderer",
"longname": "PIXI.WebGLRenderer",
"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. If not available natively then FXAA
antialiasing is used
",
"name": "options.antialias"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "forces FXAA antialiasing to be used over native.
FXAA is faster, but may not always look as great
",
"name": "options.forceFXAA"
},
{
"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. If you wish to set this to false, you must set
preserveDrawingBuffer to true.
",
"name": "options.clearBeforeRender"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "enables drawing buffer preservation,
enable this if you need to call toDataUrl on the webgl context.
",
"name": "options.preserveDrawingBuffer"
},
{
"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"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "If true Pixi will aim to ensure compatibility
with older / less advanced devices. If you experiance unexplained flickering try setting this to true.
",
"name": "options.legacy"
}
],
"___id": "T000002R002731",
"___s": true,
"$methods": [
{
"comment": "/**\n * Creates the WebGL context\n *\n * @private\n */",
"meta": {
"range": [
7062,
8642
],
"filename": "WebGLRenderer.js",
"lineno": 197,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030145",
"name": "WebGLRenderer#_initContext",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates the WebGL context
",
"access": "private",
"name": "_initContext",
"longname": "PIXI.WebGLRenderer#_initContext",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002770",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_initContext",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Renders the object to its webGL view\n *\n * @param {PIXI.DisplayObject} displayObject - the object to be rendered\n * @param {PIXI.RenderTexture} renderTexture - The render texture to render to.\n * @param {boolean} [clear] - Should the canvas be cleared before the new render\n * @param {PIXI.Transform} [transform] - A transform to apply to the render texture before rendering.\n * @param {boolean} [skipUpdateTransform] - Should we skip the update transform pass?\n */",
"meta": {
"range": [
9157,
10493
],
"filename": "WebGLRenderer.js",
"lineno": 256,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030362",
"name": "WebGLRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"renderTexture",
"clear",
"transform",
"skipUpdateTransform"
]
},
"vars": {
"": null
}
},
"description": "Renders the object to its webGL view
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "the object to be rendered
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to render to.
",
"name": "renderTexture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Should the canvas be cleared before the new render
",
"name": "clear"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"optional": true,
"description": "A transform to apply to the render texture before rendering.
",
"name": "transform"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Should we skip the update transform pass?
",
"name": "skipUpdateTransform"
}
],
"name": "render",
"longname": "PIXI.WebGLRenderer#render",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002788",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererrender",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current renderer to the one given in parameter\n *\n * @param {PIXI.ObjectRenderer} objectRenderer - The object renderer to use.\n */",
"meta": {
"range": [
10669,
10930
],
"filename": "WebGLRenderer.js",
"lineno": 313,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030500",
"name": "WebGLRenderer#setObjectRenderer",
"type": "MethodDefinition",
"paramnames": [
"objectRenderer"
]
},
"vars": {
"": null
}
},
"description": "Changes the current renderer to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"description": "The object renderer to use.
",
"name": "objectRenderer"
}
],
"name": "setObjectRenderer",
"longname": "PIXI.WebGLRenderer#setObjectRenderer",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002795",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetObjectRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * This should be called if you wish to do some custom rendering\n * It will basically render anything that may be batched up such as sprites\n *\n */",
"meta": {
"range": [
11108,
11179
],
"filename": "WebGLRenderer.js",
"lineno": 330,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030533",
"name": "WebGLRenderer#flush",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "This should be called if you wish to do some custom rendering
It will basically render anything that may be batched up such as sprites
",
"name": "flush",
"longname": "PIXI.WebGLRenderer#flush",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002797",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererflush",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resizes the webGL view to the specified width and height.\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
11405,
12013
],
"filename": "WebGLRenderer.js",
"lineno": 341,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030545",
"name": "WebGLRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the webGL view to the specified width and height.
",
"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.WebGLRenderer#resize",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#resize",
"___id": "T000002R002798",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererresize",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resizes the webGL view to the specified width and height.\n *\n * @param {number} blendMode - the desired blend mode\n */",
"meta": {
"range": [
12165,
12244
],
"filename": "WebGLRenderer.js",
"lineno": 365,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030611",
"name": "WebGLRenderer#setBlendMode",
"type": "MethodDefinition",
"paramnames": [
"blendMode"
]
},
"vars": {
"": null
}
},
"description": "Resizes the webGL view to the specified width and height.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "the desired blend mode
",
"name": "blendMode"
}
],
"name": "setBlendMode",
"longname": "PIXI.WebGLRenderer#setBlendMode",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002800",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetBlendMode",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Erases the active render target and fills the drawing area with a colour\n *\n * @param {number} [clearColor] - The colour\n */",
"meta": {
"range": [
12402,
12483
],
"filename": "WebGLRenderer.js",
"lineno": 375,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030624",
"name": "WebGLRenderer#clear",
"type": "MethodDefinition",
"paramnames": [
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Erases the active render target and fills the drawing area with a colour
",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"description": "The colour
",
"name": "clearColor"
}
],
"name": "clear",
"longname": "PIXI.WebGLRenderer#clear",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002801",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererclear",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Sets the transform of the active render target to the given matrix\n *\n * @param {PIXI.Matrix} matrix - The transformation matrix\n */",
"meta": {
"range": [
12649,
12734
],
"filename": "WebGLRenderer.js",
"lineno": 385,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030637",
"name": "WebGLRenderer#setTransform",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Sets the transform of the active render target to the given matrix
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The transformation matrix
",
"name": "matrix"
}
],
"name": "setTransform",
"longname": "PIXI.WebGLRenderer#setTransform",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002802",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetTransform",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Erases the render texture and fills the drawing area with a colour\n *\n * @param {PIXI.RenderTexture} renderTexture - The render texture to clear\n * @param {number} [clearColor] - The colour\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
13017,
13319
],
"filename": "WebGLRenderer.js",
"lineno": 397,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030650",
"name": "WebGLRenderer#clearRenderTexture",
"type": "MethodDefinition",
"paramnames": [
"renderTexture",
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Erases the render texture and fills the drawing area with a colour
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to clear
",
"name": "renderTexture"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"description": "The colour
",
"name": "clearColor"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "clearRenderTexture",
"longname": "PIXI.WebGLRenderer#clearRenderTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002804",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererclearRenderTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Binds a render texture for rendering\n *\n * @param {PIXI.RenderTexture} renderTexture - The render texture to render\n * @param {PIXI.Transform} transform - The transform to be applied to the render texture\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
13617,
14383
],
"filename": "WebGLRenderer.js",
"lineno": 417,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030683",
"name": "WebGLRenderer#bindRenderTexture",
"type": "MethodDefinition",
"paramnames": [
"renderTexture",
"transform"
]
},
"vars": {
"": null
}
},
"description": "Binds a render texture for rendering
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to render
",
"name": "renderTexture"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"description": "The transform to be applied to the render texture
",
"name": "transform"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindRenderTexture",
"longname": "PIXI.WebGLRenderer#bindRenderTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002807",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindRenderTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current render target to the one given in parameter\n *\n * @param {PIXI.RenderTarget} renderTarget - the new render target\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
14606,
15086
],
"filename": "WebGLRenderer.js",
"lineno": 453,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030765",
"name": "WebGLRenderer#bindRenderTarget",
"type": "MethodDefinition",
"paramnames": [
"renderTarget"
]
},
"vars": {
"": null
}
},
"description": "Changes the current render target to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "the new render target
",
"name": "renderTarget"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindRenderTarget",
"longname": "PIXI.WebGLRenderer#bindRenderTarget",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002813",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindRenderTarget",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current shader to the one given in parameter\n *\n * @param {PIXI.Shader} shader - the new shader\n * @param {boolean} [autoProject=true] - Whether automatically set the projection matrix\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
15376,
16036
],
"filename": "WebGLRenderer.js",
"lineno": 478,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030821",
"name": "WebGLRenderer#bindShader",
"type": "MethodDefinition",
"paramnames": [
"shader",
"autoProject"
]
},
"vars": {
"": null
}
},
"description": "Changes the current shader to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.Shader"
]
},
"description": "the new shader
",
"name": "shader"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": true,
"description": "Whether automatically set the projection matrix
",
"name": "autoProject"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindShader",
"longname": "PIXI.WebGLRenderer#bindShader",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002816",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindShader",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Binds the texture. This will return the location of the bound texture.\n * It may not be the same as the one you pass in. This is due to optimisation that prevents\n * needless binding of textures. For example if the texture is already bound it will return the\n * current location of the texture instead of the one provided. To bypass this use force location\n *\n * @param {PIXI.Texture} texture - the new texture\n * @param {number} location - the suggested texture location\n * @param {boolean} forceLocation - force the location\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
16672,
18086
],
"filename": "WebGLRenderer.js",
"lineno": 510,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100030868",
"name": "WebGLRenderer#bindTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"location",
"forceLocation"
]
},
"vars": {
"": null
}
},
"description": "Binds the texture. This will return the location of the bound texture.
It may not be the same as the one you pass in. This is due to optimisation that prevents
needless binding of textures. For example if the texture is already bound it will return the
current location of the texture instead of the one provided. To bypass this use force location
",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "the new texture
",
"name": "texture"
},
{
"type": {
"names": [
"number"
]
},
"description": "the suggested texture location
",
"name": "location"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "force the location
",
"name": "forceLocation"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindTexture",
"longname": "PIXI.WebGLRenderer#bindTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002819",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * unbinds the texture ...\n *\n * @param {PIXI.Texture} texture - the texture to unbind\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
18260,
18778
],
"filename": "WebGLRenderer.js",
"lineno": 564,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031035",
"name": "WebGLRenderer#unbindTexture",
"type": "MethodDefinition",
"paramnames": [
"texture"
]
},
"vars": {
"": null
}
},
"description": "unbinds the texture ...
",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "the texture to unbind
",
"name": "texture"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "unbindTexture",
"longname": "PIXI.WebGLRenderer#unbindTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002830",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererunbindTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Creates a new VAO from this renderer's context and state.\n *\n * @return {VertexArrayObject} The new VAO.\n */",
"meta": {
"range": [
18920,
19021
],
"filename": "WebGLRenderer.js",
"lineno": 589,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031123",
"name": "WebGLRenderer#createVao",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new VAO from this renderer's context and state.
",
"returns": [
{
"type": {
"names": [
"VertexArrayObject"
]
},
"description": "The new VAO.
"
}
],
"name": "createVao",
"longname": "PIXI.WebGLRenderer#createVao",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002835",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderercreateVao",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current Vao to the one given in parameter\n *\n * @param {PIXI.VertexArrayObject} vao - the new Vao\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
19220,
19590
],
"filename": "WebGLRenderer.js",
"lineno": 600,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031140",
"name": "WebGLRenderer#bindVao",
"type": "MethodDefinition",
"paramnames": [
"vao"
]
},
"vars": {
"": null
}
},
"description": "Changes the current Vao to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.VertexArrayObject"
]
},
"description": "the new Vao
",
"name": "vao"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindVao",
"longname": "PIXI.WebGLRenderer#bindVao",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002836",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindVao",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resets the WebGL state so you can render things however you fancy!\n *\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
19745,
20065
],
"filename": "WebGLRenderer.js",
"lineno": 627,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031182",
"name": "WebGLRenderer#reset",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets the WebGL state so you can render things however you fancy!
",
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "reset",
"longname": "PIXI.WebGLRenderer#reset",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002838",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererreset",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Handles a lost webgl context\n *\n * @private\n * @param {WebGLContextEvent} event - The context lost event.\n */",
"meta": {
"range": [
20212,
20280
],
"filename": "WebGLRenderer.js",
"lineno": 648,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031224",
"name": "WebGLRenderer#handleContextLost",
"type": "MethodDefinition",
"paramnames": [
"event"
]
},
"vars": {
"": null
}
},
"description": "Handles a lost webgl context
",
"access": "private",
"params": [
{
"type": {
"names": [
"WebGLContextEvent"
]
},
"description": "The context lost event.
",
"name": "event"
}
],
"name": "handleContextLost",
"longname": "PIXI.WebGLRenderer#handleContextLost",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R002841",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererhandleContextLost",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Handles a restored webgl context\n *\n * @private\n */",
"meta": {
"range": [
20365,
20470
],
"filename": "WebGLRenderer.js",
"lineno": 658,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031234",
"name": "WebGLRenderer#handleContextRestored",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Handles a restored webgl context
",
"access": "private",
"name": "handleContextRestored",
"longname": "PIXI.WebGLRenderer#handleContextRestored",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R002842",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererhandleContextRestored",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Removes everything from the renderer (event listeners, spritebatch, etc...)\n *\n * @param {boolean} [removeView=false] - Removes the Canvas element from the DOM.\n * See: https://github.com/pixijs/pixi.js/issues/2233\n */",
"meta": {
"range": [
20727,
21760
],
"filename": "WebGLRenderer.js",
"lineno": 670,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100031250",
"name": "WebGLRenderer#destroy",
"type": "MethodDefinition",
"paramnames": [
"removeView"
]
},
"vars": {
"": null
}
},
"description": "Removes everything from the renderer (event listeners, spritebatch, etc...)
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Removes the Canvas element from the DOM.
See: https://github.com/pixijs/pixi.js/issues/2233
",
"name": "removeView"
}
],
"name": "destroy",
"longname": "PIXI.WebGLRenderer#destroy",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#destroy",
"___id": "T000002R002843",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererdestroy",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Creates the WebGL context\n *\n * @private\n */",
"meta": {
"range": [
7062,
8642
],
"filename": "WebGLRenderer.js",
"lineno": 197,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100104824",
"name": "WebGLRenderer#_initContext",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates the WebGL context
",
"access": "private",
"name": "_initContext",
"longname": "PIXI.WebGLRenderer#_initContext",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009704",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_initContext",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Renders the object to its webGL view\n *\n * @param {PIXI.DisplayObject} displayObject - the object to be rendered\n * @param {PIXI.RenderTexture} renderTexture - The render texture to render to.\n * @param {boolean} [clear] - Should the canvas be cleared before the new render\n * @param {PIXI.Transform} [transform] - A transform to apply to the render texture before rendering.\n * @param {boolean} [skipUpdateTransform] - Should we skip the update transform pass?\n */",
"meta": {
"range": [
9157,
10493
],
"filename": "WebGLRenderer.js",
"lineno": 256,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105041",
"name": "WebGLRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"displayObject",
"renderTexture",
"clear",
"transform",
"skipUpdateTransform"
]
},
"vars": {
"": null
}
},
"description": "Renders the object to its webGL view
",
"params": [
{
"type": {
"names": [
"PIXI.DisplayObject"
]
},
"description": "the object to be rendered
",
"name": "displayObject"
},
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to render to.
",
"name": "renderTexture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Should the canvas be cleared before the new render
",
"name": "clear"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"optional": true,
"description": "A transform to apply to the render texture before rendering.
",
"name": "transform"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Should we skip the update transform pass?
",
"name": "skipUpdateTransform"
}
],
"name": "render",
"longname": "PIXI.WebGLRenderer#render",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009722",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererrender",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current renderer to the one given in parameter\n *\n * @param {PIXI.ObjectRenderer} objectRenderer - The object renderer to use.\n */",
"meta": {
"range": [
10669,
10930
],
"filename": "WebGLRenderer.js",
"lineno": 313,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105179",
"name": "WebGLRenderer#setObjectRenderer",
"type": "MethodDefinition",
"paramnames": [
"objectRenderer"
]
},
"vars": {
"": null
}
},
"description": "Changes the current renderer to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"description": "The object renderer to use.
",
"name": "objectRenderer"
}
],
"name": "setObjectRenderer",
"longname": "PIXI.WebGLRenderer#setObjectRenderer",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009729",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetObjectRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * This should be called if you wish to do some custom rendering\n * It will basically render anything that may be batched up such as sprites\n *\n */",
"meta": {
"range": [
11108,
11179
],
"filename": "WebGLRenderer.js",
"lineno": 330,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105212",
"name": "WebGLRenderer#flush",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "This should be called if you wish to do some custom rendering
It will basically render anything that may be batched up such as sprites
",
"name": "flush",
"longname": "PIXI.WebGLRenderer#flush",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009731",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererflush",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resizes the webGL view to the specified width and height.\n *\n * @param {number} screenWidth - the new width of the screen\n * @param {number} screenHeight - the new height of the screen\n */",
"meta": {
"range": [
11405,
12013
],
"filename": "WebGLRenderer.js",
"lineno": 341,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105224",
"name": "WebGLRenderer#resize",
"type": "MethodDefinition",
"paramnames": [
"screenWidth",
"screenHeight"
]
},
"vars": {
"": null
}
},
"description": "Resizes the webGL view to the specified width and height.
",
"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.WebGLRenderer#resize",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#resize",
"___id": "T000002R009732",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererresize",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resizes the webGL view to the specified width and height.\n *\n * @param {number} blendMode - the desired blend mode\n */",
"meta": {
"range": [
12165,
12244
],
"filename": "WebGLRenderer.js",
"lineno": 365,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105290",
"name": "WebGLRenderer#setBlendMode",
"type": "MethodDefinition",
"paramnames": [
"blendMode"
]
},
"vars": {
"": null
}
},
"description": "Resizes the webGL view to the specified width and height.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "the desired blend mode
",
"name": "blendMode"
}
],
"name": "setBlendMode",
"longname": "PIXI.WebGLRenderer#setBlendMode",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009734",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetBlendMode",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Erases the active render target and fills the drawing area with a colour\n *\n * @param {number} [clearColor] - The colour\n */",
"meta": {
"range": [
12402,
12483
],
"filename": "WebGLRenderer.js",
"lineno": 375,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105303",
"name": "WebGLRenderer#clear",
"type": "MethodDefinition",
"paramnames": [
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Erases the active render target and fills the drawing area with a colour
",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"description": "The colour
",
"name": "clearColor"
}
],
"name": "clear",
"longname": "PIXI.WebGLRenderer#clear",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009735",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererclear",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Sets the transform of the active render target to the given matrix\n *\n * @param {PIXI.Matrix} matrix - The transformation matrix\n */",
"meta": {
"range": [
12649,
12734
],
"filename": "WebGLRenderer.js",
"lineno": 385,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105316",
"name": "WebGLRenderer#setTransform",
"type": "MethodDefinition",
"paramnames": [
"matrix"
]
},
"vars": {
"": null
}
},
"description": "Sets the transform of the active render target to the given matrix
",
"params": [
{
"type": {
"names": [
"PIXI.Matrix"
]
},
"description": "The transformation matrix
",
"name": "matrix"
}
],
"name": "setTransform",
"longname": "PIXI.WebGLRenderer#setTransform",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009736",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderersetTransform",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Erases the render texture and fills the drawing area with a colour\n *\n * @param {PIXI.RenderTexture} renderTexture - The render texture to clear\n * @param {number} [clearColor] - The colour\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
13017,
13319
],
"filename": "WebGLRenderer.js",
"lineno": 397,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105329",
"name": "WebGLRenderer#clearRenderTexture",
"type": "MethodDefinition",
"paramnames": [
"renderTexture",
"clearColor"
]
},
"vars": {
"": null
}
},
"description": "Erases the render texture and fills the drawing area with a colour
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to clear
",
"name": "renderTexture"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"description": "The colour
",
"name": "clearColor"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "clearRenderTexture",
"longname": "PIXI.WebGLRenderer#clearRenderTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009738",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererclearRenderTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Binds a render texture for rendering\n *\n * @param {PIXI.RenderTexture} renderTexture - The render texture to render\n * @param {PIXI.Transform} transform - The transform to be applied to the render texture\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
13617,
14383
],
"filename": "WebGLRenderer.js",
"lineno": 417,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105362",
"name": "WebGLRenderer#bindRenderTexture",
"type": "MethodDefinition",
"paramnames": [
"renderTexture",
"transform"
]
},
"vars": {
"": null
}
},
"description": "Binds a render texture for rendering
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The render texture to render
",
"name": "renderTexture"
},
{
"type": {
"names": [
"PIXI.Transform"
]
},
"description": "The transform to be applied to the render texture
",
"name": "transform"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindRenderTexture",
"longname": "PIXI.WebGLRenderer#bindRenderTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009741",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindRenderTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current render target to the one given in parameter\n *\n * @param {PIXI.RenderTarget} renderTarget - the new render target\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
14606,
15086
],
"filename": "WebGLRenderer.js",
"lineno": 453,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105444",
"name": "WebGLRenderer#bindRenderTarget",
"type": "MethodDefinition",
"paramnames": [
"renderTarget"
]
},
"vars": {
"": null
}
},
"description": "Changes the current render target to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "the new render target
",
"name": "renderTarget"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindRenderTarget",
"longname": "PIXI.WebGLRenderer#bindRenderTarget",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009747",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindRenderTarget",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current shader to the one given in parameter\n *\n * @param {PIXI.Shader} shader - the new shader\n * @param {boolean} [autoProject=true] - Whether automatically set the projection matrix\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
15376,
16036
],
"filename": "WebGLRenderer.js",
"lineno": 478,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105500",
"name": "WebGLRenderer#bindShader",
"type": "MethodDefinition",
"paramnames": [
"shader",
"autoProject"
]
},
"vars": {
"": null
}
},
"description": "Changes the current shader to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.Shader"
]
},
"description": "the new shader
",
"name": "shader"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": true,
"description": "Whether automatically set the projection matrix
",
"name": "autoProject"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindShader",
"longname": "PIXI.WebGLRenderer#bindShader",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009750",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindShader",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Binds the texture. This will return the location of the bound texture.\n * It may not be the same as the one you pass in. This is due to optimisation that prevents\n * needless binding of textures. For example if the texture is already bound it will return the\n * current location of the texture instead of the one provided. To bypass this use force location\n *\n * @param {PIXI.Texture} texture - the new texture\n * @param {number} location - the suggested texture location\n * @param {boolean} forceLocation - force the location\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
16672,
18086
],
"filename": "WebGLRenderer.js",
"lineno": 510,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105547",
"name": "WebGLRenderer#bindTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"location",
"forceLocation"
]
},
"vars": {
"": null
}
},
"description": "Binds the texture. This will return the location of the bound texture.
It may not be the same as the one you pass in. This is due to optimisation that prevents
needless binding of textures. For example if the texture is already bound it will return the
current location of the texture instead of the one provided. To bypass this use force location
",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "the new texture
",
"name": "texture"
},
{
"type": {
"names": [
"number"
]
},
"description": "the suggested texture location
",
"name": "location"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "force the location
",
"name": "forceLocation"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindTexture",
"longname": "PIXI.WebGLRenderer#bindTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009753",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * unbinds the texture ...\n *\n * @param {PIXI.Texture} texture - the texture to unbind\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
18260,
18778
],
"filename": "WebGLRenderer.js",
"lineno": 564,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105714",
"name": "WebGLRenderer#unbindTexture",
"type": "MethodDefinition",
"paramnames": [
"texture"
]
},
"vars": {
"": null
}
},
"description": "unbinds the texture ...
",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "the texture to unbind
",
"name": "texture"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "unbindTexture",
"longname": "PIXI.WebGLRenderer#unbindTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009764",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererunbindTexture",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Creates a new VAO from this renderer's context and state.\n *\n * @return {VertexArrayObject} The new VAO.\n */",
"meta": {
"range": [
18920,
19021
],
"filename": "WebGLRenderer.js",
"lineno": 589,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105802",
"name": "WebGLRenderer#createVao",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new VAO from this renderer's context and state.
",
"returns": [
{
"type": {
"names": [
"VertexArrayObject"
]
},
"description": "The new VAO.
"
}
],
"name": "createVao",
"longname": "PIXI.WebGLRenderer#createVao",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009769",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderercreateVao",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Changes the current Vao to the one given in parameter\n *\n * @param {PIXI.VertexArrayObject} vao - the new Vao\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
19220,
19590
],
"filename": "WebGLRenderer.js",
"lineno": 600,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105819",
"name": "WebGLRenderer#bindVao",
"type": "MethodDefinition",
"paramnames": [
"vao"
]
},
"vars": {
"": null
}
},
"description": "Changes the current Vao to the one given in parameter
",
"params": [
{
"type": {
"names": [
"PIXI.VertexArrayObject"
]
},
"description": "the new Vao
",
"name": "vao"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "bindVao",
"longname": "PIXI.WebGLRenderer#bindVao",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009770",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbindVao",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Resets the WebGL state so you can render things however you fancy!\n *\n * @return {PIXI.WebGLRenderer} Returns itself.\n */",
"meta": {
"range": [
19745,
20065
],
"filename": "WebGLRenderer.js",
"lineno": 627,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105861",
"name": "WebGLRenderer#reset",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets the WebGL state so you can render things however you fancy!
",
"returns": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "Returns itself.
"
}
],
"name": "reset",
"longname": "PIXI.WebGLRenderer#reset",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009772",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererreset",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Handles a lost webgl context\n *\n * @private\n * @param {WebGLContextEvent} event - The context lost event.\n */",
"meta": {
"range": [
20212,
20280
],
"filename": "WebGLRenderer.js",
"lineno": 648,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105903",
"name": "WebGLRenderer#handleContextLost",
"type": "MethodDefinition",
"paramnames": [
"event"
]
},
"vars": {
"": null
}
},
"description": "Handles a lost webgl context
",
"access": "private",
"params": [
{
"type": {
"names": [
"WebGLContextEvent"
]
},
"description": "The context lost event.
",
"name": "event"
}
],
"name": "handleContextLost",
"longname": "PIXI.WebGLRenderer#handleContextLost",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"___id": "T000002R009775",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererhandleContextLost",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Handles a restored webgl context\n *\n * @private\n */",
"meta": {
"range": [
20365,
20470
],
"filename": "WebGLRenderer.js",
"lineno": 658,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105913",
"name": "WebGLRenderer#handleContextRestored",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Handles a restored webgl context
",
"access": "private",
"name": "handleContextRestored",
"longname": "PIXI.WebGLRenderer#handleContextRestored",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R009776",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererhandleContextRestored",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Removes everything from the renderer (event listeners, spritebatch, etc...)\n *\n * @param {boolean} [removeView=false] - Removes the Canvas element from the DOM.\n * See: https://github.com/pixijs/pixi.js/issues/2233\n */",
"meta": {
"range": [
20727,
21760
],
"filename": "WebGLRenderer.js",
"lineno": 670,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100105929",
"name": "WebGLRenderer#destroy",
"type": "MethodDefinition",
"paramnames": [
"removeView"
]
},
"vars": {
"": null
}
},
"description": "Removes everything from the renderer (event listeners, spritebatch, etc...)
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Removes the Canvas element from the DOM.
See: https://github.com/pixijs/pixi.js/issues/2233
",
"name": "removeView"
}
],
"name": "destroy",
"longname": "PIXI.WebGLRenderer#destroy",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#destroy",
"___id": "T000002R009777",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererdestroy",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.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.WebGLRenderer#width",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#width",
"inherited": true,
"overrides": "PIXI.SystemRenderer#width",
"___id": "T000002R014015",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererwidth",
"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.WebGLRenderer#height",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#height",
"inherited": true,
"overrides": "PIXI.SystemRenderer#height",
"___id": "T000002R014016",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererheight",
"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.WebGLRenderer#generateTexture",
"kind": "function",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#generateTexture",
"inherited": true,
"overrides": "PIXI.SystemRenderer#generateTexture",
"___id": "T000002R014017",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderergenerateTexture",
"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.WebGLRenderer#backgroundColor",
"memberof": "PIXI.WebGLRenderer",
"scope": "instance",
"params": [],
"inherits": "PIXI.SystemRenderer#backgroundColor",
"inherited": true,
"overrides": "PIXI.SystemRenderer#backgroundColor",
"___id": "T000002R014018",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererbackgroundColor",
"filepath": "core\\renderers\\SystemRenderer.js"
}
],
"$attributes": [
{
"comment": "/**\n * The type of this renderer as a standardised const\n *\n * @member {number} PIXI.WebGLRenderer#type\n * @see PIXI.RENDERER_TYPE\n */",
"meta": {
"range": [
3318,
3492
],
"filename": "WebGLRenderer.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The type of this renderer as a standardised const
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"see": [
"PIXI.RENDERER_TYPE"
],
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#type",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#type",
"___id": "T000002R002735",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderertype",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The options passed in to create a new webgl context.\n *\n * @member {object} PIXI.WebGLRenderer#_contextOptions\n * @private\n */",
"meta": {
"range": [
3871,
4044
],
"filename": "WebGLRenderer.js",
"lineno": 83,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The options passed in to create a new webgl context.
",
"kind": "member",
"name": "_contextOptions",
"type": {
"names": [
"object"
]
},
"access": "private",
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_contextOptions",
"scope": "instance",
"___id": "T000002R002739",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_contextOptions",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the masks using the stencil buffer.\n *\n * @member {PIXI.MaskManager} PIXI.WebGLRenderer#maskManager\n */",
"meta": {
"range": [
4436,
4586
],
"filename": "WebGLRenderer.js",
"lineno": 99,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the masks using the stencil buffer.
",
"kind": "member",
"name": "maskManager",
"type": {
"names": [
"PIXI.MaskManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#maskManager",
"scope": "instance",
"___id": "T000002R002747",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderermaskManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the stencil buffer.\n *\n * @member {PIXI.StencilManager} PIXI.WebGLRenderer#stencilManager\n */",
"meta": {
"range": [
4646,
4786
],
"filename": "WebGLRenderer.js",
"lineno": 106,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the stencil buffer.
",
"kind": "member",
"name": "stencilManager",
"type": {
"names": [
"PIXI.StencilManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#stencilManager",
"scope": "instance",
"___id": "T000002R002749",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererstencilManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * An empty renderer.\n *\n * @member {PIXI.ObjectRenderer} PIXI.WebGLRenderer#emptyRenderer\n */",
"meta": {
"range": [
4852,
4982
],
"filename": "WebGLRenderer.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "An empty renderer.
",
"kind": "member",
"name": "emptyRenderer",
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#emptyRenderer",
"scope": "instance",
"___id": "T000002R002751",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendereremptyRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The currently active ObjectRenderer.\n *\n * @member {PIXI.ObjectRenderer} PIXI.WebGLRenderer#currentRenderer\n */",
"meta": {
"range": [
5047,
5197
],
"filename": "WebGLRenderer.js",
"lineno": 120,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The currently active ObjectRenderer.
",
"kind": "member",
"name": "currentRenderer",
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#currentRenderer",
"scope": "instance",
"___id": "T000002R002753",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderercurrentRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The currently active ObjectRenderer.\n *\n * @member {PIXI.WebGLState} PIXI.WebGLRenderer#state\n */",
"meta": {
"range": [
5799,
5935
],
"filename": "WebGLRenderer.js",
"lineno": 145,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The currently active ObjectRenderer.
",
"kind": "member",
"name": "state",
"type": {
"names": [
"PIXI.WebGLState"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#state",
"scope": "instance",
"___id": "T000002R002757",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererstate",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Holds the current shader\n *\n * @member {PIXI.Shader} PIXI.WebGLRenderer#_activeShader\n */",
"meta": {
"range": [
6181,
6309
],
"filename": "WebGLRenderer.js",
"lineno": 160,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Holds the current shader
",
"kind": "member",
"name": "_activeShader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_activeShader",
"scope": "instance",
"___id": "T000002R002761",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_activeShader",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Holds the current render target\n *\n * @member {PIXI.RenderTarget} PIXI.WebGLRenderer#_activeRenderTarget\n */",
"meta": {
"range": [
6387,
6534
],
"filename": "WebGLRenderer.js",
"lineno": 169,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Holds the current render target
",
"kind": "member",
"name": "_activeRenderTarget",
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_activeRenderTarget",
"scope": "instance",
"___id": "T000002R002764",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_activeRenderTarget",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the filters.\n *\n * @member {PIXI.FilterManager} PIXI.WebGLRenderer#filterManager\n */",
"meta": {
"range": [
6615,
6746
],
"filename": "WebGLRenderer.js",
"lineno": 178,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the filters.
",
"kind": "member",
"name": "filterManager",
"type": {
"names": [
"PIXI.FilterManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#filterManager",
"scope": "instance",
"___id": "T000002R002766",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererfilterManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture\n *\n * @member {PIXI.WebGLExtract} extract\n * @memberof PIXI.WebGLRenderer#\n * @see PIXI.WebGLExtract\n */",
"meta": {
"range": [
565,
828
],
"filename": "WebGLExtract.js",
"lineno": 24,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extract\\webgl",
"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.WebGLExtract"
]
},
"memberof": "PIXI.WebGLRenderer",
"see": [
"PIXI.WebGLExtract"
],
"longname": "PIXI.WebGLRenderer#extract",
"scope": "instance",
"___id": "T000002R004792",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererextract",
"filepath": "extract\\webgl\\WebGLExtract.js"
},
{
"comment": "/**\n * The type of this renderer as a standardised const\n *\n * @member {number} PIXI.WebGLRenderer#type\n * @see PIXI.RENDERER_TYPE\n */",
"meta": {
"range": [
3318,
3492
],
"filename": "WebGLRenderer.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The type of this renderer as a standardised const
",
"kind": "member",
"name": "type",
"type": {
"names": [
"number"
]
},
"see": [
"PIXI.RENDERER_TYPE"
],
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#type",
"scope": "instance",
"overrides": "PIXI.SystemRenderer#type",
"___id": "T000002R009669",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderertype",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The options passed in to create a new webgl context.\n *\n * @member {object} PIXI.WebGLRenderer#_contextOptions\n * @private\n */",
"meta": {
"range": [
3871,
4044
],
"filename": "WebGLRenderer.js",
"lineno": 83,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The options passed in to create a new webgl context.
",
"kind": "member",
"name": "_contextOptions",
"type": {
"names": [
"object"
]
},
"access": "private",
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_contextOptions",
"scope": "instance",
"___id": "T000002R009673",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_contextOptions",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the masks using the stencil buffer.\n *\n * @member {PIXI.MaskManager} PIXI.WebGLRenderer#maskManager\n */",
"meta": {
"range": [
4436,
4586
],
"filename": "WebGLRenderer.js",
"lineno": 99,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the masks using the stencil buffer.
",
"kind": "member",
"name": "maskManager",
"type": {
"names": [
"PIXI.MaskManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#maskManager",
"scope": "instance",
"___id": "T000002R009681",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderermaskManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the stencil buffer.\n *\n * @member {PIXI.StencilManager} PIXI.WebGLRenderer#stencilManager\n */",
"meta": {
"range": [
4646,
4786
],
"filename": "WebGLRenderer.js",
"lineno": 106,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the stencil buffer.
",
"kind": "member",
"name": "stencilManager",
"type": {
"names": [
"PIXI.StencilManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#stencilManager",
"scope": "instance",
"___id": "T000002R009683",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererstencilManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * An empty renderer.\n *\n * @member {PIXI.ObjectRenderer} PIXI.WebGLRenderer#emptyRenderer\n */",
"meta": {
"range": [
4852,
4982
],
"filename": "WebGLRenderer.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "An empty renderer.
",
"kind": "member",
"name": "emptyRenderer",
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#emptyRenderer",
"scope": "instance",
"___id": "T000002R009685",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendereremptyRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The currently active ObjectRenderer.\n *\n * @member {PIXI.ObjectRenderer} PIXI.WebGLRenderer#currentRenderer\n */",
"meta": {
"range": [
5047,
5197
],
"filename": "WebGLRenderer.js",
"lineno": 120,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The currently active ObjectRenderer.
",
"kind": "member",
"name": "currentRenderer",
"type": {
"names": [
"PIXI.ObjectRenderer"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#currentRenderer",
"scope": "instance",
"___id": "T000002R009687",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderercurrentRenderer",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * The currently active ObjectRenderer.\n *\n * @member {PIXI.WebGLState} PIXI.WebGLRenderer#state\n */",
"meta": {
"range": [
5799,
5935
],
"filename": "WebGLRenderer.js",
"lineno": 145,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The currently active ObjectRenderer.
",
"kind": "member",
"name": "state",
"type": {
"names": [
"PIXI.WebGLState"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#state",
"scope": "instance",
"___id": "T000002R009691",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererstate",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Holds the current shader\n *\n * @member {PIXI.Shader} PIXI.WebGLRenderer#_activeShader\n */",
"meta": {
"range": [
6181,
6309
],
"filename": "WebGLRenderer.js",
"lineno": 160,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Holds the current shader
",
"kind": "member",
"name": "_activeShader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_activeShader",
"scope": "instance",
"___id": "T000002R009695",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_activeShader",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Holds the current render target\n *\n * @member {PIXI.RenderTarget} PIXI.WebGLRenderer#_activeRenderTarget\n */",
"meta": {
"range": [
6387,
6534
],
"filename": "WebGLRenderer.js",
"lineno": 169,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Holds the current render target
",
"kind": "member",
"name": "_activeRenderTarget",
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_activeRenderTarget",
"scope": "instance",
"___id": "T000002R009698",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_activeRenderTarget",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Manages the filters.\n *\n * @member {PIXI.FilterManager} PIXI.WebGLRenderer#filterManager\n */",
"meta": {
"range": [
6615,
6746
],
"filename": "WebGLRenderer.js",
"lineno": 178,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Manages the filters.
",
"kind": "member",
"name": "filterManager",
"type": {
"names": [
"PIXI.FilterManager"
]
},
"memberof": "PIXI.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#filterManager",
"scope": "instance",
"___id": "T000002R009700",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererfilterManager",
"filepath": "core\\renderers\\webgl\\WebGLRenderer.js"
},
{
"comment": "/**\n * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture\n *\n * @member {PIXI.WebGLExtract} extract\n * @memberof PIXI.WebGLRenderer#\n * @see PIXI.WebGLExtract\n */",
"meta": {
"range": [
565,
828
],
"filename": "WebGLExtract.js",
"lineno": 24,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extract\\webgl",
"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.WebGLExtract"
]
},
"memberof": "PIXI.WebGLRenderer",
"see": [
"PIXI.WebGLExtract"
],
"longname": "PIXI.WebGLRenderer#extract",
"scope": "instance",
"___id": "T000002R011726",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererextract",
"filepath": "extract\\webgl\\WebGLExtract.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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#options",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#options",
"inherited": true,
"overrides": "PIXI.SystemRenderer#options",
"___id": "T000002R014000",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendereroptions",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#screen",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#screen",
"inherited": true,
"overrides": "PIXI.SystemRenderer#screen",
"___id": "T000002R014001",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererscreen",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#view",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#view",
"inherited": true,
"overrides": "PIXI.SystemRenderer#view",
"___id": "T000002R014002",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererview",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#resolution",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#resolution",
"inherited": true,
"overrides": "PIXI.SystemRenderer#resolution",
"___id": "T000002R014003",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererresolution",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#transparent",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#transparent",
"inherited": true,
"overrides": "PIXI.SystemRenderer#transparent",
"___id": "T000002R014004",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderertransparent",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#autoResize",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#autoResize",
"inherited": true,
"overrides": "PIXI.SystemRenderer#autoResize",
"___id": "T000002R014005",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererautoResize",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#blendModes",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#blendModes",
"inherited": true,
"overrides": "PIXI.SystemRenderer#blendModes",
"___id": "T000002R014006",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererblendModes",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#preserveDrawingBuffer",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#preserveDrawingBuffer",
"inherited": true,
"overrides": "PIXI.SystemRenderer#preserveDrawingBuffer",
"___id": "T000002R014007",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererpreserveDrawingBuffer",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#clearBeforeRender",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#clearBeforeRender",
"inherited": true,
"overrides": "PIXI.SystemRenderer#clearBeforeRender",
"___id": "T000002R014008",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererclearBeforeRender",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#roundPixels",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#roundPixels",
"inherited": true,
"overrides": "PIXI.SystemRenderer#roundPixels",
"___id": "T000002R014009",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRendererroundPixels",
"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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_backgroundColor",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColor",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColor",
"___id": "T000002R014010",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_backgroundColorRgba",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColorRgba",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColorRgba",
"___id": "T000002R014011",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_backgroundColorString",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_backgroundColorString",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_backgroundColorString",
"___id": "T000002R014012",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_tempDisplayObjectParent",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_tempDisplayObjectParent",
"___id": "T000002R014013",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_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.WebGLRenderer",
"longname": "PIXI.WebGLRenderer#_lastObjectRendered",
"scope": "instance",
"inherits": "PIXI.SystemRenderer#_lastObjectRendered",
"inherited": true,
"overrides": "PIXI.SystemRenderer#_lastObjectRendered",
"___id": "T000002R014014",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLRenderer_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\\webgl\\WebGLRenderer.js"
}