Home

class: RenderTarget


Methods summary


Public methods
public clear(clearColor: Array.<number>): void
public attachStencilBuffer(): void
public setFrame(destinationFrame: Rectangle, sourceFrame: Rectangle): void
public activate(): void
public calculateProjection(destinationFrame: Rectangle, sourceFrame: Rectangle): void
public resize(width: number, height: number): void
public destroy(): void
public clear(clearColor: Array.<number>): void
public attachStencilBuffer(): void
public setFrame(destinationFrame: Rectangle, sourceFrame: Rectangle): void
public activate(): void
public calculateProjection(destinationFrame: Rectangle, sourceFrame: Rectangle): void
public resize(width: number, height: number): void
public destroy(): void

Properties


Name Type Attribute Description
gl WebGLRenderingContext public

The current WebGL drawing context.

frameBuffer PIXI.glCore.GLFramebuffer public

A frame buffer

texture PIXI.glCore.GLTexture public

The texture

clearColor Array.<number> public

The background colour of this render target, as an array of [r,g,b,a] values

size PIXI.Rectangle public

The size of the object as a rectangle

resolution number public

The current resolution / device pixel ratio

projectionMatrix PIXI.Matrix public

The projection matrix

transform PIXI.Matrix public

The object's transform

frame PIXI.Rectangle public

The frame.

defaultFrame glCore.GLBuffer public

The stencil buffer stores masking data for the render target

stencilBuffer glCore.GLBuffer public

The stencil buffer stores masking data for the render target

stencilMaskStack Array. public

The data structure for the stencil masks

filterData Array.<object> public

Stores filter data for the render target

scaleMode number public

The scale mode.

root boolean public

Whether this object is the root element or not

gl WebGLRenderingContext public

The current WebGL drawing context.

frameBuffer PIXI.glCore.GLFramebuffer public

A frame buffer

texture PIXI.glCore.GLTexture public

The texture

clearColor Array.<number> public

The background colour of this render target, as an array of [r,g,b,a] values

size PIXI.Rectangle public

The size of the object as a rectangle

resolution number public

The current resolution / device pixel ratio

projectionMatrix PIXI.Matrix public

The projection matrix

transform PIXI.Matrix public

The object's transform

frame PIXI.Rectangle public

The frame.

defaultFrame glCore.GLBuffer public

The stencil buffer stores masking data for the render target

stencilBuffer glCore.GLBuffer public

The stencil buffer stores masking data for the render target

stencilMaskStack Array. public

The data structure for the stencil masks

filterData Array.<object> public

Stores filter data for the render target

scaleMode number public

The scale mode.

root boolean public

Whether this object is the root element or not

Methods


clear(clearColor: Array.<number>): void

Clears the filter texture.

Params:

Name Type Attribute Description
clearColor

Array of [r,g,b,a] to clear the framebuffer

Returns:

void


attachStencilBuffer(): void

Binds the stencil buffer.

Returns:

void


setFrame(destinationFrame: Rectangle, sourceFrame: Rectangle): void

Sets the frame of the render target.

Params:

Name Type Attribute Description
destinationFrame

The destination frame.

sourceFrame

The source frame.

Returns:

void


activate(): void

Binds the buffers and initialises the viewport.

Returns:

void


calculateProjection(destinationFrame: Rectangle, sourceFrame: Rectangle): void

Updates the projection matrix based on a projection frame (which is a rectangle)

Params:

Name Type Attribute Description
destinationFrame

The destination frame.

sourceFrame

The source frame.

Returns:

void


resize(width: number, height: number): void

Resizes the texture to the specified width and height

Params:

Name Type Attribute Description
width

the new width of the texture

height

the new height of the texture

Returns:

void


destroy(): void

Destroys the render target.

Returns:

void


clear(clearColor: Array.<number>): void

Clears the filter texture.

Params:

Name Type Attribute Description
clearColor

Array of [r,g,b,a] to clear the framebuffer

Returns:

void


attachStencilBuffer(): void

Binds the stencil buffer.

Returns:

void


setFrame(destinationFrame: Rectangle, sourceFrame: Rectangle): void

Sets the frame of the render target.

Params:

Name Type Attribute Description
destinationFrame

The destination frame.

sourceFrame

The source frame.

Returns:

void


activate(): void

