The BlurFilter applies a Gaussian blur to an object.
The strength of the blur can be set for x- and y-axis separately.
| Public methods | |
|---|---|
| public | apply(filterManager: PIXI.FilterManager, input: PIXI.RenderTarget, output: PIXI.RenderTarget): void |
| public | blur(): void |
| public | quality(): void |
| public | blurX(): void |
| public | blurY(): void |
| public | apply(filterManager: PIXI.FilterManager, input: PIXI.RenderTarget, output: PIXI.RenderTarget): void |
| public | blur(): void |
| public | quality(): void |
| public | blurX(): void |
| public | blurY(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| vertexSrc | string | public | The vertex shader. |
| fragmentSrc | string | public | The fragment shader. |
| uniforms | object | public | An object containing the current values of custom uniforms. |
| padding | number | public | The padding of the filter. Some filters require extra space to breath such as a blur. |
| resolution | number | public | The resolution of the filter. Setting this to be lower will lower the quality but |
| enabled | boolean | public | If enabled is true the filter is applied, if false it will not. |
| autoFit | boolean | public | If enabled, pixi will fit the filter area into boundaries for better performance. |
Applies the filter.
| Name | Type | Attribute | Description |
|---|---|---|---|
| filterManager | The manager. |
||
| input | The input target. |
||
| output | The output target. |
void
Sets the strength of both the blurX and blurY properties simultaneously
void
Sets the number of passes for blur. More passes means higher quaility bluring.
void
Sets the strength of the blurX property
void
Sets the strength of the blurY property
void
Applies the filter.
| Name | Type | Attribute | Description |
|---|---|---|---|
| filterManager | The manager. |
||
| input | The input target. |
||
| output | The output target. |
void
Sets the strength of both the blurX and blurY properties simultaneously
void
Sets the number of passes for blur. More passes means higher quaility bluring.
void
Sets the strength of the blurX property
void
Sets the strength of the blurY property
void
{
"comment": "/**\n * The BlurFilter applies a Gaussian blur to an object.\n * The strength of the blur can be set for x- and y-axis separately.\n *\n * @class\n * @extends PIXI.Filter\n * @memberof PIXI.filters\n */",
"meta": {
"range": [
343,
3316
],
"filename": "BlurFilter.js",
"lineno": 15,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100056991",
"name": "BlurFilter",
"type": "ClassDeclaration",
"paramnames": [
"strength",
"quality",
"resolution",
"kernelSize"
]
}
},
"classdesc": "The BlurFilter applies a Gaussian blur to an object.
The strength of the blur can be set for x- and y-axis separately.
",
"kind": "class",
"augments": [
"PIXI.Filter"
],
"memberof": "PIXI.filters",
"name": "BlurFilter",
"longname": "PIXI.filters.BlurFilter",
"scope": "static",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The strength of the blur filter.
",
"name": "strength"
},
{
"type": {
"names": [
"number"
]
},
"description": "The quality of the blur filter.
",
"name": "quality"
},
{
"type": {
"names": [
"number"
]
},
"description": "The resolution of the blur filter.
",
"name": "resolution"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 5,
"description": "The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.
",
"name": "kernelSize"
}
],
"___id": "T000002R005351",
"___s": true,
"$methods": [
{
"comment": "/**\n * Applies the filter.\n *\n * @param {PIXI.FilterManager} filterManager - The manager.\n * @param {PIXI.RenderTarget} input - The input target.\n * @param {PIXI.RenderTarget} output - The output target.\n */",
"meta": {
"range": [
1374,
1695
],
"filename": "BlurFilter.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100057064",
"name": "BlurFilter#apply",
"type": "MethodDefinition",
"paramnames": [
"filterManager",
"input",
"output"
]
},
"vars": {
"": null
}
},
"description": "Applies the filter.
",
"params": [
{
"type": {
"names": [
"PIXI.FilterManager"
]
},
"description": "The manager.
",
"name": "filterManager"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The input target.
",
"name": "input"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The output target.
",
"name": "output"
}
],
"name": "apply",
"longname": "PIXI.filters.BlurFilter#apply",
"kind": "function",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"overrides": "PIXI.Filter#apply",
"___id": "T000002R005359",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterapply",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of both the blurX and blurY properties simultaneously\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
1845,
1905
],
"filename": "BlurFilter.js",
"lineno": 59,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100057107",
"name": "BlurFilter#blur",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of both the blurX and blurY properties simultaneously
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blur",
"longname": "PIXI.filters.BlurFilter#blur",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R005361",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblur",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the number of passes for blur. More passes means higher quaility bluring.\n *\n * @member {number}\n * @default 1\n */",
"meta": {
"range": [
2306,
2372
],
"filename": "BlurFilter.js",
"lineno": 76,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100057165",
"name": "BlurFilter#quality",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the number of passes for blur. More passes means higher quaility bluring.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"name": "quality",
"longname": "PIXI.filters.BlurFilter#quality",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R005366",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterquality",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of the blurX property\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
2632,
2693
],
"filename": "BlurFilter.js",
"lineno": 92,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100057194",
"name": "BlurFilter#blurX",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of the blurX property
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blurX",
"longname": "PIXI.filters.BlurFilter#blurX",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R005370",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblurX",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of the blurY property\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
3032,
3093
],
"filename": "BlurFilter.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100057246",
"name": "BlurFilter#blurY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of the blurY property
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blurY",
"longname": "PIXI.filters.BlurFilter#blurY",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R005374",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblurY",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Applies the filter.\n *\n * @param {PIXI.FilterManager} filterManager - The manager.\n * @param {PIXI.RenderTarget} input - The input target.\n * @param {PIXI.RenderTarget} output - The output target.\n */",
"meta": {
"range": [
1374,
1695
],
"filename": "BlurFilter.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100131743",
"name": "BlurFilter#apply",
"type": "MethodDefinition",
"paramnames": [
"filterManager",
"input",
"output"
]
},
"vars": {
"": null
}
},
"description": "Applies the filter.
",
"params": [
{
"type": {
"names": [
"PIXI.FilterManager"
]
},
"description": "The manager.
",
"name": "filterManager"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The input target.
",
"name": "input"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The output target.
",
"name": "output"
}
],
"name": "apply",
"longname": "PIXI.filters.BlurFilter#apply",
"kind": "function",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"overrides": "PIXI.Filter#apply",
"___id": "T000002R012293",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterapply",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of both the blurX and blurY properties simultaneously\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
1845,
1905
],
"filename": "BlurFilter.js",
"lineno": 59,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100131786",
"name": "BlurFilter#blur",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of both the blurX and blurY properties simultaneously
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blur",
"longname": "PIXI.filters.BlurFilter#blur",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R012295",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblur",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the number of passes for blur. More passes means higher quaility bluring.\n *\n * @member {number}\n * @default 1\n */",
"meta": {
"range": [
2306,
2372
],
"filename": "BlurFilter.js",
"lineno": 76,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100131844",
"name": "BlurFilter#quality",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the number of passes for blur. More passes means higher quaility bluring.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "1",
"name": "quality",
"longname": "PIXI.filters.BlurFilter#quality",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R012300",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterquality",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of the blurX property\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
2632,
2693
],
"filename": "BlurFilter.js",
"lineno": 92,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100131873",
"name": "BlurFilter#blurX",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of the blurX property
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blurX",
"longname": "PIXI.filters.BlurFilter#blurX",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R012304",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblurX",
"filepath": "filters\\blur\\BlurFilter.js"
},
{
"comment": "/**\n * Sets the strength of the blurY property\n *\n * @member {number}\n * @default 2\n */",
"meta": {
"range": [
3032,
3093
],
"filename": "BlurFilter.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\filters\\blur",
"code": {
"id": "astnode100131925",
"name": "BlurFilter#blurY",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Sets the strength of the blurY property
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"defaultvalue": "2",
"name": "blurY",
"longname": "PIXI.filters.BlurFilter#blurY",
"memberof": "PIXI.filters.BlurFilter",
"scope": "instance",
"params": [],
"___id": "T000002R012308",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterblurY",
"filepath": "filters\\blur\\BlurFilter.js"
}
],
"$attributes": [
{
"comment": "/**\n * The vertex shader.\n *\n * @member {string} PIXI.Filter#vertexSrc\n */",
"meta": {
"range": [
670,
776
],
"filename": "Filter.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The vertex shader.
",
"kind": "member",
"name": "vertexSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#vertexSrc",
"scope": "instance",
"inherits": "PIXI.Filter#vertexSrc",
"inherited": true,
"overrides": "PIXI.Filter#vertexSrc",
"___id": "T000002R014405",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFiltervertexSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The fragment shader.\n *\n * @member {string} PIXI.Filter#fragmentSrc\n */",
"meta": {
"range": [
849,
959
],
"filename": "Filter.js",
"lineno": 32,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The fragment shader.
",
"kind": "member",
"name": "fragmentSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#fragmentSrc",
"scope": "instance",
"inherits": "PIXI.Filter#fragmentSrc",
"inherited": true,
"overrides": "PIXI.Filter#fragmentSrc",
"___id": "T000002R014406",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterfragmentSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * An object containing the current values of custom uniforms.\n * @example Updating the value of a custom uniform \n * filter.uniforms.time = performance.now();\n *\n * @member {object} PIXI.Filter#uniforms\n */",
"meta": {
"range": [
1211,
1488
],
"filename": "Filter.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "An object containing the current values of custom uniforms.
",
"examples": [
"Updating the value of a custom uniform \nfilter.uniforms.time = performance.now();"
],
"kind": "member",
"name": "uniforms",
"type": {
"names": [
"object"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#uniforms",
"scope": "instance",
"inherits": "PIXI.Filter#uniforms",
"inherited": true,
"overrides": "PIXI.Filter#uniforms",
"___id": "T000002R014407",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilteruniforms",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The padding of the filter. Some filters require extra space to breath such as a blur.\n * Increasing this will add extra width and height to the bounds of the object that the\n * filter is applied to.\n *\n * @member {number} PIXI.Filter#padding\n */",
"meta": {
"range": [
2062,
2362
],
"filename": "Filter.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The padding of the filter. Some filters require extra space to breath such as a blur.
Increasing this will add extra width and height to the bounds of the object that the
filter is applied to.
",
"kind": "member",
"name": "padding",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#padding",
"scope": "instance",
"inherits": "PIXI.Filter#padding",
"inherited": true,
"overrides": "PIXI.Filter#padding",
"___id": "T000002R014408",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterpadding",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The resolution of the filter. Setting this to be lower will lower the quality but\n * increase the performance of the filter.\n *\n * @member {number} PIXI.Filter#resolution\n */",
"meta": {
"range": [
2398,
2619
],
"filename": "Filter.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The resolution of the filter. Setting this to be lower will lower the quality but
increase the performance of the filter.
",
"kind": "member",
"name": "resolution",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#resolution",
"scope": "instance",
"inherits": "PIXI.Filter#resolution",
"inherited": true,
"overrides": "PIXI.Filter#resolution",
"___id": "T000002R014409",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterresolution",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled is true the filter is applied, if false it will not.\n *\n * @member {boolean} PIXI.Filter#enabled\n */",
"meta": {
"range": [
2676,
2826
],
"filename": "Filter.js",
"lineno": 86,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled is true the filter is applied, if false it will not.
",
"kind": "member",
"name": "enabled",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#enabled",
"scope": "instance",
"inherits": "PIXI.Filter#enabled",
"inherited": true,
"overrides": "PIXI.Filter#enabled",
"___id": "T000002R014410",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterenabled",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled, pixi will fit the filter area into boundaries for better performance.\n * Switch it off if it does not work for specific shader.\n *\n * @member {boolean} PIXI.Filter#autoFit\n */",
"meta": {
"range": [
2865,
3099
],
"filename": "Filter.js",
"lineno": 93,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled, pixi will fit the filter area into boundaries for better performance.
Switch it off if it does not work for specific shader.
",
"kind": "member",
"name": "autoFit",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.filters.BlurFilter",
"longname": "PIXI.filters.BlurFilter#autoFit",
"scope": "instance",
"inherits": "PIXI.Filter#autoFit",
"inherited": true,
"overrides": "PIXI.Filter#autoFit",
"___id": "T000002R014411",
"___s": true,
"skip": true,
"slug": "PIXI.filters.BlurFilterautoFit",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"comment": "/**\n * @class\n * @memberof PIXI\n * @extends PIXI.Shader\n */",
"meta": {
"range": [
342,
5863
],
"filename": "Filter.js",
"lineno": 16,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100023444",
"name": "Filter",
"type": "ClassDeclaration",
"paramnames": [
"vertexSrc",
"fragmentSrc",
"uniforms"
]
}
},
"kind": "class",
"memberof": "PIXI",
"augments": [
"PIXI.Shader"
],
"name": "Filter",
"longname": "PIXI.Filter",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": "The source of the vertex shader.
",
"name": "vertexSrc"
},
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": "The source of the fragment shader.
",
"name": "fragmentSrc"
},
{
"type": {
"names": [
"object"
]
},
"optional": true,
"description": "Custom uniforms to use to augment the built-in ones.
",
"name": "uniforms"
}
],
"___id": "T000002R002229",
"___s": true,
"$methods": [
{
"comment": "/**\n * Applies the filter\n *\n * @param {PIXI.FilterManager} filterManager - The renderer to retrieve the filter from\n * @param {PIXI.RenderTarget} input - The input render target.\n * @param {PIXI.RenderTarget} output - The target to output to.\n * @param {boolean} clear - Should the output be cleared before rendering to it\n * @param {object} [currentState] - It's current state of filter.\n * There are some useful properties in the currentState :\n * target, filters, sourceFrame, destinationFrame, renderTarget, resolution\n */",
"meta": {
"range": [
3726,
4091
],
"filename": "Filter.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100023597",
"name": "Filter#apply",
"type": "MethodDefinition",
"paramnames": [
"filterManager",
"input",
"output",
"clear",
"currentState"
]
},
"vars": {
"": null
}
},
"description": "Applies the filter
",
"params": [
{
"type": {
"names": [
"PIXI.FilterManager"
]
},
"description": "The renderer to retrieve the filter from
",
"name": "filterManager"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The input render target.
",
"name": "input"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The target to output to.
",
"name": "output"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the output be cleared before rendering to it
",
"name": "clear"
},
{
"type": {
"names": [
"object"
]
},
"optional": true,
"description": "It's current state of filter.
There are some useful properties in the currentState :
target, filters, sourceFrame, destinationFrame, renderTarget, resolution
",
"name": "currentState"
}
],
"name": "apply",
"longname": "PIXI.Filter#apply",
"kind": "function",
"memberof": "PIXI.Filter",
"scope": "instance",
"___id": "T000002R002252",
"___s": true,
"skip": true,
"slug": "PIXI.Filterapply",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The default vertex shader source\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
4192,
4822
],
"filename": "Filter.js",
"lineno": 131,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100023615",
"name": "Filter.defaultVertexSrc",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The default vertex shader source
",
"scope": "static",
"kind": "constant",
"name": "defaultVertexSrc",
"longname": "PIXI.Filter.defaultVertexSrc",
"memberof": "PIXI.Filter",
"params": [],
"___id": "T000002R002253",
"___s": true,
"skip": true,
"slug": "PIXI.Filter.defaultVertexSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The default fragment shader source\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
4925,
5861
],
"filename": "Filter.js",
"lineno": 157,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100023636",
"name": "Filter.defaultFragmentSrc",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The default fragment shader source
",
"scope": "static",
"kind": "constant",
"name": "defaultFragmentSrc",
"longname": "PIXI.Filter.defaultFragmentSrc",
"memberof": "PIXI.Filter",
"params": [],
"___id": "T000002R002254",
"___s": true,
"skip": true,
"slug": "PIXI.Filter.defaultFragmentSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * Applies the filter\n *\n * @param {PIXI.FilterManager} filterManager - The renderer to retrieve the filter from\n * @param {PIXI.RenderTarget} input - The input render target.\n * @param {PIXI.RenderTarget} output - The target to output to.\n * @param {boolean} clear - Should the output be cleared before rendering to it\n * @param {object} [currentState] - It's current state of filter.\n * There are some useful properties in the currentState :\n * target, filters, sourceFrame, destinationFrame, renderTarget, resolution\n */",
"meta": {
"range": [
3726,
4091
],
"filename": "Filter.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100098276",
"name": "Filter#apply",
"type": "MethodDefinition",
"paramnames": [
"filterManager",
"input",
"output",
"clear",
"currentState"
]
},
"vars": {
"": null
}
},
"description": "Applies the filter
",
"params": [
{
"type": {
"names": [
"PIXI.FilterManager"
]
},
"description": "The renderer to retrieve the filter from
",
"name": "filterManager"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The input render target.
",
"name": "input"
},
{
"type": {
"names": [
"PIXI.RenderTarget"
]
},
"description": "The target to output to.
",
"name": "output"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the output be cleared before rendering to it
",
"name": "clear"
},
{
"type": {
"names": [
"object"
]
},
"optional": true,
"description": "It's current state of filter.
There are some useful properties in the currentState :
target, filters, sourceFrame, destinationFrame, renderTarget, resolution
",
"name": "currentState"
}
],
"name": "apply",
"longname": "PIXI.Filter#apply",
"kind": "function",
"memberof": "PIXI.Filter",
"scope": "instance",
"___id": "T000002R009186",
"___s": true,
"skip": true,
"slug": "PIXI.Filterapply",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The default vertex shader source\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
4192,
4822
],
"filename": "Filter.js",
"lineno": 131,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100098294",
"name": "Filter.defaultVertexSrc",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The default vertex shader source
",
"scope": "static",
"kind": "constant",
"name": "defaultVertexSrc",
"longname": "PIXI.Filter.defaultVertexSrc",
"memberof": "PIXI.Filter",
"params": [],
"___id": "T000002R009187",
"___s": true,
"skip": true,
"slug": "PIXI.Filter.defaultVertexSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The default fragment shader source\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
4925,
5861
],
"filename": "Filter.js",
"lineno": 157,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {
"id": "astnode100098315",
"name": "Filter.defaultFragmentSrc",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The default fragment shader source
",
"scope": "static",
"kind": "constant",
"name": "defaultFragmentSrc",
"longname": "PIXI.Filter.defaultFragmentSrc",
"memberof": "PIXI.Filter",
"params": [],
"___id": "T000002R009188",
"___s": true,
"skip": true,
"slug": "PIXI.Filter.defaultFragmentSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
}
],
"$attributes": [
{
"comment": "/**\n * The vertex shader.\n *\n * @member {string} PIXI.Filter#vertexSrc\n */",
"meta": {
"range": [
670,
776
],
"filename": "Filter.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The vertex shader.
",
"kind": "member",
"name": "vertexSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#vertexSrc",
"scope": "instance",
"___id": "T000002R002231",
"___s": true,
"skip": true,
"slug": "PIXI.FiltervertexSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The fragment shader.\n *\n * @member {string} PIXI.Filter#fragmentSrc\n */",
"meta": {
"range": [
849,
959
],
"filename": "Filter.js",
"lineno": 32,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The fragment shader.
",
"kind": "member",
"name": "fragmentSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#fragmentSrc",
"scope": "instance",
"___id": "T000002R002233",
"___s": true,
"skip": true,
"slug": "PIXI.FilterfragmentSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * An object containing the current values of custom uniforms.\n * @example Updating the value of a custom uniform \n * filter.uniforms.time = performance.now();\n *\n * @member {object} PIXI.Filter#uniforms\n */",
"meta": {
"range": [
1211,
1488
],
"filename": "Filter.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "An object containing the current values of custom uniforms.
",
"examples": [
"Updating the value of a custom uniform \nfilter.uniforms.time = performance.now();"
],
"kind": "member",
"name": "uniforms",
"type": {
"names": [
"object"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#uniforms",
"scope": "instance",
"___id": "T000002R002237",
"___s": true,
"skip": true,
"slug": "PIXI.Filteruniforms",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The padding of the filter. Some filters require extra space to breath such as a blur.\n * Increasing this will add extra width and height to the bounds of the object that the\n * filter is applied to.\n *\n * @member {number} PIXI.Filter#padding\n */",
"meta": {
"range": [
2062,
2362
],
"filename": "Filter.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The padding of the filter. Some filters require extra space to breath such as a blur.
Increasing this will add extra width and height to the bounds of the object that the
filter is applied to.
",
"kind": "member",
"name": "padding",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#padding",
"scope": "instance",
"___id": "T000002R002244",
"___s": true,
"skip": true,
"slug": "PIXI.Filterpadding",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The resolution of the filter. Setting this to be lower will lower the quality but\n * increase the performance of the filter.\n *\n * @member {number} PIXI.Filter#resolution\n */",
"meta": {
"range": [
2398,
2619
],
"filename": "Filter.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The resolution of the filter. Setting this to be lower will lower the quality but
increase the performance of the filter.
",
"kind": "member",
"name": "resolution",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#resolution",
"scope": "instance",
"___id": "T000002R002246",
"___s": true,
"skip": true,
"slug": "PIXI.Filterresolution",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled is true the filter is applied, if false it will not.\n *\n * @member {boolean} PIXI.Filter#enabled\n */",
"meta": {
"range": [
2676,
2826
],
"filename": "Filter.js",
"lineno": 86,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled is true the filter is applied, if false it will not.
",
"kind": "member",
"name": "enabled",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#enabled",
"scope": "instance",
"___id": "T000002R002248",
"___s": true,
"skip": true,
"slug": "PIXI.Filterenabled",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled, pixi will fit the filter area into boundaries for better performance.\n * Switch it off if it does not work for specific shader.\n *\n * @member {boolean} PIXI.Filter#autoFit\n */",
"meta": {
"range": [
2865,
3099
],
"filename": "Filter.js",
"lineno": 93,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled, pixi will fit the filter area into boundaries for better performance.
Switch it off if it does not work for specific shader.
",
"kind": "member",
"name": "autoFit",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#autoFit",
"scope": "instance",
"___id": "T000002R002250",
"___s": true,
"skip": true,
"slug": "PIXI.FilterautoFit",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The vertex shader.\n *\n * @member {string} PIXI.Filter#vertexSrc\n */",
"meta": {
"range": [
670,
776
],
"filename": "Filter.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The vertex shader.
",
"kind": "member",
"name": "vertexSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#vertexSrc",
"scope": "instance",
"___id": "T000002R009165",
"___s": true,
"skip": true,
"slug": "PIXI.FiltervertexSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The fragment shader.\n *\n * @member {string} PIXI.Filter#fragmentSrc\n */",
"meta": {
"range": [
849,
959
],
"filename": "Filter.js",
"lineno": 32,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The fragment shader.
",
"kind": "member",
"name": "fragmentSrc",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#fragmentSrc",
"scope": "instance",
"___id": "T000002R009167",
"___s": true,
"skip": true,
"slug": "PIXI.FilterfragmentSrc",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * An object containing the current values of custom uniforms.\n * @example Updating the value of a custom uniform \n * filter.uniforms.time = performance.now();\n *\n * @member {object} PIXI.Filter#uniforms\n */",
"meta": {
"range": [
1211,
1488
],
"filename": "Filter.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "An object containing the current values of custom uniforms.
",
"examples": [
"Updating the value of a custom uniform \nfilter.uniforms.time = performance.now();"
],
"kind": "member",
"name": "uniforms",
"type": {
"names": [
"object"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#uniforms",
"scope": "instance",
"___id": "T000002R009171",
"___s": true,
"skip": true,
"slug": "PIXI.Filteruniforms",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The padding of the filter. Some filters require extra space to breath such as a blur.\n * Increasing this will add extra width and height to the bounds of the object that the\n * filter is applied to.\n *\n * @member {number} PIXI.Filter#padding\n */",
"meta": {
"range": [
2062,
2362
],
"filename": "Filter.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The padding of the filter. Some filters require extra space to breath such as a blur.
Increasing this will add extra width and height to the bounds of the object that the
filter is applied to.
",
"kind": "member",
"name": "padding",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#padding",
"scope": "instance",
"___id": "T000002R009178",
"___s": true,
"skip": true,
"slug": "PIXI.Filterpadding",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * The resolution of the filter. Setting this to be lower will lower the quality but\n * increase the performance of the filter.\n *\n * @member {number} PIXI.Filter#resolution\n */",
"meta": {
"range": [
2398,
2619
],
"filename": "Filter.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "The resolution of the filter. Setting this to be lower will lower the quality but
increase the performance of the filter.
",
"kind": "member",
"name": "resolution",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#resolution",
"scope": "instance",
"___id": "T000002R009180",
"___s": true,
"skip": true,
"slug": "PIXI.Filterresolution",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled is true the filter is applied, if false it will not.\n *\n * @member {boolean} PIXI.Filter#enabled\n */",
"meta": {
"range": [
2676,
2826
],
"filename": "Filter.js",
"lineno": 86,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled is true the filter is applied, if false it will not.
",
"kind": "member",
"name": "enabled",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#enabled",
"scope": "instance",
"___id": "T000002R009182",
"___s": true,
"skip": true,
"slug": "PIXI.Filterenabled",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
},
{
"comment": "/**\n * If enabled, pixi will fit the filter area into boundaries for better performance.\n * Switch it off if it does not work for specific shader.\n *\n * @member {boolean} PIXI.Filter#autoFit\n */",
"meta": {
"range": [
2865,
3099
],
"filename": "Filter.js",
"lineno": 93,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\filters",
"code": {}
},
"description": "If enabled, pixi will fit the filter area into boundaries for better performance.
Switch it off if it does not work for specific shader.
",
"kind": "member",
"name": "autoFit",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Filter",
"longname": "PIXI.Filter#autoFit",
"scope": "instance",
"___id": "T000002R009184",
"___s": true,
"skip": true,
"slug": "PIXI.FilterautoFit",
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"comment": "/**\n * Wrapper class, webGL Shader for Pixi.\n * Adds precision string if vertexSrc or fragmentSrc have no mention of it.\n *\n * @class\n * @extends GLShader\n * @memberof PIXI\n */",
"meta": {
"range": [
679,
1203
],
"filename": "Shader.js",
"lineno": 35,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core",
"code": {
"id": "astnode100032185",
"name": "Shader",
"type": "ClassDeclaration",
"paramnames": [
"gl",
"vertexSrc",
"fragmentSrc"
]
}
},
"classdesc": "Wrapper class, webGL Shader for Pixi.
Adds precision string if vertexSrc or fragmentSrc have no mention of it.
",
"kind": "class",
"augments": [
"GLShader"
],
"memberof": "PIXI",
"name": "Shader",
"longname": "PIXI.Shader",
"scope": "static",
"params": [
{
"type": {
"names": [
"WebGLRenderingContext"
]
},
"description": "The current WebGL rendering context
",
"name": "gl"
},
{
"type": {
"names": [
"string",
"Array."
]
},
"description": "The vertex shader source as an array of strings.
",
"name": "vertexSrc"
},
{
"type": {
"names": [
"string",
"Array."
]
},
"description": "The fragment shader source as an array of strings.
",
"name": "fragmentSrc"
}
],
"___id": "T000002R002944",
"___s": true,
"$methods": [],
"$attributes": [],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"name": "GLShader"
}
],
"$augmentedBy": [
{
"name": "PrimitiveShader"
},
{
"name": "Filter"
},
{
"name": "ParticleShader"
},
{
"name": "PrimitiveShader"
},
{
"name": "Filter"
},
{
"name": "ParticleShader"
}
],
"filepath": "core\\Shader.js"
}
],
"$augmentedBy": [
{
"name": "SpriteMaskFilter"
},
{
"name": "BlurFilter"
},
{
"name": "BlurXFilter"
},
{
"name": "BlurYFilter"
},
{
"name": "ColorMatrixFilter"
},
{
"name": "DisplacementFilter"
},
{
"name": "FXAAFilter"
},
{
"name": "NoiseFilter"
},
{
"name": "VoidFilter"
},
{
"name": "SpriteMaskFilter"
},
{
"name": "BlurFilter"
},
{
"name": "BlurXFilter"
},
{
"name": "BlurYFilter"
},
{
"name": "ColorMatrixFilter"
},
{
"name": "DisplacementFilter"
},
{
"name": "FXAAFilter"
},
{
"name": "NoiseFilter"
},
{
"name": "VoidFilter"
}
],
"filepath": "core\\renderers\\webgl\\filters\\Filter.js"
}
],
"$augmentedBy": [],
"filepath": "filters\\blur\\BlurFilter.js"
}