Example
import { settings, ENV } from 'pixi.js';
// Use the native window resolution as the default resolution
// will support high-density displays when rendering
settings.RESOLUTION = window.devicePixelRatio;
// Used for older v1 WebGL devices for backwards compatibility
settings.PREFER_ENV = ENV.WEBGL_LEGACY;Members
PIXI.settings.ADAPTER PIXI.IAdapter static
This adapter is used to call methods that are platform dependent.
For example document.createElement only runs on the web but fails in node environments.
This allows us to support more platforms by abstracting away specific implementations per platform.
By default the adapter is set to work in the browser. However you can create your own
by implementing the IAdapter interface. See IAdapter for more information.
- Default Value:
- PIXI.BrowserAdapter
Can we upload the same buffer in a single frame?
Enables bitmap creation before image load. This feature is experimental.
- Default Value:
- false
Should the failIfMajorPerformanceCaveat flag be enabled as a context option used in the isWebGLSupported function.
If set to true, a WebGL renderer can fail to be created if the browser thinks there could be performance issues when
using WebGL.
In PixiJS v6 this has changed from true to false by default, to allow WebGL to work in as many scenarios as possible. However, some users may have a poor experience, for example, if a user has a gpu or driver version blacklisted by the browser.
If your application requires high performance rendering, you may wish to set this to false. We recommend one of two options if you decide to set this flag to false:
1: Use the pixi.js-legacy package, which includes a Canvas renderer as a fallback in case high performance WebGL is
not supported.
2: Call isWebGLSupported (which if found in the PIXI.utils package) in your code before attempting to create a PixiJS
renderer, and show an error message to the user if the function returns false, explaining that their device & browser
combination does not support high performance WebGL.
This is a much better strategy than trying to create a PixiJS renderer and finding it then fails.
- Default Value:
- false
PIXI.settings.FILTER_MULTISAMPLE PIXI.MSAA_QUALITY Deprecated : since 7.1.0 static
Default filter samples.
Default filter resolution.
Default Garbage Collection maximum check count.
Default Garbage Collection max idle.
PIXI.settings.GC_MODE PIXI.GC_MODES Deprecated : since 7.1.0 static
Default Garbage Collection mode.
Default canvasPadding for canvas-based Mesh rendering.
PIXI.settings.MIPMAP_TEXTURES PIXI.MIPMAP_MODES Deprecated : since 7.1.0 static
PIXI.settings.PRECISION_FRAGMENT PIXI.PRECISION Deprecated : since 7.1.0 static
Default specify float precision in fragment shader.
PIXI.settings.PRECISION_VERTEX PIXI.PRECISION Deprecated : since 7.1.0 static
Default specify float precision in vertex shader.
The maximum support for using WebGL. If a device does not support WebGL version, for instance WebGL 2, it will still attempt to fallback support to WebGL 1. If you want to explicitly remove feature support to target a more stable baseline, prefer a lower environment.
- Default Value:
- PIXI.ENV.WEBGL2
PIXI.settings.RENDER_OPTIONS PIXI.IRendererOptions static
The default render options if none are supplied to PIXI.Renderer or PIXI.CanvasRenderer.
Properties:
| Name | Type | Default | Description |
|---|---|---|---|
antialias |
boolean | false | |
autoDensity |
boolean | false | |
backgroundAlpha |
number | 1 | |
backgroundColor |
number | 0x000000 | |
clearBeforeRender |
boolean | true | |
context |
null | ||
height |
number | 600 | |
hello |
boolean | false | |
powerPreference |
string | default | |
premultipliedAlpha |
boolean | true | |
preserveDrawingBuffer |
boolean | false | |
resolution |
number | PIXI.settings.RESOLUTION | |
width |
number | 800 |
Default resolution / device pixel ratio of the renderer.
- Default Value:
- 1
The prefix that denotes a URL is for a retina asset.
- Default Value:
- /@([0-9\.]+)x/
Example
`@2x`If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth.
- Default Value:
- false
PIXI.settings.SCALE_MODE PIXI.SCALE_MODES Deprecated : since 7.1.0 static
Sets the default value for the container property 'sortableChildren'.
The default sprite batch size.
The default aims to balance desktop and mobile devices.
The maximum textures that this device supports.
If set to true, only Textures and BaseTexture objects stored
in the caches (TextureCache and
BaseTextureCache) can be
used when calling Texture.from or
BaseTexture.from.
Otherwise, these from calls throw an exception. Using this property
can be useful if you want to enforce preloading all assets with
Loader.
- Default Value:
- false
Target frames per millisecond.
Default number of uploads per frame using prepare plugin.