Binds the buffers and initialises the viewport.

Returns:

void


calculateProjection(destinationFrame: Rectangle, sourceFrame: Rectangle): void

Updates the projection matrix based on a projection frame (which is a rectangle)

Params:

Name Type Attribute Description
destinationFrame

The destination frame.

sourceFrame

The source frame.

Returns:

void


resize(width: number, height: number): void

Resizes the texture to the specified width and height

Params:

Name Type Attribute Description
width

the new width of the texture

height

the new height of the texture

Returns:

void


destroy(): void

Destroys the render target.

Returns:

void


  {
    "comment": "/**\n * @class\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            252,
            9116
        ],
        "filename": "RenderTarget.js",
        "lineno": 12,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils",
        "code": {
            "id": "astnode100029036",
            "name": "RenderTarget",
            "type": "ClassDeclaration",
            "paramnames": [
                "gl",
                "width",
                "height",
                "scaleMode",
                "resolution",
                "root"
            ]
        }
    },
    "kind": "class",
    "memberof": "PIXI",
    "name": "RenderTarget",
    "longname": "PIXI.RenderTarget",
    "scope": "static",
    "params": [
        {
            "type": {
                "names": [
                    "WebGLRenderingContext"
                ]
            },
            "description": "

The current WebGL drawing context

", "name": "gl" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

the horizontal range of the filter

", "name": "width" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

the vertical range of the filter

", "name": "height" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.settings.SCALE_MODE", "description": "

See {@link PIXI.SCALE_MODES} for possible values

", "name": "scaleMode" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "

The current resolution / device pixel ratio

", "name": "resolution" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Whether this object is the root element or not

", "name": "root" } ], "___id": "T000002R002658", "___s": true, "$methods": [ { "comment": "/**\n * Clears the filter texture.\n *\n * @param {number[]} [clearColor=this.clearColor] - Array of [r,g,b,a] to clear the framebuffer\n */", "meta": { "range": [ 5007, 5159 ], "filename": "RenderTarget.js", "lineno": 175, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029260", "name": "RenderTarget#clear", "type": "MethodDefinition", "paramnames": [ "clearColor" ] }, "vars": { "": null } }, "description": "

Clears the filter texture.

", "params": [ { "type": { "names": [ "Array." ] }, "optional": true, "defaultvalue": "this.clearColor", "description": "

Array of [r,g,b,a] to clear the framebuffer

", "name": "clearColor" } ], "name": "clear", "longname": "PIXI.RenderTarget#clear", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R002696", "___s": true, "skip": true, "slug": "PIXI.RenderTargetclear", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Binds the stencil buffer.\n *\n */", "meta": { "range": [ 5221, 5539 ], "filename": "RenderTarget.js", "lineno": 186, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029292", "name": "RenderTarget#attachStencilBuffer", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Binds the stencil buffer.

", "name": "attachStencilBuffer", "longname": "PIXI.RenderTarget#attachStencilBuffer", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R002698", "___s": true, "skip": true, "slug": "PIXI.RenderTargetattachStencilBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Sets the frame of the render target.\n *\n * @param {Rectangle} destinationFrame - The destination frame.\n * @param {Rectangle} sourceFrame - The source frame.\n */", "meta": { "range": [ 5738, 5965 ], "filename": "RenderTarget.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029309", "name": "RenderTarget#setFrame", "type": "MethodDefinition", "paramnames": [ "destinationFrame", "sourceFrame" ] }, "vars": { "": null } }, "description": "

Sets the frame of the render target.

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

The destination frame.

", "name": "destinationFrame" }, { "type": { "names": [ "Rectangle" ] }, "description": "

The source frame.

", "name": "sourceFrame" } ], "name": "setFrame", "longname": "PIXI.RenderTarget#setFrame", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R002699", "___s": true, "skip": true, "slug": "PIXI.RenderTargetsetFrame", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Binds the buffers and initialises the viewport.\n *\n */", "meta": { "range": [ 6049, 7220 ], "filename": "RenderTarget.js", "lineno": 215, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029341", "name": "RenderTarget#activate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Binds the buffers and initialises the viewport.

