API Docs for: 2.0.0
Show:

WebGLRenderer Class

Defined in: src/pixi/renderers/webgl/WebGLRenderer.js:7
Module: PIXI

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 webGLBatch's. So no need for Sprite Batch's or Sprite Cloud's Dont forget to add the view to your DOM or you will not see anything :)

Constructor

WebGLRenderer

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

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:7

Parameters:

  • [width=0] Number optional

    the width of the canvas view

  • [height=0] Number 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] Boolean optional

      If the render view is transparent, default false

    • [antialias=false] Boolean optional

      sets antialias (only applicable in chrome at the moment)

    • [preserveDrawingBuffer=false] Boolean optional

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

    • [resolution=1] Number optional

      the resolution of the renderer retina would be 2

Methods

destroy

()

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:383

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

handleContextLost

(
  • event
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:349

Handles a lost webgl context

Parameters:

handleContextRestored

(
  • event
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:362

Handles a restored webgl context

Parameters:

render

(
  • stage
)

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:184

Renders the stage to its webGL view

Parameters:

  • stage Stage

    the Stage element to be rendered

renderDIsplayObject

(
  • displayObject
  • projection
  • buffer
)

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:251

Renders a display Object

Parameters:

  • displayObject DisplayObject

    The DisplayObject to render

  • projection Point

    The projection

  • buffer Array

    a standard WebGL buffer

resize

(
  • width
  • height
)

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:285

resizes the webGL view to the specified width and height

Parameters:

  • width Number

    the new width of the webGL view

  • height Number

    the new height of the webGL view

updateTexture

(
  • texture
)

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:310

Updates and Creates a WebGL texture for the renderers context

Parameters:

  • texture Texture

    the texture to render

Properties

height

Number

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:84

The height of the canvas view

Default: 600

preserveDrawingBuffer

Boolean

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:67

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

resolution

Number

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:49

The resolution of the renderer

Default: 1

transparent

Boolean

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:59

Whether the render view is transparent

view

HTMLCanvasElement

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:93

The canvas element that everything is drawn to

width

Number

Defined in src/pixi/renderers/webgl/WebGLRenderer.js:75

The width of the canvas view

Default: 800