sdfsdfs
This commit is contained in:
54
node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts
generated
vendored
Normal file
54
node_modules/pixi.js/lib/rendering/renderers/autoDetectRenderer.d.ts
generated
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
import type { WebGLOptions } from './gl/WebGLRenderer';
|
||||
import type { WebGPUOptions } from './gpu/WebGPURenderer';
|
||||
import type { Renderer, RendererOptions } from './types';
|
||||
/**
|
||||
* Options for {@link rendering.autoDetectRenderer}.
|
||||
* @memberof rendering
|
||||
*/
|
||||
export interface AutoDetectOptions extends RendererOptions {
|
||||
/** The preferred renderer type. WebGPU is recommended as its generally faster than WebGL. */
|
||||
preference?: 'webgl' | 'webgpu';
|
||||
/** Optional WebGPUOptions to pass only to WebGPU renderer. */
|
||||
webgpu?: Partial<WebGPUOptions>;
|
||||
/** Optional WebGLOptions to pass only to the WebGL renderer */
|
||||
webgl?: Partial<WebGLOptions>;
|
||||
}
|
||||
/**
|
||||
* Automatically determines the most appropriate renderer for the current environment.
|
||||
*
|
||||
* The function will prioritize the WebGL renderer as it is the most tested safe API to use.
|
||||
* In the near future as WebGPU becomes more stable and ubiquitous, it will be prioritized over WebGL.
|
||||
*
|
||||
* The selected renderer's code is then dynamically imported to optimize
|
||||
* performance and minimize the initial bundle size.
|
||||
*
|
||||
* To maximize the benefits of dynamic imports, it's recommended to use a modern bundler
|
||||
* that supports code splitting. This will place the renderer code in a separate chunk,
|
||||
* which is loaded only when needed.
|
||||
* @example
|
||||
*
|
||||
* // create a renderer
|
||||
* const renderer = await autoDetectRenderer({
|
||||
* width: 800,
|
||||
* height: 600,
|
||||
* antialias: true,
|
||||
* });
|
||||
*
|
||||
* // custom for each renderer
|
||||
* const renderer = await autoDetectRenderer({
|
||||
* width: 800,
|
||||
* height: 600,
|
||||
* webgpu:{
|
||||
* antialias: true,
|
||||
* backgroundColor: 'red'
|
||||
* },
|
||||
* webgl:{
|
||||
* antialias: true,
|
||||
* backgroundColor: 'green'
|
||||
* }
|
||||
* });
|
||||
* @param options - A partial configuration object based on the `AutoDetectOptions` type.
|
||||
* @returns A Promise that resolves to an instance of the selected renderer.
|
||||
* @memberof rendering
|
||||
*/
|
||||
export declare function autoDetectRenderer(options: Partial<AutoDetectOptions>): Promise<Renderer>;
|
Reference in New Issue
Block a user