", "name": "activate", "longname": "PIXI.RenderTarget#activate", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R002702", "___s": true, "skip": true, "slug": "PIXI.RenderTargetactivate", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Updates the projection matrix based on a projection frame (which is a rectangle)\n *\n * @param {Rectangle} destinationFrame - The destination frame.\n * @param {Rectangle} sourceFrame - The source frame.\n */", "meta": { "range": [ 7463, 8169 ], "filename": "RenderTarget.js", "lineno": 261, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029492", "name": "RenderTarget#calculateProjection", "type": "MethodDefinition", "paramnames": [ "destinationFrame", "sourceFrame" ] }, "vars": { "": null } }, "description": "

Updates the projection matrix based on a projection frame (which is a rectangle)

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

The destination frame.

", "name": "destinationFrame" }, { "type": { "names": [ "Rectangle" ] }, "description": "

The source frame.

", "name": "sourceFrame" } ], "name": "calculateProjection", "longname": "PIXI.RenderTarget#calculateProjection", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R002704", "___s": true, "skip": true, "slug": "PIXI.RenderTargetcalculateProjection", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Resizes the texture to the specified width and height\n *\n * @param {number} width - the new width of the texture\n * @param {number} height - the new height of the texture\n */", "meta": { "range": [ 8381, 8930 ], "filename": "RenderTarget.js", "lineno": 294, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029630", "name": "RenderTarget#resize", "type": "MethodDefinition", "paramnames": [ "width", "height" ] }, "vars": { "": null } }, "description": "

Resizes the texture to the specified width and height

", "params": [ { "type": { "names": [ "number" ] }, "description": "

the new width of the texture

", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "

the new height of the texture

", "name": "height" } ], "name": "resize", "longname": "PIXI.RenderTarget#resize", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R002715", "___s": true, "skip": true, "slug": "PIXI.RenderTargetresize", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Destroys the render target.\n *\n */", "meta": { "range": [ 8994, 9114 ], "filename": "RenderTarget.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100029731", "name": "RenderTarget#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the render target.

", "name": "destroy", "longname": "PIXI.RenderTarget#destroy", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R002723", "___s": true, "skip": true, "slug": "PIXI.RenderTargetdestroy", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Clears the filter texture.\n *\n * @param {number[]} [clearColor=this.clearColor] - Array of [r,g,b,a] to clear the framebuffer\n */", "meta": { "range": [ 5007, 5159 ], "filename": "RenderTarget.js", "lineno": 175, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103939", "name": "RenderTarget#clear", "type": "MethodDefinition", "paramnames": [ "clearColor" ] }, "vars": { "": null } }, "description": "

Clears the filter texture.

", "params": [ { "type": { "names": [ "Array." ] }, "optional": true, "defaultvalue": "this.clearColor", "description": "

Array of [r,g,b,a] to clear the framebuffer

", "name": "clearColor" } ], "name": "clear", "longname": "PIXI.RenderTarget#clear", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R009630", "___s": true, "skip": true, "slug": "PIXI.RenderTargetclear", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Binds the stencil buffer.\n *\n */", "meta": { "range": [ 5221, 5539 ], "filename": "RenderTarget.js", "lineno": 186, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103971", "name": "RenderTarget#attachStencilBuffer", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Binds the stencil buffer.

", "name": "attachStencilBuffer", "longname": "PIXI.RenderTarget#attachStencilBuffer", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R009632", "___s": true, "skip": true, "slug": "PIXI.RenderTargetattachStencilBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Sets the frame of the render target.\n *\n * @param {Rectangle} destinationFrame - The destination frame.\n * @param {Rectangle} sourceFrame - The source frame.\n */", "meta": { "range": [ 5738, 5965 ], "filename": "RenderTarget.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103988", "name": "RenderTarget#setFrame", "type": "MethodDefinition", "paramnames": [ "destinationFrame", "sourceFrame" ] }, "vars": { "": null } }, "description": "

Sets the frame of the render target.

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

The destination frame.

", "name": "destinationFrame" }, { "type": { "names": [ "Rectangle" ] }, "description": "

The source frame.

", "name": "sourceFrame" } ], "name": "setFrame", "longname": "PIXI.RenderTarget#setFrame", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R009633", "___s": true, "skip": true, "slug": "PIXI.RenderTargetsetFrame", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Binds the buffers and initialises the viewport.\n *\n */", "meta": { "range": [ 6049, 7220 ], "filename": "RenderTarget.js", "lineno": 215, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100104020", "name": "RenderTarget#activate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Binds the buffers and initialises the viewport.

