import { GC_MODES } from '@pixi/constants'; import { settings } from '@pixi/settings'; import type { ISystem } from '../system/ISystem'; import type { Renderer } from '../Renderer'; import type { Texture } from './Texture'; import type { RenderTexture } from '../renderTexture/RenderTexture'; import type { ExtensionMetadata } from '@pixi/extensions'; import { extensions, ExtensionType } from '@pixi/extensions'; export interface IUnloadableTexture { _texture: Texture | RenderTexture; children: IUnloadableTexture[]; } /** * 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. * @memberof PIXI */ export class TextureGCSystem implements ISystem { /** @ignore */ static extension: ExtensionMetadata = { type: ExtensionType.RendererSystem, name: 'textureGC', }; /** * Count * @readonly */ public count: number; /** * Check count * @readonly */ public checkCount: number; /** * Maximum idle time, in seconds * @see PIXI.settings.GC_MAX_IDLE */ public maxIdle: number; /** * Maximum number of item to check * @see PIXI.settings.GC_MAX_CHECK_COUNT */ public checkCountMax: number; /** * Current garbage collection mode * @see PIXI.settings.GC_MODE */ public mode: GC_MODES; private renderer: Renderer; /** @param renderer - The renderer this System works for. */ constructor(renderer: Renderer) { this.renderer = renderer; this.count = 0; this.checkCount = 0; this.maxIdle = settings.GC_MAX_IDLE; this.checkCountMax = settings.GC_MAX_CHECK_COUNT; this.mode = settings.GC_MODE; } /** * 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 */ protected postrender(): void { if (!this.renderer.objectRenderer.renderingToScreen) { return; } this.count++; if (this.mode === GC_MODES.MANUAL) { return; } this.checkCount++; if (this.checkCount > this.checkCountMax) { this.checkCount = 0; this.run(); } } /** * 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 */ run(): void { const tm = this.renderer.texture; const managedTextures = tm.managedTextures; let wasRemoved = false; for (let i = 0; i < managedTextures.length; i++) { const texture = managedTextures[i]; // only supports non generated textures at the moment! if (!(texture as any).framebuffer && this.count - texture.touched > this.maxIdle) { tm.destroyTexture(texture, true); managedTextures[i] = null; wasRemoved = true; } } if (wasRemoved) { let j = 0; for (let i = 0; i < managedTextures.length; i++) { if (managedTextures[i] !== null) { managedTextures[j++] = managedTextures[i]; } } managedTextures.length = j; } } /** * Removes all the textures within the specified displayObject and its children from the GPU * @param {PIXI.DisplayObject} displayObject - the displayObject to remove the textures from. */ unload(displayObject: IUnloadableTexture): void { const tm = this.renderer.texture; const texture = displayObject._texture as RenderTexture; // only destroy non generated textures if (texture && !texture.framebuffer) { tm.destroyTexture(texture); } for (let i = displayObject.children.length - 1; i >= 0; i--) { this.unload(displayObject.children[i]); } } destroy(): void { this.renderer = null; } } extensions.add(TextureGCSystem);