Namespace: PIXI

Classes

AbstractFilter

AccessibilityManager

BaseTexture

BlendModeManager

CanvasBuffer

CanvasGraphics

CanvasMaskManager

CanvasRenderer

CanvasTinter

Circle

ComplexPrimitiveShader

Container

DisplayObject

Ellipse

FilterManager

FXAAFilter

Graphics

GraphicsData

MaskManager

Matrix

ObjectRenderer

ParticleContainer

ParticleShader

Point

Polygon

PrimitiveShader

Quad

Rectangle

RenderTarget

RenderTexture

RoundedRectangle

Shader

ShaderManager

Sprite

SpriteMaskFilter

StencilMaskStack

SystemRenderer

Text

Texture

TextureShader

VideoBaseTexture

WebGLManager

WebGLMaskManager

WebGLRenderer

Namespaces

extras

filters

GroupD8

interaction

interaction

loaders

mesh

ticker

utils

Members

static,constantPIXI.BLEND_MODES

Various blend modes supported by PIXI. IMPORTANT - The WebGL renderer only supports
the NORMAL, ADD, MULTIPLY and SCREEN blend modes. Anything else will silently act like
NORMAL.

Properties:

Name	Type	Description
BLEND_MODES	object	Properties Name Type Description NORMAL number ADD number MULTIPLY number SCREEN number OVERLAY number DARKEN number LIGHTEN number COLOR_DODGE number COLOR_BURN number HARD_LIGHT number SOFT_LIGHT number DIFFERENCE number EXCLUSION number HUE number SATURATION number COLOR number LUMINOSITY number

static,constantPIXI.DEFAULT_RENDER_OPTIONS

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

Properties:

Name	Type	Description
DEFAULT_RENDER_OPTIONS	object	Properties Name Type Default Description view HTMLCanvasElement null transparent boolean false antialias boolean false forceFXAA boolean false preserveDrawingBuffer boolean false resolution number 1 backgroundColor number 0x000000 clearBeforeRender boolean true autoResize boolean false

static,constantPIXI.DEG_TO_RAD

Properties:

Name	Type	Description
DEG_TO_RAD	Number	Constant conversion factor for converting degrees to radians

static,constantPIXI.DRAW_MODES

Various webgl draw modes. These can be used to specify which GL drawMode to use
under certain situations and renderers.

Properties:

Name	Type	Description
DRAW_MODES	object	Properties Name Type Description POINTS number LINES number LINE_LOOP number LINE_STRIP number TRIANGLES number TRIANGLE_STRIP number TRIANGLE_FAN number

staticPIXI.loader

A premade instance of the loader that can be used to loader resources.

Properties:

Type	Description
PIXI.loaders.Loader

static,constantPIXI.PI_2

Properties:

Name	Type	Description
PI_2	number	Two Pi

static,constantPIXI.RAD_TO_DEG

Properties:

Name	Type	Description
RAD_TO_DEG	number	Constant conversion factor for converting radians to degrees

static,constantPIXI.RENDERER_TYPE

Constant to identify the Renderer Type.

Properties:

Name	Type	Description
RENDERER_TYPE	object	Properties Name Type Description UNKNOWN number WEBGL number CANVAS number

static,constantPIXI.RETINA_PREFIX

The prefix that denotes a URL is for a retina asset

Properties:

Name	Type	Description
RETINA_PREFIX	string

static,constantPIXI.SCALE_MODES

The scale modes that are supported by pixi.

The DEFAULT scale mode affects the default scaling mode of future operations.
It can be re-assigned to either LINEAR or NEAREST, depending upon suitability.

Properties:

Name	Type	Description
SCALE_MODES	object	Properties Name Type Default Description DEFAULT number LINEAR LINEAR number Smooth scaling NEAREST number Pixelating scaling

static,constantPIXI.SHAPES

Constants that identify shapes, mainly to prevent instanceof calls.

Properties:

Name	Type	Description
SHAPES	object	Properties Name Type Default Description POLY object 0 RECT object 1 CIRC object 2 ELIP object 3 RREC object 4

static,constantPIXI.TARGET_FPMS

Target frames per millisecond.

Properties:

Name	Type	Default	Description
TARGET_FPMS	number	0.06

static,constantPIXI.VERSION

String of the current PIXI version

Properties:

Name	Type	Description
VERSION	string

Methods

staticPIXI.autoDetectRenderer(width, height, options, noWebGL){WebGLRenderer|CanvasRenderer}

core/index.js, line 82

This helper function will automatically detect which renderer you should be using.
WebGL is the preferred renderer as it is a lot faster. If webGL is not supported by
the browser then this function will return a canvas renderer

Name	Type	Default	Description
width	number	800	the width of the renderers view
height	number	600	the height of the renderers view
options	object		optional The optional renderer parameters Name Type Default Description view HTMLCanvasElement optional the canvas to use as a view, optional transparent boolean false optional If the render view is transparent, default false antialias boolean false optional sets antialias (only applicable in chrome at the moment) preserveDrawingBuffer boolean false optional enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context resolution number 1 optional the resolution of the renderer, retina would be 2
noWebGL	boolean	false	optional prevents selection of WebGL renderer, even if such is present

Returns:

Type	Description
WebGLRenderer | CanvasRenderer	Returns WebGL renderer if available, otherwise CanvasRenderer