", "name": "activate", "longname": "PIXI.RenderTarget#activate", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R009636", "___s": true, "skip": true, "slug": "PIXI.RenderTargetactivate", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Updates the projection matrix based on a projection frame (which is a rectangle)\n *\n * @param {Rectangle} destinationFrame - The destination frame.\n * @param {Rectangle} sourceFrame - The source frame.\n */", "meta": { "range": [ 7463, 8169 ], "filename": "RenderTarget.js", "lineno": 261, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100104171", "name": "RenderTarget#calculateProjection", "type": "MethodDefinition", "paramnames": [ "destinationFrame", "sourceFrame" ] }, "vars": { "": null } }, "description": "

Updates the projection matrix based on a projection frame (which is a rectangle)

", "params": [ { "type": { "names": [ "Rectangle" ] }, "description": "

The destination frame.

", "name": "destinationFrame" }, { "type": { "names": [ "Rectangle" ] }, "description": "

The source frame.

", "name": "sourceFrame" } ], "name": "calculateProjection", "longname": "PIXI.RenderTarget#calculateProjection", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R009638", "___s": true, "skip": true, "slug": "PIXI.RenderTargetcalculateProjection", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Resizes the texture to the specified width and height\n *\n * @param {number} width - the new width of the texture\n * @param {number} height - the new height of the texture\n */", "meta": { "range": [ 8381, 8930 ], "filename": "RenderTarget.js", "lineno": 294, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100104309", "name": "RenderTarget#resize", "type": "MethodDefinition", "paramnames": [ "width", "height" ] }, "vars": { "": null } }, "description": "

Resizes the texture to the specified width and height

", "params": [ { "type": { "names": [ "number" ] }, "description": "

the new width of the texture

", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "

the new height of the texture

", "name": "height" } ], "name": "resize", "longname": "PIXI.RenderTarget#resize", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "___id": "T000002R009649", "___s": true, "skip": true, "slug": "PIXI.RenderTargetresize", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Destroys the render target.\n *\n */", "meta": { "range": [ 8994, 9114 ], "filename": "RenderTarget.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100104410", "name": "RenderTarget#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the render target.

", "name": "destroy", "longname": "PIXI.RenderTarget#destroy", "kind": "function", "memberof": "PIXI.RenderTarget", "scope": "instance", "params": [], "___id": "T000002R009657", "___s": true, "skip": true, "slug": "PIXI.RenderTargetdestroy", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" } ], "$attributes": [ { "comment": "/**\n * The current WebGL drawing context.\n *\n * @member {WebGLRenderingContext} PIXI.RenderTarget#gl\n */", "meta": { "range": [ 927, 1063 ], "filename": "RenderTarget.js", "lineno": 26, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The current WebGL drawing context.

", "kind": "member", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#gl", "scope": "instance", "___id": "T000002R002660", "___s": true, "skip": true, "slug": "PIXI.RenderTargetgl", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * A frame buffer\n *\n * @member {PIXI.glCore.GLFramebuffer} PIXI.RenderTarget#frameBuffer\n */", "meta": { "range": [ 1154, 1283 ], "filename": "RenderTarget.js", "lineno": 35, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

A frame buffer

", "kind": "member", "name": "frameBuffer", "type": { "names": [ "PIXI.glCore.GLFramebuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#frameBuffer", "scope": "instance", "___id": "T000002R002662", "___s": true, "skip": true, "slug": "PIXI.RenderTargetframeBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The texture\n *\n * @member {PIXI.glCore.GLTexture} PIXI.RenderTarget#texture\n */", "meta": { "range": [ 1326, 1444 ], "filename": "RenderTarget.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The texture

", "kind": "member", "name": "texture", "type": { "names": [ "PIXI.glCore.GLTexture" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#texture", "scope": "instance", "___id": "T000002R002664", "___s": true, "skip": true, "slug": "PIXI.RenderTargettexture", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The background colour of this render target, as an array of [r,g,b,a] values\n *\n * @member {number[]} PIXI.RenderTarget#clearColor\n */", "meta": { "range": [ 1483, 1656 ], "filename": "RenderTarget.js", "lineno": 49, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The background colour of this render target, as an array of [r,g,b,a] values

