~~Class: TextureGCSystem~~
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:44
System plugin to the renderer to manage texture garbage collection on the GPU, ensuring that it does not get clogged up with textures that are no longer being used.
Advanced
Deprecated
since 8.15.0
See
Implements
Constructors
Constructor
> new TextureGCSystem(renderer): TextureGCSystem
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:92
Parameters
renderer
The renderer this System works for.
Returns
TextureGCSystem
Properties
~~defaultOptions~~
> static defaultOptions: TextureGCSystemOptions
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:54
Default options for the TextureGCSystem
Deprecated
since 8.15.0
Accessors
~~active~~
Get Signature
> get active(): boolean
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:88
Current garbage collection mode.
See
TextureGCSystem.defaultMode
Deprecated
since 8.15.0
Returns
boolean
Set Signature
> set active(value): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:89
Parameters
value
boolean
Returns
void
~~checkCount~~
Get Signature
> get checkCount(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:66
Frame count since last garbage collection.
Deprecated
since 8.15.0
Returns
number
~~checkCountMax~~
Get Signature
> get checkCountMax(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:81
Frames between two garbage collections.
See
TextureGCSystem.defaultCheckCountMax
Deprecated
since 8.15.0
Returns
number
Set Signature
> set checkCountMax(_value): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:82
Parameters
_value
number
Returns
void
~~count~~
Get Signature
> get count(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:60
Frame count since started.
Deprecated
since 8.15.0
Returns
number
~~maxIdle~~
Get Signature
> get maxIdle(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:74
Maximum idle frames before a texture is destroyed by garbage collection.
See
TextureGCSystem.defaultMaxIdle
Deprecated
since 8.15.0
Returns
number
Set Signature
> set maxIdle(value): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:75
Parameters
value
number
Returns
void
Methods
~~destroy()~~
> destroy(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:100
Generic destroy methods to be overridden by the subclass
Returns
void
Implementation of
~~init()~~
> init(options): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:93
Parameters
options
Returns
void
Implementation of
~~run()~~
> run(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/texture/TextureGCSystem.d.ts:99
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
Deprecated
since 8.15.0