A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.
Hint: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded
otherwise black rectangles will be drawn instead.
A RenderTexture takes a snapshot of any Display Object given to its render method. For example:
let renderer = PIXI.autoDetectRenderer(1024, 1024, { view: canvas, ratio: 1 });
let renderTexture = PIXI.RenderTexture.create(800, 600);
let sprite = PIXI.Sprite.fromImage("spinObj_01.png");
sprite.position.x = 800/2;
sprite.position.y = 600/2;
sprite.anchor.x = 0.5;
sprite.anchor.y = 0.5;
renderer.render(sprite, renderTexture);The Sprite in this case will be rendered using its local transform. To render this sprite at 0,0
you can clear the transform
sprite.setTransform()
let renderTexture = new PIXI.RenderTexture.create(100, 100);
renderer.render(sprite, renderTexture); // Renders to center of RenderTexture| Public methods | |
|---|---|
| public | resize(width: number, height: number, doNotResizeBaseTexture: boolean): void |
| public static | create(width: number, height: number, scaleMode: number, resolution: number): PIXI.RenderTexture |
| public | resize(width: number, height: number, doNotResizeBaseTexture: boolean): void |
| public static | create(width: number, height: number, scaleMode: number, resolution: number): PIXI.RenderTexture |
| public | update(): void |
| private | onBaseTextureLoaded(baseTexture: PIXI.BaseTexture): void |
| private | onBaseTextureUpdated(baseTexture: PIXI.BaseTexture): void |
| public | destroy(destroyBase: boolean): void |
| public | clone(): PIXI.Texture |
| protected | _updateUvs(): void |
| public | frame(): void |
| public | rotate(): void |
| public | width(): void |
| public | height(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| valid | boolean | public | This will let the renderer know if the texture is valid. If it's not then it cannot be rendered. |
| valid | boolean | public | This will let the renderer know if the texture is valid. If it's not then it cannot be rendered. |
| noFrame | boolean | public | Does this Texture have any frame data assigned to it? |
| baseTexture | PIXI.BaseTexture | public | The base texture that this texture uses. |
| _frame | PIXI.Rectangle | public | This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering, |
| trim | PIXI.Rectangle | public | This is the trimmed area of original texture, before it was put in atlas |
| requiresUpdate | boolean | public | This will let a renderer know that a texture has been updated (used mainly for webGL uv updates) |
| _uvs | PIXI.TextureUvs | private | The WebGL UV data cache. |
| orig | PIXI.Rectangle | public | This is the area of original texture, before it was put in atlas |
| update | protected | Fired when the texture is updated. This happens if the frame or the baseTexture is updated. |
|
| textureCacheId | string | public | The id under which this Texture has been added to the texture cache. This is |
| setFrame | public |
Resizes the RenderTexture.
| Name | Type | Attribute | Description |
|---|---|---|---|
| width | The width to resize to. |
||
| height | The height to resize to. |
||
| doNotResizeBaseTexture | Should the baseTexture.width and height values be resized as well? |
void
A short hand way of creating a render texture.
| Name | Type | Attribute | Description |
|---|---|---|---|
| width | The width of the render texture |
||
| height | The height of the render texture |
||
| scaleMode | See {@link PIXI.SCALE_MODES} for possible values |
||
| resolution | The resolution / device pixel ratio of the texture being generated |
PIXI.RenderTexture
Resizes the RenderTexture.
| Name | Type | Attribute | Description |
|---|---|---|---|
| width | The width to resize to. |
||
| height | The height to resize to. |
||
| doNotResizeBaseTexture | Should the baseTexture.width and height values be resized as well? |
void
A short hand way of creating a render texture.
| Name | Type | Attribute | Description |
|---|---|---|---|
| width | The width of the render texture |
||
| height | The height of the render texture |
||
| scaleMode | See {@link PIXI.SCALE_MODES} for possible values |
||
| resolution | The resolution / device pixel ratio of the texture being generated |
PIXI.RenderTexture
Updates this texture on the gpu.
void
Called when the base texture is loaded
| Name | Type | Attribute | Description |
|---|---|---|---|
| baseTexture | The base texture. |
void
Called when the base texture is updated
| Name | Type | Attribute | Description |
|---|---|---|---|
| baseTexture | The base texture. |
void
Destroys this texture
| Name | Type | Attribute | Description |
|---|---|---|---|
| destroyBase | Whether to destroy the base texture as well |
void
Creates a new texture object that acts the same as this one.
PIXI.Texture
Updates the internal WebGL UV cache.
void
The frame specifies the region of the base texture that this texture uses.
void
Indicates whether the texture is rotated inside the atlas
set to 2 to compensate for texture packer rotation
set to 6 to compensate for spine packer rotation
can be used to rotate or mirror sprites
See {@link PIXI.GroupD8} for explanation
void
The width of the Texture in pixels.
void
The height of the Texture in pixels.
void
{
"comment": "/**\n * A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.\n *\n * __Hint__: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded\n * otherwise black rectangles will be drawn instead.\n *\n * A RenderTexture takes a snapshot of any Display Object given to its render method. For example:\n *\n * ```js\n * let renderer = PIXI.autoDetectRenderer(1024, 1024, { view: canvas, ratio: 1 });\n * let renderTexture = PIXI.RenderTexture.create(800, 600);\n * let sprite = PIXI.Sprite.fromImage(\"spinObj_01.png\");\n *\n * sprite.position.x = 800/2;\n * sprite.position.y = 600/2;\n * sprite.anchor.x = 0.5;\n * sprite.anchor.y = 0.5;\n *\n * renderer.render(sprite, renderTexture);\n * ```\n *\n * The Sprite in this case will be rendered using its local transform. To render this sprite at 0,0\n * you can clear the transform\n *\n * ```js\n *\n * sprite.setTransform()\n *\n * let renderTexture = new PIXI.RenderTexture.create(100, 100);\n *\n * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture\n * ```\n *\n * @class\n * @extends PIXI.Texture\n * @memberof PIXI\n */",
"meta": {
"range": [
1249,
4162
],
"filename": "RenderTexture.js",
"lineno": 43,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042828",
"name": "RenderTexture",
"type": "ClassDeclaration",
"paramnames": [
"baseRenderTexture",
"frame"
]
}
},
"classdesc": "A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.
\nHint: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded
otherwise black rectangles will be drawn instead.
\nA RenderTexture takes a snapshot of any Display Object given to its render method. For example:
\nlet renderer = PIXI.autoDetectRenderer(1024, 1024, { view: canvas, ratio: 1 });\nlet renderTexture = PIXI.RenderTexture.create(800, 600);\nlet sprite = PIXI.Sprite.fromImage("spinObj_01.png");\n\nsprite.position.x = 800/2;\nsprite.position.y = 600/2;\nsprite.anchor.x = 0.5;\nsprite.anchor.y = 0.5;\n\nrenderer.render(sprite, renderTexture);
The Sprite in this case will be rendered using its local transform. To render this sprite at 0,0
you can clear the transform
\n\nsprite.setTransform()\n\nlet renderTexture = new PIXI.RenderTexture.create(100, 100);\n\nrenderer.render(sprite, renderTexture); // Renders to center of RenderTexture
",
"kind": "class",
"augments": [
"PIXI.Texture"
],
"memberof": "PIXI",
"name": "RenderTexture",
"longname": "PIXI.RenderTexture",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.BaseRenderTexture"
]
},
"description": "The renderer used for this RenderTexture
",
"name": "baseRenderTexture"
},
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"optional": true,
"description": "The rectangle frame of the texture to show
",
"name": "frame"
}
],
"___id": "T000002R003949",
"___s": true,
"$methods": [
{
"comment": "/**\n * Resizes the RenderTexture.\n *\n * @param {number} width - The width to resize to.\n * @param {number} height - The height to resize to.\n * @param {boolean} doNotResizeBaseTexture - Should the baseTexture.width and height values be resized as well?\n */",
"meta": {
"range": [
3107,
3502
],
"filename": "RenderTexture.js",
"lineno": 100,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042924",
"name": "RenderTexture#resize",
"type": "MethodDefinition",
"paramnames": [
"width",
"height",
"doNotResizeBaseTexture"
]
},
"vars": {
"": null
}
},
"description": "Resizes the RenderTexture.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The width to resize to.
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"description": "The height to resize to.
",
"name": "height"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the baseTexture.width and height values be resized as well?
",
"name": "doNotResizeBaseTexture"
}
],
"name": "resize",
"longname": "PIXI.RenderTexture#resize",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"___id": "T000002R003962",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureresize",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * A short hand way of creating a render texture.\n *\n * @param {number} [width=100] - The width of the render texture\n * @param {number} [height=100] - The height of the render texture\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @param {number} [resolution=1] - The resolution / device pixel ratio of the texture being generated\n * @return {PIXI.RenderTexture} The new render texture\n */",
"meta": {
"range": [
4002,
4160
],
"filename": "RenderTexture.js",
"lineno": 125,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042989",
"name": "RenderTexture.create",
"type": "MethodDefinition",
"paramnames": [
"width",
"height",
"scaleMode",
"resolution"
]
},
"vars": {
"": null
}
},
"description": "A short hand way of creating a render texture.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 100,
"description": "The width of the render texture
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 100,
"description": "The height of the render texture
",
"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 resolution / device pixel ratio of the texture being generated
",
"name": "resolution"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The new render texture
"
}
],
"name": "create",
"longname": "PIXI.RenderTexture.create",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "static",
"___id": "T000002R003968",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexture.create",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * Resizes the RenderTexture.\n *\n * @param {number} width - The width to resize to.\n * @param {number} height - The height to resize to.\n * @param {boolean} doNotResizeBaseTexture - Should the baseTexture.width and height values be resized as well?\n */",
"meta": {
"range": [
3107,
3502
],
"filename": "RenderTexture.js",
"lineno": 100,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100117603",
"name": "RenderTexture#resize",
"type": "MethodDefinition",
"paramnames": [
"width",
"height",
"doNotResizeBaseTexture"
]
},
"vars": {
"": null
}
},
"description": "Resizes the RenderTexture.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The width to resize to.
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"description": "The height to resize to.
",
"name": "height"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Should the baseTexture.width and height values be resized as well?
",
"name": "doNotResizeBaseTexture"
}
],
"name": "resize",
"longname": "PIXI.RenderTexture#resize",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"___id": "T000002R010896",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureresize",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * A short hand way of creating a render texture.\n *\n * @param {number} [width=100] - The width of the render texture\n * @param {number} [height=100] - The height of the render texture\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @param {number} [resolution=1] - The resolution / device pixel ratio of the texture being generated\n * @return {PIXI.RenderTexture} The new render texture\n */",
"meta": {
"range": [
4002,
4160
],
"filename": "RenderTexture.js",
"lineno": 125,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100117668",
"name": "RenderTexture.create",
"type": "MethodDefinition",
"paramnames": [
"width",
"height",
"scaleMode",
"resolution"
]
},
"vars": {
"": null
}
},
"description": "A short hand way of creating a render texture.
",
"params": [
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 100,
"description": "The width of the render texture
",
"name": "width"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 100,
"description": "The height of the render texture
",
"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 resolution / device pixel ratio of the texture being generated
",
"name": "resolution"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.RenderTexture"
]
},
"description": "The new render texture
"
}
],
"name": "create",
"longname": "PIXI.RenderTexture.create",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "static",
"___id": "T000002R010902",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexture.create",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * Updates this texture on the gpu.\n *\n */",
"meta": {
"range": [
5741,
5796
],
"filename": "Texture.js",
"lineno": 176,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043859",
"name": "Texture#update",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates this texture on the gpu.
",
"name": "update",
"longname": "PIXI.RenderTexture#update",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#update",
"inherited": true,
"overrides": "PIXI.Texture#update",
"___id": "T000002R014173",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureupdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is loaded\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
5952,
6413
],
"filename": "Texture.js",
"lineno": 187,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043870",
"name": "Texture#onBaseTextureLoaded",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is loaded
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureLoaded",
"longname": "PIXI.RenderTexture#onBaseTextureLoaded",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"inherits": "PIXI.Texture#onBaseTextureLoaded",
"inherited": true,
"overrides": "PIXI.Texture#onBaseTextureLoaded",
"___id": "T000002R014174",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureonBaseTextureLoaded",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is updated\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
6570,
6774
],
"filename": "Texture.js",
"lineno": 211,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043928",
"name": "Texture#onBaseTextureUpdated",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is updated
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureUpdated",
"longname": "PIXI.RenderTexture#onBaseTextureUpdated",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"inherits": "PIXI.Texture#onBaseTextureUpdated",
"inherited": true,
"overrides": "PIXI.Texture#onBaseTextureUpdated",
"___id": "T000002R014175",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureonBaseTextureUpdated",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Destroys this texture\n *\n * @param {boolean} [destroyBase=false] Whether to destroy the base texture as well\n */",
"meta": {
"range": [
6920,
7982
],
"filename": "Texture.js",
"lineno": 226,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043965",
"name": "Texture#destroy",
"type": "MethodDefinition",
"paramnames": [
"destroyBase"
]
},
"vars": {
"": null
}
},
"description": "Destroys this texture
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to destroy the base texture as well
",
"name": "destroyBase"
}
],
"name": "destroy",
"longname": "PIXI.RenderTexture#destroy",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"inherits": "PIXI.Texture#destroy",
"inherited": true,
"overrides": "PIXI.Texture#destroy",
"___id": "T000002R014176",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturedestroy",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Creates a new texture object that acts the same as this one.\n *\n * @return {PIXI.Texture} The new texture\n */",
"meta": {
"range": [
8125,
8237
],
"filename": "Texture.js",
"lineno": 270,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044087",
"name": "Texture#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new texture object that acts the same as this one.
",
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The new texture
"
}
],
"name": "clone",
"longname": "PIXI.RenderTexture#clone",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#clone",
"inherited": true,
"overrides": "PIXI.Texture#clone",
"___id": "T000002R014177",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureclone",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Updates the internal WebGL UV cache.\n *\n * @protected\n */",
"meta": {
"range": [
8328,
8533
],
"filename": "Texture.js",
"lineno": 280,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044109",
"name": "Texture#_updateUvs",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates the internal WebGL UV cache.
",
"access": "protected",
"name": "_updateUvs",
"longname": "PIXI.RenderTexture#_updateUvs",
"kind": "function",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#_updateUvs",
"inherited": true,
"overrides": "PIXI.Texture#_updateUvs",
"___id": "T000002R014178",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexture_updateUvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The frame specifies the region of the base texture that this texture uses.\n *\n * @member {PIXI.Rectangle}\n */",
"meta": {
"range": [
15585,
15636
],
"filename": "Texture.js",
"lineno": 509,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044483",
"name": "Texture#frame",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The frame specifies the region of the base texture that this texture uses.
",
"kind": "member",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"name": "frame",
"longname": "PIXI.RenderTexture#frame",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#frame",
"inherited": true,
"overrides": "PIXI.Texture#frame",
"___id": "T000002R014179",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureframe",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Indicates whether the texture is rotated inside the atlas\n * set to 2 to compensate for texture packer rotation\n * set to 6 to compensate for spine packer rotation\n * can be used to rotate or mirror sprites\n * See {@link PIXI.GroupD8} for explanation\n *\n * @member {number}\n */",
"meta": {
"range": [
16868,
16921
],
"filename": "Texture.js",
"lineno": 550,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044622",
"name": "Texture#rotate",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Indicates whether the texture is rotated inside the atlas
set to 2 to compensate for texture packer rotation
set to 6 to compensate for spine packer rotation
can be used to rotate or mirror sprites
See {@link PIXI.GroupD8} for explanation
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "rotate",
"longname": "PIXI.RenderTexture#rotate",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#rotate",
"inherited": true,
"overrides": "PIXI.Texture#rotate",
"___id": "T000002R014180",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturerotate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The width of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17196,
17251
],
"filename": "Texture.js",
"lineno": 569,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044651",
"name": "Texture#width",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The width of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "width",
"longname": "PIXI.RenderTexture#width",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#width",
"inherited": true,
"overrides": "PIXI.Texture#width",
"___id": "T000002R014181",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturewidth",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The height of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17348,
17405
],
"filename": "Texture.js",
"lineno": 579,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044661",
"name": "Texture#height",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The height of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "height",
"longname": "PIXI.RenderTexture#height",
"memberof": "PIXI.RenderTexture",
"scope": "instance",
"params": [],
"inherits": "PIXI.Texture#height",
"inherited": true,
"overrides": "PIXI.Texture#height",
"___id": "T000002R014182",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureheight",
"filepath": "core\\textures\\Texture.js"
}
],
"$attributes": [
{
"comment": "/**\n * This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.\n *\n * @member {boolean} PIXI.RenderTexture#valid\n */",
"meta": {
"range": [
2567,
2755
],
"filename": "RenderTexture.js",
"lineno": 83,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
",
"kind": "member",
"name": "valid",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#valid",
"scope": "instance",
"overrides": "PIXI.Texture#valid",
"___id": "T000002R003960",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturevalid",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.\n *\n * @member {boolean} PIXI.RenderTexture#valid\n */",
"meta": {
"range": [
2567,
2755
],
"filename": "RenderTexture.js",
"lineno": 83,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
",
"kind": "member",
"name": "valid",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#valid",
"scope": "instance",
"overrides": "PIXI.Texture#valid",
"___id": "T000002R010894",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturevalid",
"filepath": "core\\textures\\RenderTexture.js"
},
{
"comment": "/**\n * Does this Texture have any frame data assigned to it?\n *\n * @member {boolean} PIXI.Texture#noFrame\n */",
"meta": {
"range": [
1971,
2112
],
"filename": "Texture.js",
"lineno": 49,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Does this Texture have any frame data assigned to it?
",
"kind": "member",
"name": "noFrame",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#noFrame",
"scope": "instance",
"inherits": "PIXI.Texture#noFrame",
"inherited": true,
"overrides": "PIXI.Texture#noFrame",
"___id": "T000002R014164",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturenoFrame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The base texture that this texture uses.\n *\n * @member {PIXI.BaseTexture} PIXI.Texture#baseTexture\n */",
"meta": {
"range": [
2389,
2530
],
"filename": "Texture.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The base texture that this texture uses.
",
"kind": "member",
"name": "baseTexture",
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#baseTexture",
"scope": "instance",
"inherits": "PIXI.Texture#baseTexture",
"inherited": true,
"overrides": "PIXI.Texture#baseTexture",
"___id": "T000002R014165",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturebaseTexture",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,\n * irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)\n *\n * @member {PIXI.Rectangle} PIXI.Texture#_frame\n */",
"meta": {
"range": [
2580,
2885
],
"filename": "Texture.js",
"lineno": 74,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
",
"kind": "member",
"name": "_frame",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#_frame",
"scope": "instance",
"inherits": "PIXI.Texture#_frame",
"inherited": true,
"overrides": "PIXI.Texture#_frame",
"___id": "T000002R014166",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexture_frame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the trimmed area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#trim\n */",
"meta": {
"range": [
2924,
3088
],
"filename": "Texture.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the trimmed area of original texture, before it was put in atlas
",
"kind": "member",
"name": "trim",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#trim",
"scope": "instance",
"inherits": "PIXI.Texture#trim",
"inherited": true,
"overrides": "PIXI.Texture#trim",
"___id": "T000002R014167",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturetrim",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)\n *\n * @member {boolean} PIXI.Texture#requiresUpdate\n */",
"meta": {
"range": [
3344,
3535
],
"filename": "Texture.js",
"lineno": 96,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
",
"kind": "member",
"name": "requiresUpdate",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#requiresUpdate",
"scope": "instance",
"inherits": "PIXI.Texture#requiresUpdate",
"inherited": true,
"overrides": "PIXI.Texture#requiresUpdate",
"___id": "T000002R014168",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturerequiresUpdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The WebGL UV data cache.\n *\n * @member {PIXI.TextureUvs} PIXI.Texture#_uvs\n * @private\n */",
"meta": {
"range": [
3582,
3719
],
"filename": "Texture.js",
"lineno": 103,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The WebGL UV data cache.
",
"kind": "member",
"name": "_uvs",
"type": {
"names": [
"PIXI.TextureUvs"
]
},
"access": "private",
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#_uvs",
"scope": "instance",
"inherits": "PIXI.Texture#_uvs",
"inherited": true,
"overrides": "PIXI.Texture#_uvs",
"___id": "T000002R014169",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexture_uvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#orig\n */",
"meta": {
"range": [
3755,
3911
],
"filename": "Texture.js",
"lineno": 111,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of original texture, before it was put in atlas
",
"kind": "member",
"name": "orig",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#orig",
"scope": "instance",
"inherits": "PIXI.Texture#orig",
"inherited": true,
"overrides": "PIXI.Texture#orig",
"___id": "T000002R014170",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureorig",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Fired when the texture is updated. This happens if the frame or the baseTexture is updated.\n *\n * @event update\n * @memberof PIXI.Texture#\n * @protected\n */",
"meta": {
"range": [
4887,
5098
],
"filename": "Texture.js",
"lineno": 146,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Fired when the texture is updated. This happens if the frame or the baseTexture is updated.
",
"kind": "event",
"name": "update",
"memberof": "PIXI.RenderTexture",
"access": "protected",
"longname": "PIXI.RenderTexture#event:update",
"scope": "instance",
"inherits": "PIXI.Texture#event:update",
"inherited": true,
"overrides": "PIXI.Texture#event:update",
"___id": "T000002R014171",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTextureevent:update",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The id under which this Texture has been added to the texture cache. This is\n * automatically set in certain cases, but may not always be accurate, particularly if\n * the texture is in the cache under multiple ids.\n *\n * @member {string} PIXI.Texture#textureCacheId\n */",
"meta": {
"range": [
5306,
5630
],
"filename": "Texture.js",
"lineno": 162,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The id under which this Texture has been added to the texture cache. This is
automatically set in certain cases, but may not always be accurate, particularly if
the texture is in the cache under multiple ids.
",
"kind": "member",
"name": "textureCacheId",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#textureCacheId",
"scope": "instance",
"inherits": "PIXI.Texture#textureCacheId",
"inherited": true,
"overrides": "PIXI.Texture#textureCacheId",
"___id": "T000002R014172",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturetextureCacheId",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * @method\n * @name PIXI.Texture#setFrame\n * @see PIXI.Texture#setFrame\n * @deprecated since version 3.0.0\n * @param {PIXI.Rectangle} frame - The frame to set.\n */",
"meta": {
"range": [
22043,
22210
],
"filename": "deprecation.js",
"lineno": 820,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src",
"code": {}
},
"kind": "function",
"name": "setFrame",
"see": [
"PIXI.Texture#setFrame"
],
"deprecated": "since version 3.0.0",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The frame to set.
",
"name": "frame"
}
],
"memberof": "PIXI.RenderTexture",
"longname": "PIXI.RenderTexture#setFrame",
"scope": "instance",
"inherits": "PIXI.Texture#setFrame",
"inherited": true,
"overrides": "PIXI.Texture#setFrame",
"___id": "T000002R014183",
"___s": true,
"skip": true,
"slug": "PIXI.RenderTexturesetFrame",
"filepath": "deprecation.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"comment": "/**\n * A texture stores the information that represents an image or part of an image. It cannot be added\n * to the display list directly. Instead use it as the texture for a Sprite. If no frame is provided\n * then the whole image is used.\n *\n * You can directly create a texture from an image and then reuse it multiple times like this :\n *\n * ```js\n * let texture = PIXI.Texture.fromImage('assets/image.png');\n * let sprite1 = new PIXI.Sprite(texture);\n * let sprite2 = new PIXI.Sprite(texture);\n * ```\n *\n * Textures made from SVGs, loaded or not, cannot be used before the file finishes processing.\n * You can check for this by checking the sprite's _textureID property.\n * ```js\n * var texture = PIXI.Texture.fromImage('assets/image.svg');\n * var sprite1 = new PIXI.Sprite(texture);\n * //sprite1._textureID should not be undefined if the texture has finished processing the SVG file\n * ```\n * You can use a ticker or rAF to ensure your sprites load the finished textures after processing. See issue #3068.\n *\n * @class\n * @extends EventEmitter\n * @memberof PIXI\n */",
"meta": {
"range": [
1385,
17407
],
"filename": "Texture.js",
"lineno": 36,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043661",
"name": "Texture",
"type": "ClassDeclaration",
"paramnames": [
"baseTexture",
"frame",
"orig",
"trim",
"rotate"
]
}
},
"classdesc": "A texture stores the information that represents an image or part of an image. It cannot be added
to the display list directly. Instead use it as the texture for a Sprite. If no frame is provided
then the whole image is used.
\nYou can directly create a texture from an image and then reuse it multiple times like this :
\nlet texture = PIXI.Texture.fromImage('assets/image.png');\nlet sprite1 = new PIXI.Sprite(texture);\nlet sprite2 = new PIXI.Sprite(texture);
Textures made from SVGs, loaded or not, cannot be used before the file finishes processing.
You can check for this by checking the sprite's _textureID property.
\nvar texture = PIXI.Texture.fromImage('assets/image.svg');\nvar sprite1 = new PIXI.Sprite(texture);\n//sprite1._textureID should not be undefined if the texture has finished processing the SVG file
You can use a ticker or rAF to ensure your sprites load the finished textures after processing. See issue #3068.
",
"kind": "class",
"augments": [
"EventEmitter"
],
"memberof": "PIXI",
"name": "Texture",
"longname": "PIXI.Texture",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture source to create the texture from
",
"name": "baseTexture"
},
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"optional": true,
"description": "The rectangle frame of the texture to show
",
"name": "frame"
},
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"optional": true,
"description": "The area of original texture
",
"name": "orig"
},
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"optional": true,
"description": "Trimmed rectangle of original texture
",
"name": "trim"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"description": "indicates how the texture was rotated by texture packer. See {@link PIXI.GroupD8}
",
"name": "rotate"
}
],
"___id": "T000002R004016",
"___s": true,
"$methods": [
{
"comment": "/**\n * Updates this texture on the gpu.\n *\n */",
"meta": {
"range": [
5741,
5796
],
"filename": "Texture.js",
"lineno": 176,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043859",
"name": "Texture#update",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates this texture on the gpu.
",
"name": "update",
"longname": "PIXI.Texture#update",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004046",
"___s": true,
"skip": true,
"slug": "PIXI.Textureupdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is loaded\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
5952,
6413
],
"filename": "Texture.js",
"lineno": 187,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043870",
"name": "Texture#onBaseTextureLoaded",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is loaded
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureLoaded",
"longname": "PIXI.Texture#onBaseTextureLoaded",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R004047",
"___s": true,
"skip": true,
"slug": "PIXI.TextureonBaseTextureLoaded",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is updated\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
6570,
6774
],
"filename": "Texture.js",
"lineno": 211,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043928",
"name": "Texture#onBaseTextureUpdated",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is updated
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureUpdated",
"longname": "PIXI.Texture#onBaseTextureUpdated",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R004050",
"___s": true,
"skip": true,
"slug": "PIXI.TextureonBaseTextureUpdated",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Destroys this texture\n *\n * @param {boolean} [destroyBase=false] Whether to destroy the base texture as well\n */",
"meta": {
"range": [
6920,
7982
],
"filename": "Texture.js",
"lineno": 226,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100043965",
"name": "Texture#destroy",
"type": "MethodDefinition",
"paramnames": [
"destroyBase"
]
},
"vars": {
"": null
}
},
"description": "Destroys this texture
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to destroy the base texture as well
",
"name": "destroyBase"
}
],
"name": "destroy",
"longname": "PIXI.Texture#destroy",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R004053",
"___s": true,
"skip": true,
"slug": "PIXI.Texturedestroy",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Creates a new texture object that acts the same as this one.\n *\n * @return {PIXI.Texture} The new texture\n */",
"meta": {
"range": [
8125,
8237
],
"filename": "Texture.js",
"lineno": 270,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044087",
"name": "Texture#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new texture object that acts the same as this one.
",
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The new texture
"
}
],
"name": "clone",
"longname": "PIXI.Texture#clone",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004062",
"___s": true,
"skip": true,
"slug": "PIXI.Textureclone",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Updates the internal WebGL UV cache.\n *\n * @protected\n */",
"meta": {
"range": [
8328,
8533
],
"filename": "Texture.js",
"lineno": 280,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044109",
"name": "Texture#_updateUvs",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates the internal WebGL UV cache.
",
"access": "protected",
"name": "_updateUvs",
"longname": "PIXI.Texture#_updateUvs",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004063",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_updateUvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a Texture object from the given image url.\n * If the image is not in the texture cache it will be created and loaded.\n *\n * @static\n * @param {string} imageUrl - The image url of the texture\n * @param {boolean} [crossorigin] - Whether requests should be treated as crossorigin\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @param {number} [sourceScale=(auto)] - Scale for the original image, used with SVG images.\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
9154,
9494
],
"filename": "Texture.js",
"lineno": 303,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044147",
"name": "Texture.fromImage",
"type": "MethodDefinition",
"paramnames": [
"imageUrl",
"crossorigin",
"scaleMode",
"sourceScale"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a Texture object from the given image url.
If the image is not in the texture cache it will be created and loaded.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The image url of the texture
",
"name": "imageUrl"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Whether requests should be treated as crossorigin
",
"name": "crossorigin"
},
{
"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": "(auto)",
"description": "Scale for the original image, used with SVG images.
",
"name": "sourceScale"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromImage",
"longname": "PIXI.Texture.fromImage",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004065",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromImage",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\n * The frame ids are created when a Texture packer file has been loaded\n *\n * @static\n * @param {string} frameId - The frame Id of the texture in the cache\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
9860,
10105
],
"filename": "Texture.js",
"lineno": 324,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044186",
"name": "Texture.fromFrame",
"type": "MethodDefinition",
"paramnames": [
"frameId"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId
The frame ids are created when a Texture packer file has been loaded
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The frame Id of the texture in the cache
",
"name": "frameId"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromFrame",
"longname": "PIXI.Texture.fromFrame",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004069",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromFrame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the given canvas element.\n *\n * @static\n * @param {HTMLCanvasElement} canvas - The canvas element source of the texture\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
10485,
10604
],
"filename": "Texture.js",
"lineno": 344,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044210",
"name": "Texture.fromCanvas",
"type": "MethodDefinition",
"paramnames": [
"canvas",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the given canvas element.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLCanvasElement"
]
},
"description": "The canvas element source of the texture
",
"name": "canvas"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromCanvas",
"longname": "PIXI.Texture.fromCanvas",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004071",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromCanvas",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the given video element.\n *\n * @static\n * @param {HTMLVideoElement|string} video - The URL or actual element of the video\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
10986,
11225
],
"filename": "Texture.js",
"lineno": 357,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044225",
"name": "Texture.fromVideo",
"type": "MethodDefinition",
"paramnames": [
"video",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the given video element.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLVideoElement",
"string"
]
},
"description": "The URL or actual element of the video
",
"name": "video"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromVideo",
"longname": "PIXI.Texture.fromVideo",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004072",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromVideo",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the video url.\n *\n * @static\n * @param {string} videoUrl - URL of the video\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
11561,
11688
],
"filename": "Texture.js",
"lineno": 375,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044253",
"name": "Texture.fromVideoUrl",
"type": "MethodDefinition",
"paramnames": [
"videoUrl",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the video url.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "URL of the video
",
"name": "videoUrl"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromVideoUrl",
"longname": "PIXI.Texture.fromVideoUrl",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004073",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromVideoUrl",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the source you provide.\n * The source can be - frame id, image url, video url, canvas element, video element, base texture\n *\n * @static\n * @param {number|string|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|PIXI.BaseTexture}\n * source - Source to create texture from\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
12126,
13276
],
"filename": "Texture.js",
"lineno": 389,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044268",
"name": "Texture.from",
"type": "MethodDefinition",
"paramnames": [
"source"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the source you provide.
The source can be - frame id, image url, video url, canvas element, video element, base texture
",
"scope": "static",
"params": [
{
"type": {
"names": [
"number",
"string",
"HTMLImageElement",
"HTMLCanvasElement",
"HTMLVideoElement",
"PIXI.BaseTexture"
]
},
"description": "Source to create texture from
",
"name": "source"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "from",
"longname": "PIXI.Texture.from",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004074",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.from",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Create a texture from a source and add to the cache.\n *\n * @static\n * @param {HTMLImageElement|HTMLCanvasElement} source - The input source.\n * @param {String} imageUrl - File name of texture, for cache and resolving resolution.\n * @param {String} [name] - Human readible name for the texture cache. If no name is\n * specified, only `imageUrl` will be used as the cache ID.\n * @return {PIXI.Texture} Output texture\n */",
"meta": {
"range": [
13755,
14562
],
"filename": "Texture.js",
"lineno": 443,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044362",
"name": "Texture.fromLoader",
"type": "MethodDefinition",
"paramnames": [
"source",
"imageUrl",
"name"
]
},
"vars": {
"": null
}
},
"description": "Create a texture from a source and add to the cache.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLImageElement",
"HTMLCanvasElement"
]
},
"description": "The input source.
",
"name": "source"
},
{
"type": {
"names": [
"String"
]
},
"description": "File name of texture, for cache and resolving resolution.
",
"name": "imageUrl"
},
{
"type": {
"names": [
"String"
]
},
"optional": true,
"description": "Human readible name for the texture cache. If no name is
specified, only imageUrl will be used as the cache ID.
",
"name": "name"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "Output texture
"
}
],
"name": "fromLoader",
"longname": "PIXI.Texture.fromLoader",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004077",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromLoader",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Adds a texture to the global TextureCache. This cache is shared across the whole PIXI object.\n *\n * @static\n * @param {PIXI.Texture} texture - The Texture to add to the cache.\n * @param {string} id - The id that the texture will be stored against.\n */",
"meta": {
"range": [
14855,
15038
],
"filename": "Texture.js",
"lineno": 478,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044436",
"name": "Texture.addTextureToCache",
"type": "MethodDefinition",
"paramnames": [
"texture",
"id"
]
},
"vars": {
"": null
}
},
"description": "Adds a texture to the global TextureCache. This cache is shared across the whole PIXI object.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The Texture to add to the cache.
",
"name": "texture"
},
{
"type": {
"names": [
"string"
]
},
"description": "The id that the texture will be stored against.
",
"name": "id"
}
],
"name": "addTextureToCache",
"longname": "PIXI.Texture.addTextureToCache",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004087",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.addTextureToCache",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Remove a texture from the global TextureCache.\n *\n * @static\n * @param {string} id - The id of the texture to be removed\n * @return {PIXI.Texture} The texture that was removed\n */",
"meta": {
"range": [
15259,
15442
],
"filename": "Texture.js",
"lineno": 494,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044460",
"name": "Texture.removeTextureFromCache",
"type": "MethodDefinition",
"paramnames": [
"id"
]
},
"vars": {
"": null
}
},
"description": "Remove a texture from the global TextureCache.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The id of the texture to be removed
",
"name": "id"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The texture that was removed
"
}
],
"name": "removeTextureFromCache",
"longname": "PIXI.Texture.removeTextureFromCache",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R004090",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.removeTextureFromCache",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The frame specifies the region of the base texture that this texture uses.\n *\n * @member {PIXI.Rectangle}\n */",
"meta": {
"range": [
15585,
15636
],
"filename": "Texture.js",
"lineno": 509,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044483",
"name": "Texture#frame",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The frame specifies the region of the base texture that this texture uses.
",
"kind": "member",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"name": "frame",
"longname": "PIXI.Texture#frame",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004092",
"___s": true,
"skip": true,
"slug": "PIXI.Textureframe",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Indicates whether the texture is rotated inside the atlas\n * set to 2 to compensate for texture packer rotation\n * set to 6 to compensate for spine packer rotation\n * can be used to rotate or mirror sprites\n * See {@link PIXI.GroupD8} for explanation\n *\n * @member {number}\n */",
"meta": {
"range": [
16868,
16921
],
"filename": "Texture.js",
"lineno": 550,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044622",
"name": "Texture#rotate",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Indicates whether the texture is rotated inside the atlas
set to 2 to compensate for texture packer rotation
set to 6 to compensate for spine packer rotation
can be used to rotate or mirror sprites
See {@link PIXI.GroupD8} for explanation
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "rotate",
"longname": "PIXI.Texture#rotate",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004098",
"___s": true,
"skip": true,
"slug": "PIXI.Texturerotate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The width of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17196,
17251
],
"filename": "Texture.js",
"lineno": 569,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044651",
"name": "Texture#width",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The width of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "width",
"longname": "PIXI.Texture#width",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004101",
"___s": true,
"skip": true,
"slug": "PIXI.Texturewidth",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The height of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17348,
17405
],
"filename": "Texture.js",
"lineno": 579,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044661",
"name": "Texture#height",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The height of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "height",
"longname": "PIXI.Texture#height",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R004102",
"___s": true,
"skip": true,
"slug": "PIXI.Textureheight",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Updates this texture on the gpu.\n *\n */",
"meta": {
"range": [
5741,
5796
],
"filename": "Texture.js",
"lineno": 176,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118538",
"name": "Texture#update",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates this texture on the gpu.
",
"name": "update",
"longname": "PIXI.Texture#update",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R010980",
"___s": true,
"skip": true,
"slug": "PIXI.Textureupdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is loaded\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
5952,
6413
],
"filename": "Texture.js",
"lineno": 187,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118549",
"name": "Texture#onBaseTextureLoaded",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is loaded
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureLoaded",
"longname": "PIXI.Texture#onBaseTextureLoaded",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R010981",
"___s": true,
"skip": true,
"slug": "PIXI.TextureonBaseTextureLoaded",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Called when the base texture is updated\n *\n * @private\n * @param {PIXI.BaseTexture} baseTexture - The base texture.\n */",
"meta": {
"range": [
6570,
6774
],
"filename": "Texture.js",
"lineno": 211,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118607",
"name": "Texture#onBaseTextureUpdated",
"type": "MethodDefinition",
"paramnames": [
"baseTexture"
]
},
"vars": {
"": null
}
},
"description": "Called when the base texture is updated
",
"access": "private",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"description": "The base texture.
",
"name": "baseTexture"
}
],
"name": "onBaseTextureUpdated",
"longname": "PIXI.Texture#onBaseTextureUpdated",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R010984",
"___s": true,
"skip": true,
"slug": "PIXI.TextureonBaseTextureUpdated",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Destroys this texture\n *\n * @param {boolean} [destroyBase=false] Whether to destroy the base texture as well\n */",
"meta": {
"range": [
6920,
7982
],
"filename": "Texture.js",
"lineno": 226,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118644",
"name": "Texture#destroy",
"type": "MethodDefinition",
"paramnames": [
"destroyBase"
]
},
"vars": {
"": null
}
},
"description": "Destroys this texture
",
"params": [
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to destroy the base texture as well
",
"name": "destroyBase"
}
],
"name": "destroy",
"longname": "PIXI.Texture#destroy",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"___id": "T000002R010987",
"___s": true,
"skip": true,
"slug": "PIXI.Texturedestroy",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Creates a new texture object that acts the same as this one.\n *\n * @return {PIXI.Texture} The new texture\n */",
"meta": {
"range": [
8125,
8237
],
"filename": "Texture.js",
"lineno": 270,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118766",
"name": "Texture#clone",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Creates a new texture object that acts the same as this one.
",
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The new texture
"
}
],
"name": "clone",
"longname": "PIXI.Texture#clone",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R010996",
"___s": true,
"skip": true,
"slug": "PIXI.Textureclone",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Updates the internal WebGL UV cache.\n *\n * @protected\n */",
"meta": {
"range": [
8328,
8533
],
"filename": "Texture.js",
"lineno": 280,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118788",
"name": "Texture#_updateUvs",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Updates the internal WebGL UV cache.
",
"access": "protected",
"name": "_updateUvs",
"longname": "PIXI.Texture#_updateUvs",
"kind": "function",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R010997",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_updateUvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a Texture object from the given image url.\n * If the image is not in the texture cache it will be created and loaded.\n *\n * @static\n * @param {string} imageUrl - The image url of the texture\n * @param {boolean} [crossorigin] - Whether requests should be treated as crossorigin\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @param {number} [sourceScale=(auto)] - Scale for the original image, used with SVG images.\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
9154,
9494
],
"filename": "Texture.js",
"lineno": 303,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118826",
"name": "Texture.fromImage",
"type": "MethodDefinition",
"paramnames": [
"imageUrl",
"crossorigin",
"scaleMode",
"sourceScale"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a Texture object from the given image url.
If the image is not in the texture cache it will be created and loaded.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The image url of the texture
",
"name": "imageUrl"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"description": "Whether requests should be treated as crossorigin
",
"name": "crossorigin"
},
{
"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": "(auto)",
"description": "Scale for the original image, used with SVG images.
",
"name": "sourceScale"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromImage",
"longname": "PIXI.Texture.fromImage",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R010999",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromImage",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\n * The frame ids are created when a Texture packer file has been loaded\n *\n * @static\n * @param {string} frameId - The frame Id of the texture in the cache\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
9860,
10105
],
"filename": "Texture.js",
"lineno": 324,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118865",
"name": "Texture.fromFrame",
"type": "MethodDefinition",
"paramnames": [
"frameId"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId
The frame ids are created when a Texture packer file has been loaded
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The frame Id of the texture in the cache
",
"name": "frameId"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromFrame",
"longname": "PIXI.Texture.fromFrame",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011003",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromFrame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the given canvas element.\n *\n * @static\n * @param {HTMLCanvasElement} canvas - The canvas element source of the texture\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
10485,
10604
],
"filename": "Texture.js",
"lineno": 344,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118889",
"name": "Texture.fromCanvas",
"type": "MethodDefinition",
"paramnames": [
"canvas",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the given canvas element.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLCanvasElement"
]
},
"description": "The canvas element source of the texture
",
"name": "canvas"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromCanvas",
"longname": "PIXI.Texture.fromCanvas",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011005",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromCanvas",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the given video element.\n *\n * @static\n * @param {HTMLVideoElement|string} video - The URL or actual element of the video\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
10986,
11225
],
"filename": "Texture.js",
"lineno": 357,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118904",
"name": "Texture.fromVideo",
"type": "MethodDefinition",
"paramnames": [
"video",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the given video element.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLVideoElement",
"string"
]
},
"description": "The URL or actual element of the video
",
"name": "video"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromVideo",
"longname": "PIXI.Texture.fromVideo",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011006",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromVideo",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the video url.\n *\n * @static\n * @param {string} videoUrl - URL of the video\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - See {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
11561,
11688
],
"filename": "Texture.js",
"lineno": 375,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118932",
"name": "Texture.fromVideoUrl",
"type": "MethodDefinition",
"paramnames": [
"videoUrl",
"scaleMode"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the video url.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "URL of the video
",
"name": "videoUrl"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": "PIXI.settings.SCALE_MODE",
"description": "See {@link PIXI.SCALE_MODES} for possible values
",
"name": "scaleMode"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "fromVideoUrl",
"longname": "PIXI.Texture.fromVideoUrl",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011007",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromVideoUrl",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Helper function that creates a new Texture based on the source you provide.\n * The source can be - frame id, image url, video url, canvas element, video element, base texture\n *\n * @static\n * @param {number|string|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|PIXI.BaseTexture}\n * source - Source to create texture from\n * @return {PIXI.Texture} The newly created texture\n */",
"meta": {
"range": [
12126,
13276
],
"filename": "Texture.js",
"lineno": 389,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100118947",
"name": "Texture.from",
"type": "MethodDefinition",
"paramnames": [
"source"
]
},
"vars": {
"": null
}
},
"description": "Helper function that creates a new Texture based on the source you provide.
The source can be - frame id, image url, video url, canvas element, video element, base texture
",
"scope": "static",
"params": [
{
"type": {
"names": [
"number",
"string",
"HTMLImageElement",
"HTMLCanvasElement",
"HTMLVideoElement",
"PIXI.BaseTexture"
]
},
"description": "Source to create texture from
",
"name": "source"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The newly created texture
"
}
],
"name": "from",
"longname": "PIXI.Texture.from",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011008",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.from",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Create a texture from a source and add to the cache.\n *\n * @static\n * @param {HTMLImageElement|HTMLCanvasElement} source - The input source.\n * @param {String} imageUrl - File name of texture, for cache and resolving resolution.\n * @param {String} [name] - Human readible name for the texture cache. If no name is\n * specified, only `imageUrl` will be used as the cache ID.\n * @return {PIXI.Texture} Output texture\n */",
"meta": {
"range": [
13755,
14562
],
"filename": "Texture.js",
"lineno": 443,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119041",
"name": "Texture.fromLoader",
"type": "MethodDefinition",
"paramnames": [
"source",
"imageUrl",
"name"
]
},
"vars": {
"": null
}
},
"description": "Create a texture from a source and add to the cache.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"HTMLImageElement",
"HTMLCanvasElement"
]
},
"description": "The input source.
",
"name": "source"
},
{
"type": {
"names": [
"String"
]
},
"description": "File name of texture, for cache and resolving resolution.
",
"name": "imageUrl"
},
{
"type": {
"names": [
"String"
]
},
"optional": true,
"description": "Human readible name for the texture cache. If no name is
specified, only imageUrl will be used as the cache ID.
",
"name": "name"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "Output texture
"
}
],
"name": "fromLoader",
"longname": "PIXI.Texture.fromLoader",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011011",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.fromLoader",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Adds a texture to the global TextureCache. This cache is shared across the whole PIXI object.\n *\n * @static\n * @param {PIXI.Texture} texture - The Texture to add to the cache.\n * @param {string} id - The id that the texture will be stored against.\n */",
"meta": {
"range": [
14855,
15038
],
"filename": "Texture.js",
"lineno": 478,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119115",
"name": "Texture.addTextureToCache",
"type": "MethodDefinition",
"paramnames": [
"texture",
"id"
]
},
"vars": {
"": null
}
},
"description": "Adds a texture to the global TextureCache. This cache is shared across the whole PIXI object.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The Texture to add to the cache.
",
"name": "texture"
},
{
"type": {
"names": [
"string"
]
},
"description": "The id that the texture will be stored against.
",
"name": "id"
}
],
"name": "addTextureToCache",
"longname": "PIXI.Texture.addTextureToCache",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011021",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.addTextureToCache",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Remove a texture from the global TextureCache.\n *\n * @static\n * @param {string} id - The id of the texture to be removed\n * @return {PIXI.Texture} The texture that was removed\n */",
"meta": {
"range": [
15259,
15442
],
"filename": "Texture.js",
"lineno": 494,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119139",
"name": "Texture.removeTextureFromCache",
"type": "MethodDefinition",
"paramnames": [
"id"
]
},
"vars": {
"": null
}
},
"description": "Remove a texture from the global TextureCache.
",
"scope": "static",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The id of the texture to be removed
",
"name": "id"
}
],
"returns": [
{
"type": {
"names": [
"PIXI.Texture"
]
},
"description": "The texture that was removed
"
}
],
"name": "removeTextureFromCache",
"longname": "PIXI.Texture.removeTextureFromCache",
"kind": "function",
"memberof": "PIXI.Texture",
"___id": "T000002R011024",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.removeTextureFromCache",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The frame specifies the region of the base texture that this texture uses.\n *\n * @member {PIXI.Rectangle}\n */",
"meta": {
"range": [
15585,
15636
],
"filename": "Texture.js",
"lineno": 509,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119162",
"name": "Texture#frame",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The frame specifies the region of the base texture that this texture uses.
",
"kind": "member",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"name": "frame",
"longname": "PIXI.Texture#frame",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R011026",
"___s": true,
"skip": true,
"slug": "PIXI.Textureframe",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Indicates whether the texture is rotated inside the atlas\n * set to 2 to compensate for texture packer rotation\n * set to 6 to compensate for spine packer rotation\n * can be used to rotate or mirror sprites\n * See {@link PIXI.GroupD8} for explanation\n *\n * @member {number}\n */",
"meta": {
"range": [
16868,
16921
],
"filename": "Texture.js",
"lineno": 550,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119301",
"name": "Texture#rotate",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Indicates whether the texture is rotated inside the atlas
set to 2 to compensate for texture packer rotation
set to 6 to compensate for spine packer rotation
can be used to rotate or mirror sprites
See {@link PIXI.GroupD8} for explanation
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "rotate",
"longname": "PIXI.Texture#rotate",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R011032",
"___s": true,
"skip": true,
"slug": "PIXI.Texturerotate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The width of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17196,
17251
],
"filename": "Texture.js",
"lineno": 569,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119330",
"name": "Texture#width",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The width of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "width",
"longname": "PIXI.Texture#width",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R011035",
"___s": true,
"skip": true,
"slug": "PIXI.Texturewidth",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The height of the Texture in pixels.\n *\n * @member {number}\n */",
"meta": {
"range": [
17348,
17405
],
"filename": "Texture.js",
"lineno": 579,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119340",
"name": "Texture#height",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "The height of the Texture in pixels.
",
"kind": "member",
"type": {
"names": [
"number"
]
},
"name": "height",
"longname": "PIXI.Texture#height",
"memberof": "PIXI.Texture",
"scope": "instance",
"params": [],
"___id": "T000002R011036",
"___s": true,
"skip": true,
"slug": "PIXI.Textureheight",
"filepath": "core\\textures\\Texture.js"
}
],
"$attributes": [
{
"comment": "/**\n * Does this Texture have any frame data assigned to it?\n *\n * @member {boolean} PIXI.Texture#noFrame\n */",
"meta": {
"range": [
1971,
2112
],
"filename": "Texture.js",
"lineno": 49,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Does this Texture have any frame data assigned to it?
",
"kind": "member",
"name": "noFrame",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#noFrame",
"scope": "instance",
"___id": "T000002R004018",
"___s": true,
"skip": true,
"slug": "PIXI.TexturenoFrame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The base texture that this texture uses.\n *\n * @member {PIXI.BaseTexture} PIXI.Texture#baseTexture\n */",
"meta": {
"range": [
2389,
2530
],
"filename": "Texture.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The base texture that this texture uses.
",
"kind": "member",
"name": "baseTexture",
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#baseTexture",
"scope": "instance",
"___id": "T000002R004023",
"___s": true,
"skip": true,
"slug": "PIXI.TexturebaseTexture",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,\n * irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)\n *\n * @member {PIXI.Rectangle} PIXI.Texture#_frame\n */",
"meta": {
"range": [
2580,
2885
],
"filename": "Texture.js",
"lineno": 74,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
",
"kind": "member",
"name": "_frame",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#_frame",
"scope": "instance",
"___id": "T000002R004025",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_frame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the trimmed area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#trim\n */",
"meta": {
"range": [
2924,
3088
],
"filename": "Texture.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the trimmed area of original texture, before it was put in atlas
",
"kind": "member",
"name": "trim",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#trim",
"scope": "instance",
"___id": "T000002R004027",
"___s": true,
"skip": true,
"slug": "PIXI.Texturetrim",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.\n *\n * @member {boolean} PIXI.Texture#valid\n */",
"meta": {
"range": [
3124,
3306
],
"filename": "Texture.js",
"lineno": 89,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
",
"kind": "member",
"name": "valid",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#valid",
"scope": "instance",
"___id": "T000002R004029",
"___s": true,
"skip": true,
"slug": "PIXI.Texturevalid",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)\n *\n * @member {boolean} PIXI.Texture#requiresUpdate\n */",
"meta": {
"range": [
3344,
3535
],
"filename": "Texture.js",
"lineno": 96,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
",
"kind": "member",
"name": "requiresUpdate",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#requiresUpdate",
"scope": "instance",
"___id": "T000002R004031",
"___s": true,
"skip": true,
"slug": "PIXI.TexturerequiresUpdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The WebGL UV data cache.\n *\n * @member {PIXI.TextureUvs} PIXI.Texture#_uvs\n * @private\n */",
"meta": {
"range": [
3582,
3719
],
"filename": "Texture.js",
"lineno": 103,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The WebGL UV data cache.
",
"kind": "member",
"name": "_uvs",
"type": {
"names": [
"PIXI.TextureUvs"
]
},
"access": "private",
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#_uvs",
"scope": "instance",
"___id": "T000002R004033",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_uvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#orig\n */",
"meta": {
"range": [
3755,
3911
],
"filename": "Texture.js",
"lineno": 111,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of original texture, before it was put in atlas
",
"kind": "member",
"name": "orig",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#orig",
"scope": "instance",
"___id": "T000002R004035",
"___s": true,
"skip": true,
"slug": "PIXI.Textureorig",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Fired when the texture is updated. This happens if the frame or the baseTexture is updated.\n *\n * @event update\n * @memberof PIXI.Texture#\n * @protected\n */",
"meta": {
"range": [
4887,
5098
],
"filename": "Texture.js",
"lineno": 146,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Fired when the texture is updated. This happens if the frame or the baseTexture is updated.
",
"kind": "event",
"name": "update",
"memberof": "PIXI.Texture",
"access": "protected",
"longname": "PIXI.Texture#event:update",
"scope": "instance",
"___id": "T000002R004041",
"___s": true,
"skip": true,
"slug": "PIXI.Textureevent:update",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The id under which this Texture has been added to the texture cache. This is\n * automatically set in certain cases, but may not always be accurate, particularly if\n * the texture is in the cache under multiple ids.\n *\n * @member {string} PIXI.Texture#textureCacheId\n */",
"meta": {
"range": [
5306,
5630
],
"filename": "Texture.js",
"lineno": 162,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The id under which this Texture has been added to the texture cache. This is
automatically set in certain cases, but may not always be accurate, particularly if
the texture is in the cache under multiple ids.
",
"kind": "member",
"name": "textureCacheId",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#textureCacheId",
"scope": "instance",
"___id": "T000002R004044",
"___s": true,
"skip": true,
"slug": "PIXI.TexturetextureCacheId",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * An empty texture, used often to not have to create multiple empty textures.\n * Can not be destroyed.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
18105,
18151
],
"filename": "Texture.js",
"lineno": 615,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044760",
"name": "Texture.EMPTY",
"type": "NewExpression",
"value": "",
"paramnames": []
}
},
"description": "An empty texture, used often to not have to create multiple empty textures.
Can not be destroyed.
",
"scope": "static",
"kind": "constant",
"name": "EMPTY",
"longname": "PIXI.Texture.EMPTY",
"memberof": "PIXI.Texture",
"___id": "T000002R004114",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.EMPTY",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * A white texture of 10x10 size, used for graphics and other things\n * Can not be destroyed.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
18363,
18399
],
"filename": "Texture.js",
"lineno": 626,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100044783",
"name": "Texture.WHITE",
"type": "CallExpression",
"value": "",
"paramnames": []
}
},
"description": "A white texture of 10x10 size, used for graphics and other things
Can not be destroyed.
",
"scope": "static",
"kind": "constant",
"name": "WHITE",
"longname": "PIXI.Texture.WHITE",
"memberof": "PIXI.Texture",
"___id": "T000002R004115",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.WHITE",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * @method\n * @name PIXI.Texture#setFrame\n * @see PIXI.Texture#setFrame\n * @deprecated since version 3.0.0\n * @param {PIXI.Rectangle} frame - The frame to set.\n */",
"meta": {
"range": [
22043,
22210
],
"filename": "deprecation.js",
"lineno": 820,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src",
"code": {}
},
"kind": "function",
"name": "setFrame",
"see": [
"PIXI.Texture#setFrame"
],
"deprecated": "since version 3.0.0",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The frame to set.
",
"name": "frame"
}
],
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#setFrame",
"scope": "instance",
"___id": "T000002R004683",
"___s": true,
"skip": true,
"slug": "PIXI.TexturesetFrame",
"filepath": "deprecation.js"
},
{
"comment": "/**\n * Does this Texture have any frame data assigned to it?\n *\n * @member {boolean} PIXI.Texture#noFrame\n */",
"meta": {
"range": [
1971,
2112
],
"filename": "Texture.js",
"lineno": 49,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Does this Texture have any frame data assigned to it?
",
"kind": "member",
"name": "noFrame",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#noFrame",
"scope": "instance",
"___id": "T000002R010952",
"___s": true,
"skip": true,
"slug": "PIXI.TexturenoFrame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The base texture that this texture uses.\n *\n * @member {PIXI.BaseTexture} PIXI.Texture#baseTexture\n */",
"meta": {
"range": [
2389,
2530
],
"filename": "Texture.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The base texture that this texture uses.
",
"kind": "member",
"name": "baseTexture",
"type": {
"names": [
"PIXI.BaseTexture"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#baseTexture",
"scope": "instance",
"___id": "T000002R010957",
"___s": true,
"skip": true,
"slug": "PIXI.TexturebaseTexture",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,\n * irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)\n *\n * @member {PIXI.Rectangle} PIXI.Texture#_frame\n */",
"meta": {
"range": [
2580,
2885
],
"filename": "Texture.js",
"lineno": 74,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
",
"kind": "member",
"name": "_frame",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#_frame",
"scope": "instance",
"___id": "T000002R010959",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_frame",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the trimmed area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#trim\n */",
"meta": {
"range": [
2924,
3088
],
"filename": "Texture.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the trimmed area of original texture, before it was put in atlas
",
"kind": "member",
"name": "trim",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#trim",
"scope": "instance",
"___id": "T000002R010961",
"___s": true,
"skip": true,
"slug": "PIXI.Texturetrim",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.\n *\n * @member {boolean} PIXI.Texture#valid\n */",
"meta": {
"range": [
3124,
3306
],
"filename": "Texture.js",
"lineno": 89,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
",
"kind": "member",
"name": "valid",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#valid",
"scope": "instance",
"___id": "T000002R010963",
"___s": true,
"skip": true,
"slug": "PIXI.Texturevalid",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)\n *\n * @member {boolean} PIXI.Texture#requiresUpdate\n */",
"meta": {
"range": [
3344,
3535
],
"filename": "Texture.js",
"lineno": 96,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
",
"kind": "member",
"name": "requiresUpdate",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#requiresUpdate",
"scope": "instance",
"___id": "T000002R010965",
"___s": true,
"skip": true,
"slug": "PIXI.TexturerequiresUpdate",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The WebGL UV data cache.\n *\n * @member {PIXI.TextureUvs} PIXI.Texture#_uvs\n * @private\n */",
"meta": {
"range": [
3582,
3719
],
"filename": "Texture.js",
"lineno": 103,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The WebGL UV data cache.
",
"kind": "member",
"name": "_uvs",
"type": {
"names": [
"PIXI.TextureUvs"
]
},
"access": "private",
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#_uvs",
"scope": "instance",
"___id": "T000002R010967",
"___s": true,
"skip": true,
"slug": "PIXI.Texture_uvs",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * This is the area of original texture, before it was put in atlas\n *\n * @member {PIXI.Rectangle} PIXI.Texture#orig\n */",
"meta": {
"range": [
3755,
3911
],
"filename": "Texture.js",
"lineno": 111,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "This is the area of original texture, before it was put in atlas
",
"kind": "member",
"name": "orig",
"type": {
"names": [
"PIXI.Rectangle"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#orig",
"scope": "instance",
"___id": "T000002R010969",
"___s": true,
"skip": true,
"slug": "PIXI.Textureorig",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * Fired when the texture is updated. This happens if the frame or the baseTexture is updated.\n *\n * @event update\n * @memberof PIXI.Texture#\n * @protected\n */",
"meta": {
"range": [
4887,
5098
],
"filename": "Texture.js",
"lineno": 146,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "Fired when the texture is updated. This happens if the frame or the baseTexture is updated.
",
"kind": "event",
"name": "update",
"memberof": "PIXI.Texture",
"access": "protected",
"longname": "PIXI.Texture#event:update",
"scope": "instance",
"___id": "T000002R010975",
"___s": true,
"skip": true,
"slug": "PIXI.Textureevent:update",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * The id under which this Texture has been added to the texture cache. This is\n * automatically set in certain cases, but may not always be accurate, particularly if\n * the texture is in the cache under multiple ids.\n *\n * @member {string} PIXI.Texture#textureCacheId\n */",
"meta": {
"range": [
5306,
5630
],
"filename": "Texture.js",
"lineno": 162,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "The id under which this Texture has been added to the texture cache. This is
automatically set in certain cases, but may not always be accurate, particularly if
the texture is in the cache under multiple ids.
",
"kind": "member",
"name": "textureCacheId",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#textureCacheId",
"scope": "instance",
"___id": "T000002R010978",
"___s": true,
"skip": true,
"slug": "PIXI.TexturetextureCacheId",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * An empty texture, used often to not have to create multiple empty textures.\n * Can not be destroyed.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
18105,
18151
],
"filename": "Texture.js",
"lineno": 615,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119439",
"name": "Texture.EMPTY",
"type": "NewExpression",
"value": "",
"paramnames": []
}
},
"description": "An empty texture, used often to not have to create multiple empty textures.
Can not be destroyed.
",
"scope": "static",
"kind": "constant",
"name": "EMPTY",
"longname": "PIXI.Texture.EMPTY",
"memberof": "PIXI.Texture",
"___id": "T000002R011048",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.EMPTY",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * A white texture of 10x10 size, used for graphics and other things\n * Can not be destroyed.\n *\n * @static\n * @constant\n */",
"meta": {
"range": [
18363,
18399
],
"filename": "Texture.js",
"lineno": 626,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100119462",
"name": "Texture.WHITE",
"type": "CallExpression",
"value": "",
"paramnames": []
}
},
"description": "A white texture of 10x10 size, used for graphics and other things
Can not be destroyed.
",
"scope": "static",
"kind": "constant",
"name": "WHITE",
"longname": "PIXI.Texture.WHITE",
"memberof": "PIXI.Texture",
"___id": "T000002R011049",
"___s": true,
"skip": true,
"slug": "PIXI.Texture.WHITE",
"filepath": "core\\textures\\Texture.js"
},
{
"comment": "/**\n * @method\n * @name PIXI.Texture#setFrame\n * @see PIXI.Texture#setFrame\n * @deprecated since version 3.0.0\n * @param {PIXI.Rectangle} frame - The frame to set.\n */",
"meta": {
"range": [
22043,
22210
],
"filename": "deprecation.js",
"lineno": 820,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src",
"code": {}
},
"kind": "function",
"name": "setFrame",
"see": [
"PIXI.Texture#setFrame"
],
"deprecated": "since version 3.0.0",
"params": [
{
"type": {
"names": [
"PIXI.Rectangle"
]
},
"description": "The frame to set.
",
"name": "frame"
}
],
"memberof": "PIXI.Texture",
"longname": "PIXI.Texture#setFrame",
"scope": "instance",
"___id": "T000002R011617",
"___s": true,
"skip": true,
"slug": "PIXI.TexturesetFrame",
"filepath": "deprecation.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"name": "EventEmitter"
}
],
"$augmentedBy": [
{
"name": "RenderTexture"
},
{
"name": "RenderTexture"
}
],
"filepath": "core\\textures\\Texture.js"
}
],
"$augmentedBy": [],
"filepath": "core\\textures\\RenderTexture.js"
}