", "kind": "member", "name": "clearColor", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#clearColor", "scope": "instance", "___id": "T000002R002666", "___s": true, "skip": true, "slug": "PIXI.RenderTargetclearColor", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The size of the object as a rectangle\n *\n * @member {PIXI.Rectangle} PIXI.RenderTarget#size\n */", "meta": { "range": [ 1706, 1840 ], "filename": "RenderTarget.js", "lineno": 56, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The size of the object as a rectangle

", "kind": "member", "name": "size", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#size", "scope": "instance", "___id": "T000002R002668", "___s": true, "skip": true, "slug": "PIXI.RenderTargetsize", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The current resolution / device pixel ratio\n *\n * @member {number} PIXI.RenderTarget#resolution\n * @default 1\n */", "meta": { "range": [ 1897, 2057 ], "filename": "RenderTarget.js", "lineno": 63, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The current resolution / device pixel ratio

", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#resolution", "scope": "instance", "___id": "T000002R002670", "___s": true, "skip": true, "slug": "PIXI.RenderTargetresolution", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The projection matrix\n *\n * @member {PIXI.Matrix} PIXI.RenderTarget#projectionMatrix\n */", "meta": { "range": [ 2128, 2255 ], "filename": "RenderTarget.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The projection matrix

", "kind": "member", "name": "projectionMatrix", "type": { "names": [ "PIXI.Matrix" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#projectionMatrix", "scope": "instance", "___id": "T000002R002672", "___s": true, "skip": true, "slug": "PIXI.RenderTargetprojectionMatrix", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The object's transform\n *\n * @member {PIXI.Matrix} PIXI.RenderTarget#transform\n */", "meta": { "range": [ 2311, 2432 ], "filename": "RenderTarget.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The object's transform

", "kind": "member", "name": "transform", "type": { "names": [ "PIXI.Matrix" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#transform", "scope": "instance", "___id": "T000002R002674", "___s": true, "skip": true, "slug": "PIXI.RenderTargettransform", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The frame.\n *\n * @member {PIXI.Rectangle} PIXI.RenderTarget#frame\n */", "meta": { "range": [ 2473, 2581 ], "filename": "RenderTarget.js", "lineno": 85, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The frame.

", "kind": "member", "name": "frame", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#frame", "scope": "instance", "___id": "T000002R002676", "___s": true, "skip": true, "slug": "PIXI.RenderTargetframe", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The stencil buffer stores masking data for the render target\n *\n * @member {glCore.GLBuffer} PIXI.RenderTarget#defaultFrame\n */", "meta": { "range": [ 2618, 2784 ], "filename": "RenderTarget.js", "lineno": 92, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The stencil buffer stores masking data for the render target

", "kind": "member", "name": "defaultFrame", "type": { "names": [ "glCore.GLBuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#defaultFrame", "scope": "instance", "___id": "T000002R002678", "___s": true, "skip": true, "slug": "PIXI.RenderTargetdefaultFrame", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The stencil buffer stores masking data for the render target\n *\n * @member {glCore.GLBuffer} PIXI.RenderTarget#stencilBuffer\n */", "meta": { "range": [ 2910, 3077 ], "filename": "RenderTarget.js", "lineno": 101, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The stencil buffer stores masking data for the render target

", "kind": "member", "name": "stencilBuffer", "type": { "names": [ "glCore.GLBuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#stencilBuffer", "scope": "instance", "___id": "T000002R002682", "___s": true, "skip": true, "slug": "PIXI.RenderTargetstencilBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The data structure for the stencil masks\n *\n * @member {PIXI.Graphics[]} PIXI.RenderTarget#stencilMaskStack\n */", "meta": { "range": [ 3122, 3272 ], "filename": "RenderTarget.js", "lineno": 108, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The data structure for the stencil masks

", "kind": "member", "name": "stencilMaskStack", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#stencilMaskStack", "scope": "instance", "___id": "T000002R002684", "___s": true, "skip": true, "slug": "PIXI.RenderTargetstencilMaskStack", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Stores filter data for the render target\n *\n * @member {object[]} PIXI.RenderTarget#filterData\n */", "meta": { "range": [ 3318, 3455 ], "filename": "RenderTarget.js", "lineno": 115, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

Stores filter data for the render target

