API Docs for: 2.2.1
Show:

WebGLRenderer Class

The WebGLRenderer draws the stage and all its content onto a webGL enabled canvas. This renderer should be used for browsers that support webGL. This Render works by automatically managing webGLBatchs. So no need for Sprite Batches or Sprite Clouds. Don't forget to add the view to your DOM or you will not see anything :)

Constructor

WebGLRenderer

(
  • [width=0]
  • [height=0]
  • [options]
)

Parameters:

  • [width=0] Float optional

    the width of the canvas view

  • [height=0] Float optional

    the height of the canvas view

  • [options] Object optional

    The optional renderer parameters

    • [view] HTMLCanvasElement optional

      the canvas to use as a view, optional

    • [transparent=false] Bool optional

      If the render view is transparent, default false

    • [antialias=false] Bool optional

      sets antialias (only applicable in chrome at the moment)

    • [preserveDrawingBuffer=false] Bool optional

      enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context

    • [resolution=1] Float optional

      the resolution of the renderer retina would be 2

Methods

destroy

()

Removes everything from the renderer (event listeners, spritebatch, etc...)

initContext

()

mapBlendModes

()

Maps Pixi blend modes to WebGL blend modes.

render

(
  • stage
)

Renders the stage to its webGL view

Parameters:

  • stage Stage

    the Stage element to be rendered

renderDisplayObject

(
  • displayObject
  • projection
  • buffer
)

Renders a Display Object.

Parameters:

  • displayObject DisplayObject

    The DisplayObject to render

  • projection Point

    The projection

  • buffer Array

    a standard WebGL buffer

resize

(
  • width
  • height
)

resizes the webGL view to the specified width and height

Parameters:

  • width Float

    the new width of the webGL view

  • height Float

    the new height of the webGL view

updateTexture

(
  • texture
)

Updates and Creates a WebGL texture for the renderers context.

Parameters:

  • texture Texture

    the texture to update

Properties

blendModeManager

WebGLBlendModeManager

Manages the blendModes

clearBeforeRender

Bool

This sets if the WebGLRenderer will clear the context texture or not before the new render pass. If true: If the Stage is NOT transparent, Pixi will clear to alpha (0, 0, 0, 0). If the Stage is transparent, Pixi will clear to the target Stage's background color. Disable this by setting this to false. For example: if your game has a canvas filling background image, you often don't need this set.

contextRestoredBound

Function

filterManager

WebGLFilterManager

Manages the filters

height

Float

The height of the canvas view

Default: 600

maskManager

WebGLMaskManager

Manages the masks using the stencil buffer

preserveDrawingBuffer

Bool

The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.

renderSession

Dynamic

TODO remove

resolution

Float

The resolution of the renderer

Default: 1

shaderManager

WebGLShaderManager

Deals with managing the shader programs and their attribs

spriteBatch

WebGLSpriteBatch

Manages the rendering of sprites

stencilManager

WebGLStencilManager

Manages the stencil buffer

transparent

Bool

Whether the render view is transparent

view

HTMLCanvasElement

The canvas element that everything is drawn to

width

Float

The width of the canvas view

Default: 800