import type { RENDERER_TYPE } from '@pixi/constants'; import type { Matrix, Rectangle, Transform } from '@pixi/math'; import type { IGenerateTextureOptions } from './renderTexture/GenerateTextureSystem'; import type { IRendererPlugins } from './plugin/PluginSystem'; import type { RenderTexture } from './renderTexture/RenderTexture'; import type { SystemManager } from './system/SystemManager'; /** * Interface for DisplayObject to interface with Renderer. * The minimum APIs needed to implement a renderable object. * @memberof PIXI */ export interface IRenderableObject extends GlobalMixins.IRenderableObject { /** Object must have a parent container */ parent: IRenderableContainer; /** Object must have a transform */ transform: Transform; /** Before method for transform updates */ enableTempParent(): IRenderableContainer; /** Update the transforms */ updateTransform(): void; /** After method for transform updates */ disableTempParent(parent: IRenderableContainer): void; /** Render object directly */ render(renderer: IRenderer): void; } /** * Interface for Container to interface with Renderer. * @memberof PIXI */ export interface IRenderableContainer extends IRenderableObject { /** Get Local bounds for container */ getLocalBounds(rect?: Rectangle, skipChildrenUpdate?: boolean): Rectangle; } /** Mixed WebGL1/WebGL2 Rendering Context. Either its WebGL2, either its WebGL1 with PixiJS polyfills on it */ // eslint-disable-next-line @typescript-eslint/no-empty-interface export interface IRenderingContext extends WebGL2RenderingContext { } export interface IRendererOptions extends GlobalMixins.IRendererOptions { width?: number; height?: number; view?: HTMLCanvasElement; /** * Use premultipliedAlpha and backgroundAlpha instead * @deprecated since 7.0.0 */ useContextAlpha?: boolean | 'notMultiplied'; autoDensity?: boolean; antialias?: boolean; resolution?: number; preserveDrawingBuffer?: boolean; clearBeforeRender?: boolean; backgroundColor?: number; backgroundAlpha?: number; premultipliedAlpha?: boolean; powerPreference?: WebGLPowerPreference; context?: IRenderingContext; } export interface IRendererRenderOptions { renderTexture?: RenderTexture; blit?: boolean clear?: boolean; transform?: Matrix; skipUpdateTransform?: boolean; } /** * Starard Interface for a Pixi renderer. * @memberof PIXI */ export interface IRenderer extends SystemManager, GlobalMixins.IRenderer { resize(width: number, height: number): void; render(displayObject: IRenderableObject, options?: IRendererRenderOptions): void generateTexture(displayObject: IRenderableObject, options?: IGenerateTextureOptions): void destroy(removeView?: boolean): void; clear(): void; reset(): void; /** * The type of the renderer. * @see PIXI.RENDERER_TYPE */ readonly type: RENDERER_TYPE /** When logging Pixi to the console, this is the name we will show */ readonly rendererLogId: string /** The canvas element that everything is drawn to.*/ readonly view: HTMLCanvasElement /** Flag if we are rendering to the screen vs renderTexture */ readonly renderingToScreen: boolean /** The resolution / device pixel ratio of the renderer. */ readonly resolution: number /** the width of the screen */ readonly width: number /** the height of the screen */ readonly height: number /** * Measurements of the screen. (0, 0, screenWidth, screenHeight). * Its safe to use as filterArea or hitArea for the whole stage. */ readonly screen: Rectangle /** the last object rendered by the renderer. Useful for other plugins like interaction managers */ readonly lastObjectRendered: IRenderableObject /** Collection of plugins */ readonly plugins: IRendererPlugins }