", "kind": "member", "name": "filterData", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#filterData", "scope": "instance", "___id": "T000002R002686", "___s": true, "skip": true, "slug": "PIXI.RenderTargetfilterData", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The scale mode.\n *\n * @member {number} PIXI.RenderTarget#scaleMode\n * @default PIXI.settings.SCALE_MODE\n * @see PIXI.SCALE_MODES\n */", "meta": { "range": [ 3497, 3684 ], "filename": "RenderTarget.js", "lineno": 122, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The scale mode.

", "kind": "member", "name": "scaleMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.settings.SCALE_MODE", "see": [ "PIXI.SCALE_MODES" ], "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#scaleMode", "scope": "instance", "___id": "T000002R002688", "___s": true, "skip": true, "slug": "PIXI.RenderTargetscaleMode", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Whether this object is the root element or not\n *\n * @member {boolean} PIXI.RenderTarget#root\n */", "meta": { "range": [ 3778, 3914 ], "filename": "RenderTarget.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

Whether this object is the root element or not

", "kind": "member", "name": "root", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#root", "scope": "instance", "___id": "T000002R002690", "___s": true, "skip": true, "slug": "PIXI.RenderTargetroot", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The current WebGL drawing context.\n *\n * @member {WebGLRenderingContext} PIXI.RenderTarget#gl\n */", "meta": { "range": [ 927, 1063 ], "filename": "RenderTarget.js", "lineno": 26, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The current WebGL drawing context.

", "kind": "member", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#gl", "scope": "instance", "___id": "T000002R009594", "___s": true, "skip": true, "slug": "PIXI.RenderTargetgl", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * A frame buffer\n *\n * @member {PIXI.glCore.GLFramebuffer} PIXI.RenderTarget#frameBuffer\n */", "meta": { "range": [ 1154, 1283 ], "filename": "RenderTarget.js", "lineno": 35, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

A frame buffer

", "kind": "member", "name": "frameBuffer", "type": { "names": [ "PIXI.glCore.GLFramebuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#frameBuffer", "scope": "instance", "___id": "T000002R009596", "___s": true, "skip": true, "slug": "PIXI.RenderTargetframeBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The texture\n *\n * @member {PIXI.glCore.GLTexture} PIXI.RenderTarget#texture\n */", "meta": { "range": [ 1326, 1444 ], "filename": "RenderTarget.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The texture

", "kind": "member", "name": "texture", "type": { "names": [ "PIXI.glCore.GLTexture" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#texture", "scope": "instance", "___id": "T000002R009598", "___s": true, "skip": true, "slug": "PIXI.RenderTargettexture", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The background colour of this render target, as an array of [r,g,b,a] values\n *\n * @member {number[]} PIXI.RenderTarget#clearColor\n */", "meta": { "range": [ 1483, 1656 ], "filename": "RenderTarget.js", "lineno": 49, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The background colour of this render target, as an array of [r,g,b,a] values

", "kind": "member", "name": "clearColor", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#clearColor", "scope": "instance", "___id": "T000002R009600", "___s": true, "skip": true, "slug": "PIXI.RenderTargetclearColor", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The size of the object as a rectangle\n *\n * @member {PIXI.Rectangle} PIXI.RenderTarget#size\n */", "meta": { "range": [ 1706, 1840 ], "filename": "RenderTarget.js", "lineno": 56, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The size of the object as a rectangle

", "kind": "member", "name": "size", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#size", "scope": "instance", "___id": "T000002R009602", "___s": true, "skip": true, "slug": "PIXI.RenderTargetsize", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The current resolution / device pixel ratio\n *\n * @member {number} PIXI.RenderTarget#resolution\n * @default 1\n */", "meta": { "range": [ 1897, 2057 ], "filename": "RenderTarget.js", "lineno": 63, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The current resolution / device pixel ratio

", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#resolution", "scope": "instance", "___id": "T000002R009604", "___s": true, "skip": true, "slug": "PIXI.RenderTargetresolution", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The projection matrix\n *\n * @member {PIXI.Matrix} PIXI.RenderTarget#projectionMatrix\n */", "meta": { "range": [ 2128, 2255 ], "filename": "RenderTarget.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The projection matrix

