Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@pixi/app
Advanced tools
@pixi/app - npm Package Compare versions
Comparing version 7.1.1 to 7.1.2
@@ -18,2 +18,6 @@ import { Container } from '@pixi/display'; | ||
| } | ||
| /** | ||
| * Application options supplied to constructor. | ||
| * @memberof PIXI | ||
| */ | ||
| export interface IApplicationOptions extends IRendererOptionsAuto, GlobalMixins.IApplicationOptions { | ||
@@ -55,32 +59,49 @@ } | ||
| /** | ||
| * @param {object} [options] - The optional renderer parameters. | ||
| * @param {PIXI.IApplicationOptions} [options] - The optional application and renderer parameters. | ||
| * @param {boolean} [options.antialias=false] - | ||
| * **WebGL Only.** Whether to enable anti-aliasing. This may affect performance. | ||
| * @param {boolean} [options.autoDensity=false] - | ||
| * Whether the CSS dimensions of the renderer's view should be resized automatically. | ||
| * @param {boolean} [options.autoStart=true] - Automatically starts the rendering after the construction. | ||
| * **Note**: Setting this parameter to false does NOT stop the shared ticker even if you set | ||
| * options.sharedTicker to true in case that it is already started. Stop it by your own. | ||
| * @param {number} [options.width=800] - The width of the renderers view. | ||
| * @param {number} [options.height=600] - The height of the renderers view. | ||
| * @param {PIXI.ICanvas} [options.view] - The canvas to use as a view, optional. | ||
| * @param {boolean} [options.premultipliedAlpha=true] - Set to `false` to disable premultipliedAlpha. | ||
| * @param {boolean} [options.autoDensity=false] - Resizes renderer view in CSS pixels to allow for | ||
| * resolutions other than 1. | ||
| * @param {boolean} [options.antialias=false] - Sets antialias | ||
| * @param {boolean} [options.preserveDrawingBuffer=false] - Enables drawing buffer preservation, enable this if you | ||
| * need to call toDataURL on the WebGL context. | ||
| * @param {number} [options.resolution=PIXI.settings.RESOLUTION] - The resolution / device pixel ratio of the renderer. | ||
| * @param {boolean} [options.forceCanvas=false] - prevents selection of WebGL renderer, even if such is present, this | ||
| * option only is available when using **pixi.js-legacy** or **@pixi/canvas-renderer** modules, otherwise | ||
| * it is ignored. | ||
| * @param {number|string} [options.backgroundColor=0x000000] - The background color of the rendered area | ||
| * (shown if not transparent). Also, accepts hex strings or color names (e.g., 'white'). | ||
| * **Note**: Setting this parameter to `false` does NOT stop the shared ticker even if you set | ||
| * `options.sharedTicker` to `true` in case that it is already started. Stop it by your own. | ||
| * @param {number|string} [options.background] - Alias for `options.backgroundColor`. | ||
| * @param {number} [options.backgroundAlpha=1] - Value from 0 (fully transparent) to 1 (fully opaque). | ||
| * @param {boolean} [options.clearBeforeRender=true] - This sets if the renderer will clear the canvas or | ||
| * not before the new render pass. | ||
| * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" | ||
| * for devices with dual graphics card. **(WebGL only)**. | ||
| * @param {boolean} [options.sharedTicker=false] - `true` to use Ticker.shared, `false` to create new ticker. | ||
| * If set to false, you cannot register a handler to occur before anything that runs on the shared ticker. | ||
| * @param {number} [options.backgroundAlpha=1] - | ||
| * Transparency of the background color, value from `0` (fully transparent) to `1` (fully opaque). | ||
| * @param {number|string} [options.backgroundColor=0x000000] - | ||
| * The background color used to clear the canvas. It accepts hex numbers (e.g. `0xff0000`), | ||
| * hex strings (e.g. `'#f00'` or `'#ff0000'`) or color names (e.g. `'red'`). | ||
| * @param {boolean} [options.clearBeforeRender=true] - Whether to clear the canvas before new render passes. | ||
| * @param {PIXI.IRenderingContext} [options.context] - **WebGL Only.** User-provided WebGL rendering context object. | ||
| * @param {boolean} [options.forceCanvas=false] - | ||
| * Force using {@link PIXI.CanvasRenderer}, even if WebGL is available. This option only is available when | ||
| * using **pixi.js-legacy** or **@pixi/canvas-renderer** packages, otherwise it will throw an error. | ||
| * @param {number} [options.height=600] - The height of the renderer's view. | ||
| * @param {boolean} [options.hello=false] - Whether to log the version and type information of renderer to console. | ||
| * @param {string} [options.powerPreference] - | ||
| * **WebGL Only.** A hint indicating what configuration of GPU is suitable for the WebGL context, | ||
| * can be `'default'`, `'high-performance'` or `'low-power'`. | ||
| * Setting to `'high-performance'` will prioritize rendering performance over power consumption, | ||
| * while setting to `'low-power'` will prioritize power saving over rendering performance. | ||
| * @param {boolean} [options.premultipliedAlpha=true] - | ||
| * **WebGL Only.** Whether the compositor will assume the drawing buffer contains colors with premultiplied alpha. | ||
| * @param {boolean} [options.preserveDrawingBuffer=false] - | ||
| * **WebGL Only.** Whether to enable drawing buffer preservation. If enabled, the drawing buffer will preserve | ||
| * its value until cleared or overwritten. Enable this if you need to call `toDataUrl` on the WebGL context. | ||
| * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. | ||
| * @param {number} [options.resolution=PIXI.settings.RESOLUTION] - | ||
| * The resolution / device pixel ratio of the renderer. | ||
| * @param {boolean} [options.sharedTicker=false] - `true` to use `Ticker.shared`, `false` to create new ticker. | ||
| * If set to `false`, you cannot register a handler to occur before anything that runs on the shared ticker. | ||
| * The system ticker will always run before both the shared ticker and the app ticker. | ||
| * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. | ||
| * @param {boolean} [options.hello=false] - Logs renderer type and version. | ||
| * @param {boolean|'notMultiplied'} [options.useContextAlpha=true] - | ||
| * **Deprecated since 7.0.0, use `premultipliedAlpha` and `backgroundAlpha` instead.** \ | ||
| * Pass-through value for canvas' context attribute `alpha`. This option is for cases where the | ||
| * canvas needs to be opaque, possibly for performance reasons on some older devices. | ||
| * If you want to set transparency, please use `backgroundAlpha`. \ | ||
| * **WebGL Only:** When set to `'notMultiplied'`, the canvas' context attribute `alpha` will be | ||
| * set to `true` and `premultipliedAlpha` will be to `false`. | ||
| * @param {PIXI.ICanvas} [options.view=null] - | ||
| * The canvas to use as the view. If omitted, a new canvas will be created. | ||
| * @param {number} [options.width=800] - The width of the renderer's view. | ||
| */ | ||
@@ -87,0 +108,0 @@ constructor(options?: IApplicationOptions); |
| { | ||
| "name": "@pixi/app", | ||
| "version": "7.1.1", | ||
| "version": "7.1.2", | ||
| "main": "lib/index.js", | ||
@@ -42,3 +42,3 @@ "module": "lib/index.mjs", | ||
| ], | ||
| "gitHead": "99b26d1d5a18760019b034c69c5979ca5e6c536b" | ||
| "gitHead": "27e65c73bb36a06fd00d6da5bf460bbee9f6c984" | ||
| } |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by9.73%
51759
- Lines of code
- increased by5.47%
405
No dependency changes