class: TextureGarbageCollector

TextureGarbageCollector. This class manages the GPU and ensures that it does not get clogged
up with textures that are no longer being used.

Methods summary

Methods

update(): void

Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU

Returns:

void

run(): void

Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU

Returns:

void

unload(displayObject: PIXI.DisplayObject): void

Removes all the textures within the specified displayObject and its children from the GPU

Params:

Returns:

void

update(): void

Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU

Returns:

void

run(): void

Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU

Returns:

void

unload(displayObject: PIXI.DisplayObject): void

Removes all the textures within the specified displayObject and its children from the GPU

Params:

Returns:

void

  {
    "comment": "/**\n * TextureGarbageCollector. This class manages the GPU and ensures that it does not get clogged\n * up with textures that are no longer being used.\n *\n * @class\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            307,
            2952
        ],
        "filename": "TextureGarbageCollector.js",
        "lineno": 13,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
        "code": {
            "id": "astnode100026961",
            "name": "TextureGarbageCollector",
            "type": "ClassDeclaration",
            "paramnames": [
                "renderer"
            ]
        }
    },
    "classdesc": "
TextureGarbageCollector. This class manages the GPU and ensures that it does not get clogged
up with textures that are no longer being used.
",
    "kind": "class",
    "memberof": "PIXI",
    "name": "TextureGarbageCollector",
    "longname": "PIXI.TextureGarbageCollector",
    "scope": "static",
    "params": [
        {
            "type": {
                "names": [
                    "PIXI.WebGLRenderer"
                ]
            },
            "description": "
The renderer this manager works for.
",
            "name": "renderer"
        }
    ],
    "___id": "T000002R002496",
    "___s": true,
    "$methods": [
        {
            "comment": "/**\n     * Checks to see when the last time a texture was used\n     * if the texture has not been used for a specified amount of time it will be removed from the GPU\n     */",
            "meta": {
                "range": [
                    888,
                    1171
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 33,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100027011",
                    "name": "TextureGarbageCollector#update",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU
",
            "name": "update",
            "longname": "PIXI.TextureGarbageCollector#update",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "params": [],
            "___id": "T000002R002504",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorupdate",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        },
        {
            "comment": "/**\n     * Checks to see when the last time a texture was used\n     * if the texture has not been used for a specified amount of time it will be removed from the GPU\n     */",
            "meta": {
                "range": [
                    1355,
                    2294
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 56,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100027055",
                    "name": "TextureGarbageCollector#run",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU
",
            "name": "run",
            "longname": "PIXI.TextureGarbageCollector#run",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "params": [],
            "___id": "T000002R002506",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorrun",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        },
        {
            "comment": "/**\n     * Removes all the textures within the specified displayObject and its children from the GPU\n     *\n     * @param {PIXI.DisplayObject} displayObject - the displayObject to remove the textures from.\n     */",
            "meta": {
                "range": [
                    2518,
                    2950
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 96,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100027173",
                    "name": "TextureGarbageCollector#unload",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "displayObject"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Removes all the textures within the specified displayObject and its children from the GPU
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.DisplayObject"
                        ]
                    },
                    "description": "
the displayObject to remove the textures from.
",
                    "name": "displayObject"
                }
            ],
            "name": "unload",
            "longname": "PIXI.TextureGarbageCollector#unload",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "___id": "T000002R002518",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorunload",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        },
        {
            "comment": "/**\n     * Checks to see when the last time a texture was used\n     * if the texture has not been used for a specified amount of time it will be removed from the GPU\n     */",
            "meta": {
                "range": [
                    888,
                    1171
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 33,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100101690",
                    "name": "TextureGarbageCollector#update",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU
",
            "name": "update",
            "longname": "PIXI.TextureGarbageCollector#update",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "params": [],
            "___id": "T000002R009438",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorupdate",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        },
        {
            "comment": "/**\n     * Checks to see when the last time a texture was used\n     * if the texture has not been used for a specified amount of time it will be removed from the GPU\n     */",
            "meta": {
                "range": [
                    1355,
                    2294
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 56,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100101734",
                    "name": "TextureGarbageCollector#run",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Checks to see when the last time a texture was used
if the texture has not been used for a specified amount of time it will be removed from the GPU
",
            "name": "run",
            "longname": "PIXI.TextureGarbageCollector#run",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "params": [],
            "___id": "T000002R009440",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorrun",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        },
        {
            "comment": "/**\n     * Removes all the textures within the specified displayObject and its children from the GPU\n     *\n     * @param {PIXI.DisplayObject} displayObject - the displayObject to remove the textures from.\n     */",
            "meta": {
                "range": [
                    2518,
                    2950
                ],
                "filename": "TextureGarbageCollector.js",
                "lineno": 96,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
                "code": {
                    "id": "astnode100101852",
                    "name": "TextureGarbageCollector#unload",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "displayObject"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Removes all the textures within the specified displayObject and its children from the GPU
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.DisplayObject"
                        ]
                    },
                    "description": "
the displayObject to remove the textures from.
",
                    "name": "displayObject"
                }
            ],
            "name": "unload",
            "longname": "PIXI.TextureGarbageCollector#unload",
            "kind": "function",
            "memberof": "PIXI.TextureGarbageCollector",
            "scope": "instance",
            "___id": "T000002R009452",
            "___s": true,
            "skip": true,
            "slug": "PIXI.TextureGarbageCollectorunload",
            "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
        }
    ],
    "$attributes": [],
    "$staticmethods": [],
    "$staticproperties": [],
    "$augments": [],
    "$augmentedBy": [],
    "filepath": "core\\renderers\\webgl\\TextureGarbageCollector.js"
}