", "kind": "member", "name": "projectionMatrix", "type": { "names": [ "PIXI.Matrix" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#projectionMatrix", "scope": "instance", "___id": "T000002R009606", "___s": true, "skip": true, "slug": "PIXI.RenderTargetprojectionMatrix", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The object's transform\n *\n * @member {PIXI.Matrix} PIXI.RenderTarget#transform\n */", "meta": { "range": [ 2311, 2432 ], "filename": "RenderTarget.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The object's transform

", "kind": "member", "name": "transform", "type": { "names": [ "PIXI.Matrix" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#transform", "scope": "instance", "___id": "T000002R009608", "___s": true, "skip": true, "slug": "PIXI.RenderTargettransform", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The frame.\n *\n * @member {PIXI.Rectangle} PIXI.RenderTarget#frame\n */", "meta": { "range": [ 2473, 2581 ], "filename": "RenderTarget.js", "lineno": 85, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The frame.

", "kind": "member", "name": "frame", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#frame", "scope": "instance", "___id": "T000002R009610", "___s": true, "skip": true, "slug": "PIXI.RenderTargetframe", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The stencil buffer stores masking data for the render target\n *\n * @member {glCore.GLBuffer} PIXI.RenderTarget#defaultFrame\n */", "meta": { "range": [ 2618, 2784 ], "filename": "RenderTarget.js", "lineno": 92, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The stencil buffer stores masking data for the render target

", "kind": "member", "name": "defaultFrame", "type": { "names": [ "glCore.GLBuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#defaultFrame", "scope": "instance", "___id": "T000002R009612", "___s": true, "skip": true, "slug": "PIXI.RenderTargetdefaultFrame", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The stencil buffer stores masking data for the render target\n *\n * @member {glCore.GLBuffer} PIXI.RenderTarget#stencilBuffer\n */", "meta": { "range": [ 2910, 3077 ], "filename": "RenderTarget.js", "lineno": 101, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The stencil buffer stores masking data for the render target

", "kind": "member", "name": "stencilBuffer", "type": { "names": [ "glCore.GLBuffer" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#stencilBuffer", "scope": "instance", "___id": "T000002R009616", "___s": true, "skip": true, "slug": "PIXI.RenderTargetstencilBuffer", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The data structure for the stencil masks\n *\n * @member {PIXI.Graphics[]} PIXI.RenderTarget#stencilMaskStack\n */", "meta": { "range": [ 3122, 3272 ], "filename": "RenderTarget.js", "lineno": 108, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The data structure for the stencil masks

", "kind": "member", "name": "stencilMaskStack", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#stencilMaskStack", "scope": "instance", "___id": "T000002R009618", "___s": true, "skip": true, "slug": "PIXI.RenderTargetstencilMaskStack", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Stores filter data for the render target\n *\n * @member {object[]} PIXI.RenderTarget#filterData\n */", "meta": { "range": [ 3318, 3455 ], "filename": "RenderTarget.js", "lineno": 115, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

Stores filter data for the render target

", "kind": "member", "name": "filterData", "type": { "names": [ "Array." ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#filterData", "scope": "instance", "___id": "T000002R009620", "___s": true, "skip": true, "slug": "PIXI.RenderTargetfilterData", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * The scale mode.\n *\n * @member {number} PIXI.RenderTarget#scaleMode\n * @default PIXI.settings.SCALE_MODE\n * @see PIXI.SCALE_MODES\n */", "meta": { "range": [ 3497, 3684 ], "filename": "RenderTarget.js", "lineno": 122, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

The scale mode.

", "kind": "member", "name": "scaleMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.settings.SCALE_MODE", "see": [ "PIXI.SCALE_MODES" ], "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#scaleMode", "scope": "instance", "___id": "T000002R009622", "___s": true, "skip": true, "slug": "PIXI.RenderTargetscaleMode", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }, { "comment": "/**\n * Whether this object is the root element or not\n *\n * @member {boolean} PIXI.RenderTarget#root\n */", "meta": { "range": [ 3778, 3914 ], "filename": "RenderTarget.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": {} }, "description": "

Whether this object is the root element or not

", "kind": "member", "name": "root", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.RenderTarget", "longname": "PIXI.RenderTarget#root", "scope": "instance", "___id": "T000002R009624", "___s": true, "skip": true, "slug": "PIXI.RenderTargetroot", "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [], "$augmentedBy": [], "filepath": "core\\renderers\\webgl\\utils\\RenderTarget.js" }