API Reference

Class List

pc.PostEffect

Base class for all post effects. Post effects take a a render target as input apply effects to it and then render the result to an output render target or the screen if no output is specified.

Summary

Properties

deviceThe graphics device of the application.
needsDepthBufferThe property that should to be set to `true` (by the custom post effect) if a depth map is necessary (default is false).
shaderThe shader definition for the fullscreen quad.
vertexBufferThe vertex buffer for the fullscreen quad.

Methods

renderRender the post effect using the specified inputTarget to the specified outputTarget.

Details

Constructor

PostEffect(graphicsDevice)

Creates new PostEffect

Parameters

graphicsDevicepc.GraphicsDeviceThe graphics device of the application

Properties

pc.GraphicsDevicedevice

The graphics device of the application. [read only]

BooleanneedsDepthBuffer

The property that should to be set to `true` (by the custom post effect) if a depth map is necessary (default is false).

pc.Shader, Nullshader

The shader definition for the fullscreen quad. Needs to be set by the custom post effect (default is null). Used when calling pc.drawFullscreenQuad.

pc.VertexBuffervertexBuffer

The vertex buffer for the fullscreen quad. Used when calling pc.drawFullscreenQuad. [read only]

Methods

render(inputTarget, outputTarget, rect)

Render the post effect using the specified inputTarget to the specified outputTarget.

Parameters

inputTargetpc.RenderTargetThe input render target
outputTargetpc.RenderTargetThe output render target. If null then this will be the screen.
rectpc.Vec4(Optional) The rect of the current camera. If not specified then it will default to [0,0,1,1]