RenderPass
Extends:
Indirect Implements:
A pass that renders a given scene into the input buffer or to screen.
This pass uses a ClearPass to clear the target buffer.
Constructor Summary
Public Constructor | ||
public |
constructor(scene: Scene, camera: Camera, overrideMaterial: Object) Constructs a new render pass. |
Member Summary
Public Members | ||
public get |
Indicates whether the target buffer should be cleared before rendering. |
|
public set |
Enables or disables auto clear. |
|
public |
|
|
public |
overrideMaterial: Material An override material. |
Method Summary
Public Methods | ||
public |
Returns the clear pass. |
|
public |
getDepthTexture(): Texture Returns the current depth texture. |
|
public |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the scene. |
|
public |
setDepthTexture(depthTexture: Texture, depthPacking: Number) Sets the depth texture. |
Inherited Summary
From class Pass | ||
public |
Indicates whether this pass should be executed. |
|
public |
The name of this pass. |
|
public |
Only relevant for subclassing. |
|
public |
Only relevant for subclassing. |
|
public |
Indicates whether this pass should render to screen. |
|
protected |
camera: Camera The camera. |
|
protected |
scene: Scene The scene to render. |
|
public |
dispose() Performs a shallow search for disposable properties and deletes them. |
|
public |
getDepthTexture(): Texture Returns the current depth texture. |
|
public |
getFullscreenMaterial(): Material Returns the current fullscreen material. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean) Performs initialization tasks. |
|
public abstract |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the effect. |
|
public |
setDepthTexture(depthTexture: Texture, depthPacking: Number) Sets the depth texture. |
|
public |
Updates this pass with the renderer's size. You may override this method in case you want to be informed about the size of the main frame buffer. The EffectComposer calls this method before this pass is initialized and every time its own size is updated. |
|
protected |
setFullscreenMaterial(material: Material) Sets the fullscreen material. |
Public Constructors
public constructor(scene: Scene, camera: Camera, overrideMaterial: Object) source
Constructs a new render pass.
Override:
Pass#constructorParams:
Name | Type | Attribute | Description |
scene | Scene | The scene to render. |
|
camera | Camera | The camera to use to render the scene. |
|
overrideMaterial | Object |
|
An override material for the scene. |
Public Members
public get clear: Boolean source
Indicates whether the target buffer should be cleared before rendering.
public needsSwap: boolean source
Only relevant for subclassing.
Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering.
Set this to false
if this pass doesn't render to the output buffer or
the screen. Otherwise, the contents of the input buffer will be lost.
Override:
Pass#needsSwapPublic Methods
public getDepthTexture(): Texture source
Returns the current depth texture.
Override:
Pass#getDepthTextureReturn:
Texture | The current depth texture, or null if there is none. |
public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source
Renders the scene.
Override:
Pass#renderParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
inputBuffer | WebGLRenderTarget | A frame buffer that contains the result of the previous pass. |
|
outputBuffer | WebGLRenderTarget | A frame buffer that serves as the output render target unless this pass renders to screen. |
|
deltaTime | Number |
|
The time between the last frame and the current one in seconds. |
stencilTest | Boolean |
|
Indicates whether a stencil mask is active. |
public setDepthTexture(depthTexture: Texture, depthPacking: Number) source
Sets the depth texture.
The provided texture will be attached to the input buffer unless this pass renders to screen.
Override:
Pass#setDepthTextureParams:
Name | Type | Attribute | Description |
depthTexture | Texture | A depth texture. |
|
depthPacking | Number |
|
The depth packing. |