Classes
- Application
- BaseRenderTexture
- BaseTexture
- BlendModeManager
- Bounds
- Buffer
- CanvasMaskManager
- CanvasRenderer
- CanvasRenderTarget
- CanvasTinter
- Circle
- Container
- Container
- CountLimiter
- DisplayObject
- DisplayObject
- Ellipse
- Filter
- FilterManager
- Graphics
- Graphics
- GraphicsData
- GraphicsRenderer
- GroupD8
- MaskManager
- Matrix
- MeshRenderer
- ObjectRenderer
- ObservablePoint
- ParticleShader
- Point
- Polygon
- PrimitiveShader
- Quad
- Rectangle
- RenderTarget
- RenderTexture
- RoundedRectangle
- Shader
- Sprite
- Sprite
- SpriteMaskFilter
- Spritesheet
- StencilManager
- SystemRenderer
- Text
- Text
- TextStyle
- Texture
- TextureGarbageCollector
- TextureManager
- TextureMatrix
- TimeLimiter
- Transform
- TransformBase
- TransformStatic
- VideoBaseTexture
- WebGLManager
- WebGLRenderer
- WebGLState
Namespaces
- accessibility
- animate
- extract
- extras
- filters
- interaction
- loaders
- mesh
- particles
- prepare
- settings
- ticker
- utils
Members
-
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 NORMALnumber ADDnumber MULTIPLYnumber SCREENnumber OVERLAYnumber DARKENnumber LIGHTENnumber COLOR_DODGEnumber COLOR_BURNnumber HARD_LIGHTnumber SOFT_LIGHTnumber DIFFERENCEnumber EXCLUSIONnumber HUEnumber SATURATIONnumber COLORnumber LUMINOSITYnumber -
Regexp for data URI. Based on: https://github.com/ragingwind/data-uri-regex
Example
data:image/png;base64 -
Various webgl draw modes. These can be used to specify which GL drawMode to use under certain situations and renderers.
Properties:
Name Type Description POINTSnumber LINESnumber LINE_LOOPnumber LINE_STRIPnumber TRIANGLESnumber TRIANGLE_STRIPnumber TRIANGLE_FANnumber -
The gc modes that are supported by pixi.
The PIXI.settings.GC_MODE Garbage Collection mode for PixiJS textures is AUTO If set to GC_MODE, the renderer will occasionally check textures usage. If they are not used for a specified period of time they will be removed from the GPU. They will of course be uploaded again when they are required. This is a silent behind the scenes process that should ensure that the GPU does not get filled up.
Handy for mobile devices! This property only affects WebGL.
Properties:
Name Type Description AUTOnumber Garbage collection will happen periodically automatically
MANUALnumber Garbage collection will need to be called manually
-
Alias for PIXI.loaders.shared.
-
Constants that specify float precision in shaders.
Properties:
Name Type Default Description LOWstring 'lowp' MEDIUMstring 'mediump' HIGHstring 'highp' -
Constant to identify the Renderer Type.
Properties:
Name Type Description UNKNOWNnumber Unknown render type.
WEBGLnumber WebGL render type.
CANVASnumber Canvas render type.
-
The scale modes that are supported by pixi.
The PIXI.settings.SCALE_MODE 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 LINEARnumber Smooth scaling
NEARESTnumber Pixelating scaling
-
Constants that identify shapes, mainly to prevent
instanceofcalls.Properties:
Name Type Description POLYnumber Polygon
RECTnumber Rectangle
CIRCnumber Circle
ELIPnumber Ellipse
RRECnumber Rounded Rectangle
-
Regexp for SVG size.
Example
<svg width="100" height="100"></svg> -
Constants that define the type of gradient on text.
Properties:
Name Type Description LINEAR_VERTICALnumber Vertical gradient
LINEAR_HORIZONTALnumber Linear gradient
-
Constants that specify the transform type.
Properties:
Name Type Description STATICnumber DYNAMICnumber -
Represents the update priorities used by internal PIXI classes when registered with the PIXI.ticker.Ticker object. Higher priority items are updated first and lower priority items, such as render, should go later.
Properties:
Name Type Default Description INTERACTIONnumber 50 Highest priority, used for PIXI.interaction.InteractionManager
HIGHnumber 25 High priority updating, PIXI.VideoBaseTexture and PIXI.extras.AnimatedSprite
NORMALnumber 0 Default priority for ticker events, see PIXI.ticker.Ticker#add.
LOWnumber -25 Low priority used for PIXI.Application rendering.
UTILITYnumber -50 Lowest priority used for PIXI.prepare.BasePrepare utility.
-
String of the current PIXI version.
-
The wrap modes that are supported by pixi.
The PIXI.settings.WRAP_MODE wrap mode affects the default wrapping mode of future operations. It can be re-assigned to either CLAMP or REPEAT, depending upon suitability. If the texture is non power of two then clamp will be used regardless as webGL can only use REPEAT if the texture is po2.
This property only affects WebGL.
Properties:
Name Type Description CLAMPnumber The textures uvs are clamped
REPEATnumber The texture uvs tile and repeat
MIRRORED_REPEATnumber The texture uvs tile and repeat with mirroring
Methods
-
PIXI.autoDetectRenderer (options)PIXI.WebGLRenderer | PIXI.CanvasRenderer static
-
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 Description optionsobject optional The optional renderer parameters
Name Type Default Description widthnumber 800 optional the width of the renderers view
heightnumber 600 optional the height of the renderers view
viewHTMLCanvasElement optional the canvas to use as a view, optional
transparentboolean false optional If the render view is transparent, default false
antialiasboolean false optional sets antialias (only applicable in chrome at the moment)
preserveDrawingBufferboolean false optional enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context
backgroundColornumber 0x000000 optional The background color of the rendered area (shown if not transparent).
clearBeforeRenderboolean true optional This sets if the renderer will clear the canvas or not before the new render pass.
resolutionnumber 1 optional The resolution / device pixel ratio of the renderer, retina would be 2
forceCanvasboolean false optional prevents selection of WebGL renderer, even if such is present
roundPixelsboolean false optional If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
forceFXAAboolean false optional forces FXAA antialiasing to be used over native. FXAA is faster, but may not always look as great webgl only
legacyboolean false optional trueto ensure compatibility with older / less advanced devices. If you experience unexplained flickering try setting this to true. webgl onlypowerPreferencestring optional Parameter passed to webgl context, set to "high-performance" for devices with dual graphics card webgl only
Returns:
Type Description PIXI.WebGLRenderer | PIXI.CanvasRenderer Returns WebGL renderer if available, otherwise CanvasRenderer