new PIXI.WebGLRenderer(width, height, options)
Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
width |
number | 0 |
optional
the width of the canvas view |
||||||||||||||||||||||||||||||||||||||||
height |
number | 0 |
optional
the height of the canvas view |
||||||||||||||||||||||||||||||||||||||||
options |
object |
optional
The optional renderer parameters
|
Extends
Members
-
backgroundColor
-
Sets the background color.
Methods
-
bindRenderTarget(renderTarget){PIXI.WebGLRenderer}
-
Changes the current render target to the one given in parameter
Name Type Description renderTarget
PIXI.RenderTarget the new render target
Returns:
Type Description PIXI.WebGLRenderer Returns itself. -
bindRenderTexture(renderTexture, transform){PIXI.WebGLRenderer}
-
Binds a render texture for rendering
Name Type Description renderTexture
PIXI.RenderTexture The render texture to render
transform
PIXI.Transform The transform to be applied to the render texture
Returns:
Type Description PIXI.WebGLRenderer Returns itself. -
bindShader(shader){PIXI.WebGLRenderer}
-
Changes the current shader to the one given in parameter
Name Type Description shader
PIXI.Shader the new shader
Returns:
Type Description PIXI.WebGLRenderer Returns itself. -
bindTexture(texture, location){PIXI.WebGLRenderer}
-
Binds the texture ... @mat
Name Type Default Description texture
PIXI.Texture the new texture
location
number 0 the texture location
Returns:
Type Description PIXI.WebGLRenderer Returns itself. -
clear(clearColor)
-
Erases the active render target and fills the drawing area with a colour
Name Type Description clearColor
number optional The colour
-
createVao(){VertexArrayObject}
-
Creates a new VAO from this renderer's context and state.
Returns:
Type Description VertexArrayObject The new VAO. -
destroy(removeView)
-
Removes everything from the renderer (event listeners, spritebatch, etc...)
Name Type Default Description removeView
boolean false optional Removes the Canvas element from the DOM.
See: https://github.com/pixijs/pixi.js/issues/2233 -
This shoudl be called if you wish to do some custom rendering
It will basically render anything that may be batched up such as sprites -
inherited generateTexture(displayObject, scaleMode, resolution){PIXI.Texture}
-
Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is complicated and needs to be reused multiple times.Name Type Description displayObject
PIXI.DisplayObject The displayObject the object will be generated from
scaleMode
number Should be one of the scaleMode consts
resolution
number The resolution / device pixel ratio of the texture being generated
Returns:
Type Description PIXI.Texture a texture of the graphics object -
render(displayObject, renderTexture, clear, transform, skipUpdateTransform)
-
Renders the object to its webGL view
Name Type Description displayObject
PIXI.DisplayObject the object to be rendered
renderTexture
PIXI.RenderTexture The render texture to render to.
clear
boolean optional Should the canvas be cleared before the new render
transform
PIXI.Transform optional A transform to apply to the render texture before rendering.
skipUpdateTransform
boolean optional Should we skip the update transform pass?
-
Resets the WebGL state so you can render things however you fancy!
Returns:
Type Description PIXI.WebGLRenderer Returns itself. -
resize(width, height)
-
Resizes the webGL view to the specified width and height.
Name Type Description width
number the new width of the webGL view
height
number the new height of the webGL view
-
setBlendMode(blendMode)
-
Resizes the webGL view to the specified width and height.
Name Type Description blendMode
number the desired blend mode
-
setObjectRenderer(objectRenderer)
-
Changes the current renderer to the one given in parameter
Name Type Description objectRenderer
PIXI.ObjectRenderer The object renderer to use.
-
setTransform(matrix)
-
Sets the transform of the active render target to the given matrix
Name Type Description matrix
PIXI.Matrix The transformation matrix