If an Image source is loading the 'loaded' or 'error' event will be dispatched when the operation ends. An underyling source that is immediately-available bypasses loading entirely.
Controls if RGB channels should be pre-multiplied by Alpha (WebGL only) All blend modes, and shaders written for default value. Change it on your own risk.
Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work
If an Image source is loading the 'loaded' or 'error' event will be dispatched when the operation ends. An underyling source that is immediately-available bypasses loading entirely.
Controls if RGB channels should be pre-multiplied by Alpha (WebGL only) All blend modes, and shaders written for default value. Change it on your own risk.
Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work
If the source is not-immediately-available, such as an image that needs to be downloaded, then the 'loaded' or 'error' event will be dispatched in the future and hasLoaded will remain false after this call.
The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:
if (texture.hasLoaded) {
// texture ready for use
} else if (texture.isLoading) {
// listen to 'loaded' and/or 'error' events on texture
} else {
// not loading, not going to load UNLESS the source is reloaded
// (it may still make sense to listen to the events)
}
Loads texture using an SVG string. The original SVG Image is stored as origSource and the created canvas is the new source. The SVG is scaled using sourceScale. Called by _loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.
If the source is not-immediately-available, such as an image that needs to be downloaded, then the 'loaded' or 'error' event will be dispatched in the future and hasLoaded will remain false after this call.
The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:
if (texture.hasLoaded) {
// texture ready for use
} else if (texture.isLoading) {
// listen to 'loaded' and/or 'error' events on texture
} else {
// not loading, not going to load UNLESS the source is reloaded
// (it may still make sense to listen to the events)
}
Loads texture using an SVG string. The original SVG Image is stored as origSource and the created canvas is the new source. The SVG is scaled using sourceScale. Called by _loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.
",
"name": "_updateDimensions",
"longname": "PIXI.BaseTexture#_updateDimensions",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R003857",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexture_updateDimensions",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Load a source.\n *\n * If the source is not-immediately-available, such as an image that needs to be\n * downloaded, then the 'loaded' or 'error' event will be dispatched in the future\n * and `hasLoaded` will remain false after this call.\n *\n * The logic state after calling `loadSource` directly or indirectly (eg. `fromImage`, `new BaseTexture`) is:\n *\n * if (texture.hasLoaded) {\n * // texture ready for use\n * } else if (texture.isLoading) {\n * // listen to 'loaded' and/or 'error' events on texture\n * } else {\n * // not loading, not going to load UNLESS the source is reloaded\n * // (it may still make sense to listen to the events)\n * }\n *\n * @protected\n * @param {HTMLImageElement|HTMLCanvasElement} source - the source object of the texture.\n */",
"meta": {
"range": [
8664,
12022
],
"filename": "BaseTexture.js",
"lineno": 284,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100041764",
"name": "BaseTexture#loadSource",
"type": "MethodDefinition",
"paramnames": [
"source"
]
},
"vars": {
"": null
}
},
"description": "
Load a source.
\n
If the source is not-immediately-available, such as an image that needs to be downloaded, then the 'loaded' or 'error' event will be dispatched in the future and hasLoaded will remain false after this call.
\n
The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:
\n
if (texture.hasLoaded) {\n // texture ready for use\n} else if (texture.isLoading) {\n // listen to 'loaded' and/or 'error' events on texture\n} else {\n // not loading, not going to load UNLESS the source is reloaded\n // (it may still make sense to listen to the events)\n}
Loads an SVG string from imageUrl using XHR and then calls _loadSvgSourceUsingString.
",
"name": "_loadSvgSourceUsingXhr",
"longname": "PIXI.BaseTexture#_loadSvgSourceUsingXhr",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R003896",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexture_loadSvgSourceUsingXhr",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Loads texture using an SVG string. The original SVG Image is stored as `origSource` and the\n * created canvas is the new `source`. The SVG is scaled using `sourceScale`. Called by\n * `_loadSvgSourceUsingXhr` or `_loadSvgSourceUsingDataUri`.\n *\n * @param {string} svgString SVG source as string\n *\n * @fires loaded\n */",
"meta": {
"range": [
15433,
16774
],
"filename": "BaseTexture.js",
"lineno": 531,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042300",
"name": "BaseTexture#_loadSvgSourceUsingString",
"type": "MethodDefinition",
"paramnames": [
"svgString"
]
},
"vars": {
"": null
}
},
"description": "
Loads texture using an SVG string. The original SVG Image is stored as origSource and the created canvas is the new source. The SVG is scaled using sourceScale. Called by _loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.
",
"name": "destroy",
"longname": "PIXI.BaseTexture#destroy",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R003916",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturedestroy",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Frees the texture from WebGL memory without destroying this texture object.\n * This means you can still use the texture later which will upload it to GPU\n * memory again.\n *\n */",
"meta": {
"range": [
17838,
17895
],
"filename": "BaseTexture.js",
"lineno": 623,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042551",
"name": "BaseTexture#dispose",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.
",
"name": "dispose",
"longname": "PIXI.BaseTexture#dispose",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R003922",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturedispose",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Changes the source image of the texture.\n * The original source must be an Image element.\n *\n * @param {string} newSrc - the path of the image\n */",
"meta": {
"range": [
18079,
18189
],
"filename": "BaseTexture.js",
"lineno": 634,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042562",
"name": "BaseTexture#updateSourceImage",
"type": "MethodDefinition",
"paramnames": [
"newSrc"
]
},
"vars": {
"": null
}
},
"description": "
Changes the source image of the texture. The original source must be an Image element.
",
"name": "newSrc"
}
],
"name": "updateSourceImage",
"longname": "PIXI.BaseTexture#updateSourceImage",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"___id": "T000002R003923",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureupdateSourceImage",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Helper function that creates a base texture from the given image url.\n * If the image is not in the base 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=(auto)] - Should use anonymous CORS? Defaults to true if the URL is not a data-URI.\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.BaseTexture} The new base texture.\n */",
"meta": {
"range": [
18843,
19954
],
"filename": "BaseTexture.js",
"lineno": 652,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100042583",
"name": "BaseTexture.fromImage",
"type": "MethodDefinition",
"paramnames": [
"imageUrl",
"crossorigin",
"scaleMode",
"sourceScale"
]
},
"vars": {
"": null
}
},
"description": "
Helper function that creates a base texture from the given image url. If the image is not in the base texture cache it will be created and loaded.
",
"name": "_updateDimensions",
"longname": "PIXI.BaseTexture#_updateDimensions",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R010791",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexture_updateDimensions",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Load a source.\n *\n * If the source is not-immediately-available, such as an image that needs to be\n * downloaded, then the 'loaded' or 'error' event will be dispatched in the future\n * and `hasLoaded` will remain false after this call.\n *\n * The logic state after calling `loadSource` directly or indirectly (eg. `fromImage`, `new BaseTexture`) is:\n *\n * if (texture.hasLoaded) {\n * // texture ready for use\n * } else if (texture.isLoading) {\n * // listen to 'loaded' and/or 'error' events on texture\n * } else {\n * // not loading, not going to load UNLESS the source is reloaded\n * // (it may still make sense to listen to the events)\n * }\n *\n * @protected\n * @param {HTMLImageElement|HTMLCanvasElement} source - the source object of the texture.\n */",
"meta": {
"range": [
8664,
12022
],
"filename": "BaseTexture.js",
"lineno": 284,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100116443",
"name": "BaseTexture#loadSource",
"type": "MethodDefinition",
"paramnames": [
"source"
]
},
"vars": {
"": null
}
},
"description": "
Load a source.
\n
If the source is not-immediately-available, such as an image that needs to be downloaded, then the 'loaded' or 'error' event will be dispatched in the future and hasLoaded will remain false after this call.
\n
The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:
\n
if (texture.hasLoaded) {\n // texture ready for use\n} else if (texture.isLoading) {\n // listen to 'loaded' and/or 'error' events on texture\n} else {\n // not loading, not going to load UNLESS the source is reloaded\n // (it may still make sense to listen to the events)\n}
Loads an SVG string from imageUrl using XHR and then calls _loadSvgSourceUsingString.
",
"name": "_loadSvgSourceUsingXhr",
"longname": "PIXI.BaseTexture#_loadSvgSourceUsingXhr",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R010830",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexture_loadSvgSourceUsingXhr",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Loads texture using an SVG string. The original SVG Image is stored as `origSource` and the\n * created canvas is the new `source`. The SVG is scaled using `sourceScale`. Called by\n * `_loadSvgSourceUsingXhr` or `_loadSvgSourceUsingDataUri`.\n *\n * @param {string} svgString SVG source as string\n *\n * @fires loaded\n */",
"meta": {
"range": [
15433,
16774
],
"filename": "BaseTexture.js",
"lineno": 531,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100116979",
"name": "BaseTexture#_loadSvgSourceUsingString",
"type": "MethodDefinition",
"paramnames": [
"svgString"
]
},
"vars": {
"": null
}
},
"description": "
Loads texture using an SVG string. The original SVG Image is stored as origSource and the created canvas is the new source. The SVG is scaled using sourceScale. Called by _loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.
",
"name": "destroy",
"longname": "PIXI.BaseTexture#destroy",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R010850",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturedestroy",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Frees the texture from WebGL memory without destroying this texture object.\n * This means you can still use the texture later which will upload it to GPU\n * memory again.\n *\n */",
"meta": {
"range": [
17838,
17895
],
"filename": "BaseTexture.js",
"lineno": 623,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100117230",
"name": "BaseTexture#dispose",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "
Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.
",
"name": "dispose",
"longname": "PIXI.BaseTexture#dispose",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"params": [],
"___id": "T000002R010856",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturedispose",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Changes the source image of the texture.\n * The original source must be an Image element.\n *\n * @param {string} newSrc - the path of the image\n */",
"meta": {
"range": [
18079,
18189
],
"filename": "BaseTexture.js",
"lineno": 634,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100117241",
"name": "BaseTexture#updateSourceImage",
"type": "MethodDefinition",
"paramnames": [
"newSrc"
]
},
"vars": {
"": null
}
},
"description": "
Changes the source image of the texture. The original source must be an Image element.
",
"name": "newSrc"
}
],
"name": "updateSourceImage",
"longname": "PIXI.BaseTexture#updateSourceImage",
"kind": "function",
"memberof": "PIXI.BaseTexture",
"scope": "instance",
"___id": "T000002R010857",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureupdateSourceImage",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Helper function that creates a base texture from the given image url.\n * If the image is not in the base 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=(auto)] - Should use anonymous CORS? Defaults to true if the URL is not a data-URI.\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.BaseTexture} The new base texture.\n */",
"meta": {
"range": [
18843,
19954
],
"filename": "BaseTexture.js",
"lineno": 652,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {
"id": "astnode100117262",
"name": "BaseTexture.fromImage",
"type": "MethodDefinition",
"paramnames": [
"imageUrl",
"crossorigin",
"scaleMode",
"sourceScale"
]
},
"vars": {
"": null
}
},
"description": "
Helper function that creates a base texture from the given image url. If the image is not in the base texture cache it will be created and loaded.
",
"kind": "member",
"name": "scaleMode",
"type": {
"names": [
"number"
]
},
"defaultvalue": "PIXI.settings.SCALE_MODE",
"see": [
"PIXI.SCALE_MODES"
],
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#scaleMode",
"scope": "instance",
"___id": "T000002R003822",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturescaleMode",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Set to true once the base texture has successfully loaded.\n *\n * This is never true if the underlying source fails to load or has no texture data.\n *\n * @readonly\n * @member {boolean} PIXI.BaseTexture#hasLoaded\n */",
"meta": {
"range": [
2480,
2757
],
"filename": "BaseTexture.js",
"lineno": 84,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set to true once the base texture has successfully loaded.
\n
This is never true if the underlying source fails to load or has no texture data.
",
"readonly": true,
"kind": "member",
"name": "hasLoaded",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#hasLoaded",
"scope": "instance",
"___id": "T000002R003824",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturehasLoaded",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Set to true if the source is currently loading.\n *\n * If an Image source is loading the 'loaded' or 'error' event will be\n * dispatched when the operation ends. An underyling source that is\n * immediately-available bypasses loading entirely.\n *\n * @readonly\n * @member {boolean} PIXI.BaseTexture#isLoading\n */",
"meta": {
"range": [
2799,
3187
],
"filename": "BaseTexture.js",
"lineno": 94,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set to true if the source is currently loading.
\n
If an Image source is loading the 'loaded' or 'error' event will be dispatched when the operation ends. An underyling source that is immediately-available bypasses loading entirely.
",
"readonly": true,
"kind": "member",
"name": "isLoading",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#isLoading",
"scope": "instance",
"___id": "T000002R003826",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureisLoading",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * The image source that is used to create the texture.\n *\n * TODO: Make this a setter that calls loadSource();\n *\n * @readonly\n * @member {HTMLImageElement|HTMLCanvasElement} PIXI.BaseTexture#source\n */",
"meta": {
"range": [
3229,
3492
],
"filename": "BaseTexture.js",
"lineno": 106,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
The image source that is used to create the texture.
\n
TODO: Make this a setter that calls loadSource();
",
"readonly": true,
"kind": "member",
"name": "source",
"type": {
"names": [
"HTMLImageElement",
"HTMLCanvasElement"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#source",
"scope": "instance",
"___id": "T000002R003828",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturesource",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * The image source that is used to create the texture. This is used to\n * store the original Svg source when it is replaced with a canvas element.\n *\n * TODO: Currently not in use but could be used when re-scaling svg.\n *\n * @readonly\n * @member {Image} PIXI.BaseTexture#origSource\n */",
"meta": {
"range": [
3562,
3916
],
"filename": "BaseTexture.js",
"lineno": 116,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
The image source that is used to create the texture. This is used to store the original Svg source when it is replaced with a canvas element.
\n
TODO: Currently not in use but could be used when re-scaling svg.
Scale for source image. Used with Svg images to scale them before rasterization.
",
"readonly": true,
"kind": "member",
"name": "sourceScale",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#sourceScale",
"scope": "instance",
"___id": "T000002R003834",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturesourceScale",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)\n * All blend modes, and shaders written for default value. Change it on your own risk.\n *\n * @member {boolean} PIXI.BaseTexture#premultipliedAlpha\n * @default true\n */",
"meta": {
"range": [
4457,
4752
],
"filename": "BaseTexture.js",
"lineno": 143,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Controls if RGB channels should be pre-multiplied by Alpha (WebGL only) All blend modes, and shaders written for default value. Change it on your own risk.
",
"kind": "member",
"name": "imageUrl",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#imageUrl",
"scope": "instance",
"___id": "T000002R003838",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureimageUrl",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Whether or not the texture is a power of two, try to use power of two textures as much\n * as you can\n *\n * @private\n * @member {boolean} PIXI.BaseTexture#isPowerOfTwo\n */",
"meta": {
"range": [
4962,
5187
],
"filename": "BaseTexture.js",
"lineno": 159,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Whether or not the texture is a power of two, try to use power of two textures as much as you can
",
"access": "private",
"kind": "member",
"name": "isPowerOfTwo",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#isPowerOfTwo",
"scope": "instance",
"___id": "T000002R003840",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureisPowerOfTwo",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n *\n * Set this to true if a mipmap of this texture needs to be generated. This value needs\n * to be set before the texture is used\n * Also the texture must be a power of two size to work\n *\n * @member {boolean} PIXI.BaseTexture#mipmap\n * @see PIXI.MIPMAP_TEXTURES\n */",
"meta": {
"range": [
5259,
5594
],
"filename": "BaseTexture.js",
"lineno": 170,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work
",
"kind": "member",
"name": "scaleMode",
"type": {
"names": [
"number"
]
},
"defaultvalue": "PIXI.settings.SCALE_MODE",
"see": [
"PIXI.SCALE_MODES"
],
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#scaleMode",
"scope": "instance",
"___id": "T000002R010756",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturescaleMode",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Set to true once the base texture has successfully loaded.\n *\n * This is never true if the underlying source fails to load or has no texture data.\n *\n * @readonly\n * @member {boolean} PIXI.BaseTexture#hasLoaded\n */",
"meta": {
"range": [
2480,
2757
],
"filename": "BaseTexture.js",
"lineno": 84,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set to true once the base texture has successfully loaded.
\n
This is never true if the underlying source fails to load or has no texture data.
",
"readonly": true,
"kind": "member",
"name": "hasLoaded",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#hasLoaded",
"scope": "instance",
"___id": "T000002R010758",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturehasLoaded",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Set to true if the source is currently loading.\n *\n * If an Image source is loading the 'loaded' or 'error' event will be\n * dispatched when the operation ends. An underyling source that is\n * immediately-available bypasses loading entirely.\n *\n * @readonly\n * @member {boolean} PIXI.BaseTexture#isLoading\n */",
"meta": {
"range": [
2799,
3187
],
"filename": "BaseTexture.js",
"lineno": 94,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set to true if the source is currently loading.
\n
If an Image source is loading the 'loaded' or 'error' event will be dispatched when the operation ends. An underyling source that is immediately-available bypasses loading entirely.
",
"readonly": true,
"kind": "member",
"name": "isLoading",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#isLoading",
"scope": "instance",
"___id": "T000002R010760",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureisLoading",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * The image source that is used to create the texture.\n *\n * TODO: Make this a setter that calls loadSource();\n *\n * @readonly\n * @member {HTMLImageElement|HTMLCanvasElement} PIXI.BaseTexture#source\n */",
"meta": {
"range": [
3229,
3492
],
"filename": "BaseTexture.js",
"lineno": 106,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
The image source that is used to create the texture.
\n
TODO: Make this a setter that calls loadSource();
",
"readonly": true,
"kind": "member",
"name": "source",
"type": {
"names": [
"HTMLImageElement",
"HTMLCanvasElement"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#source",
"scope": "instance",
"___id": "T000002R010762",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturesource",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * The image source that is used to create the texture. This is used to\n * store the original Svg source when it is replaced with a canvas element.\n *\n * TODO: Currently not in use but could be used when re-scaling svg.\n *\n * @readonly\n * @member {Image} PIXI.BaseTexture#origSource\n */",
"meta": {
"range": [
3562,
3916
],
"filename": "BaseTexture.js",
"lineno": 116,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
The image source that is used to create the texture. This is used to store the original Svg source when it is replaced with a canvas element.
\n
TODO: Currently not in use but could be used when re-scaling svg.
Scale for source image. Used with Svg images to scale them before rasterization.
",
"readonly": true,
"kind": "member",
"name": "sourceScale",
"type": {
"names": [
"number"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#sourceScale",
"scope": "instance",
"___id": "T000002R010768",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTexturesourceScale",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)\n * All blend modes, and shaders written for default value. Change it on your own risk.\n *\n * @member {boolean} PIXI.BaseTexture#premultipliedAlpha\n * @default true\n */",
"meta": {
"range": [
4457,
4752
],
"filename": "BaseTexture.js",
"lineno": 143,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Controls if RGB channels should be pre-multiplied by Alpha (WebGL only) All blend modes, and shaders written for default value. Change it on your own risk.
",
"kind": "member",
"name": "imageUrl",
"type": {
"names": [
"string"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#imageUrl",
"scope": "instance",
"___id": "T000002R010772",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureimageUrl",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n * Whether or not the texture is a power of two, try to use power of two textures as much\n * as you can\n *\n * @private\n * @member {boolean} PIXI.BaseTexture#isPowerOfTwo\n */",
"meta": {
"range": [
4962,
5187
],
"filename": "BaseTexture.js",
"lineno": 159,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Whether or not the texture is a power of two, try to use power of two textures as much as you can
",
"access": "private",
"kind": "member",
"name": "isPowerOfTwo",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.BaseTexture",
"longname": "PIXI.BaseTexture#isPowerOfTwo",
"scope": "instance",
"___id": "T000002R010774",
"___s": true,
"skip": true,
"slug": "PIXI.BaseTextureisPowerOfTwo",
"filepath": "core\\textures\\BaseTexture.js"
},
{
"comment": "/**\n *\n * Set this to true if a mipmap of this texture needs to be generated. This value needs\n * to be set before the texture is used\n * Also the texture must be a power of two size to work\n *\n * @member {boolean} PIXI.BaseTexture#mipmap\n * @see PIXI.MIPMAP_TEXTURES\n */",
"meta": {
"range": [
5259,
5594
],
"filename": "BaseTexture.js",
"lineno": 170,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\textures",
"code": {}
},
"description": "
Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work