PIXI

Namespace: settings

PIXI. settings

User's customizable globals for overriding the default PIXI settings, such as a renderer's default resolution, framerate, float percision, etc.

Example

// Use the native window resolution as the default resolution
// will support high-density displays when rendering
PIXI.settings.RESOLUTION = window.devicePixelRatio.

// Disable interpolation when scaling, will make texture be pixelated
PIXI.settings.SCALE_MODE = PIXI.SCALE_MODES.NEAREST;

Members

staticPIXI.settings.FILTER_RESOLUTIONnumber

Default filter resolution.

Default Value:
  • 1

staticPIXI.settings.GC_MAX_CHECK_COUNTnumber

Default Garbage Collection maximum check count.

Default Value:
  • 600

staticPIXI.settings.GC_MAX_IDLEnumber

Default Garbage Collection max idle.

Default Value:
  • 3600

staticPIXI.settings.GC_MODEPIXI.GC_MODES

Default Garbage Collection mode.

Default Value:
  • PIXI.GC_MODES.AUTO

staticPIXI.settings.MIPMAP_TEXTURESboolean

If set to true WebGL will attempt make textures mimpaped by default. Mipmapping will only succeed if the base texture uploaded has power of two dimensions.

Default Value:
  • true

staticPIXI.settings.PRECISION

Deprecated
  • since version 4.4.0
    See:

    staticPIXI.settings.PRECISION_FRAGMENTPIXI.PRECISION

    Default specify float precision in fragment shader.

    Default Value:
    • PIXI.PRECISION.MEDIUM

    staticPIXI.settings.PRECISION_VERTEXPIXI.PRECISION

    Default specify float precision in vertex shader.

    Default Value:
    • PIXI.PRECISION.HIGH

    static,constantPIXI.settings.RENDER_OPTIONSobject

    The default render options if none are supplied to PIXI.WebGLRenderer or PIXI.CanvasRenderer.

    Properties:
    Name Type Default Description
    view HTMLCanvasElement null
    resolution number 1
    antialias boolean false
    forceFXAA boolean false
    autoResize boolean false
    transparent boolean false
    backgroundColor number 0x000000
    clearBeforeRender boolean true
    preserveDrawingBuffer boolean false
    roundPixels boolean false
    width number 800
    height number 600
    legacy boolean false

    staticPIXI.settings.RESOLUTIONnumber

    Default resolution / device pixel ratio of the renderer.

    Default Value:
    • 1

    staticPIXI.settings.RETINA_PREFIXRegExp

    The prefix that denotes a URL is for a retina asset.

    Default Value:
    • /@([0-9\.]+)x/
    Example
    `@2x`

    staticPIXI.settings.SCALE_MODEPIXI.SCALE_MODES

    The scale modes that are supported by pixi.

    Default Value:
    • PIXI.SCALE_MODES.LINEAR

    staticPIXI.settings.SPRITE_BATCH_SIZEnumber

    The default sprite batch size.

    The default aims to balance desktop and mobile devices.

    Default Value:
    • 4096

    staticPIXI.settings.SPRITE_MAX_TEXTURESnumber

    The maximum textures that this device supports.

    Default Value:
    • 32

    staticPIXI.settings.TARGET_FPMSnumber

    Target frames per millisecond.

    Default Value:
    • 0.06

    staticPIXI.settings.TRANSFORM_MODEPIXI.TRANSFORM_MODE

    Default transform type.

    Default Value:
    • PIXI.TRANSFORM_MODE.STATIC

    staticPIXI.settings.UPLOADS_PER_FRAMEnumber

    Default number of uploads per frame using prepare plugin.

    Default Value:
    • 4

    staticPIXI.settings.WRAP_MODEPIXI.WRAP_MODES

    Default wrap modes that are supported by pixi.

    Default Value:
    • PIXI.WRAP_MODES.CLAMP