UNPKG

1.09 kBTypeScriptView Raw
1import type { ICanvas } from '@pixi/settings';
2import type { IRenderer, IRendererOptions } from './IRenderer';
3/**
4 * Renderer options supplied to `autoDetectRenderer`.
5 * @memberof PIXI
6 */
7export interface IRendererOptionsAuto extends IRendererOptions {
8 /**
9 * Force CanvasRenderer even if WebGL is supported. Only available with **pixi.js-legacy**.
10 * @default false
11 */
12 forceCanvas?: boolean;
13}
14export interface IRendererConstructor<VIEW extends ICanvas = ICanvas> {
15 test(options?: Partial<IRendererOptionsAuto>): boolean;
16 new (options?: Partial<IRendererOptionsAuto>): IRenderer<VIEW>;
17}
18/**
19 * This helper function will automatically detect which renderer you should be using.
20 * WebGL is the preferred renderer as it is a lot faster. If WebGL is not supported by
21 * the browser then this function will return a canvas renderer.
22 * @memberof PIXI
23 * @function autoDetectRenderer
24 * @param options - Options to use.
25 */
26export declare function autoDetectRenderer<VIEW extends ICanvas = ICanvas>(options?: Partial<IRendererOptionsAuto>): IRenderer<VIEW>;