Phaser API Documentation

bindAndDraw(source, [target], [clear], [clearAlpha], [currentShader])


Binds this pipeline and draws the source Render Target to the target Render Target.

If no target is specified, it will pop the framebuffer from the Renderers FBO stack and use that instead, which should be done when you need to draw the final results of this pipeline to the game canvas.

You can optionally set the shader to be used for the draw here, if this is a multi-shader pipeline. By default currentShader will be used. If you need to set a shader but not a target, just pass null as the target parameter.


name type arguments Default description
source Phaser.Renderer.WebGL.RenderTarget

The Render Target to draw from.

target Phaser.Renderer.WebGL.RenderTarget <optional>

The Render Target to draw to. If not set, it will pop the fbo from the stack.

clear boolean <optional> true

Clear the target before copying? Only used if target parameter is set.

clearAlpha boolean <optional> true

Clear the alpha channel when running gl.clear on the target?

currentShader Phaser.Renderer.WebGL.WebGLShader <optional>

The shader to use during the draw.