ClearMaskPass
Extends:
Indirect Implements:
A pass that disables the stencil test.
Constructor Summary
Public Constructor | ||
public |
Constructs a new clear mask pass. |
Method Summary
Public Methods | ||
public |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Disables the global stencil test. |
Inherited Summary
From class Pass | ||
public static get |
fullscreenGeometry: BufferGeometry A shared fullscreen triangle. |
|
public get |
fullscreenMaterial: Material The fullscreen material. |
|
public set |
|
|
public set |
mainCamera: Camera Sets the main camera. |
|
public set |
mainScene: Scene Sets the main scene. |
|
public get |
Sets the render to screen flag. |
|
public set |
|
|
public |
Indicates whether this pass is enabled. |
|
public |
The name of this pass. |
|
public |
Only relevant for subclassing. |
|
public |
Only relevant for subclassing. |
|
protected |
camera: Camera The camera. |
|
protected |
renderer: WebGLRenderer this member was deprecated.
The renderer. |
|
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 this method was deprecated. Use fullscreenMaterial instead.
Returns the current fullscreen material. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks. |
|
public |
this method was deprecated. Use enabled instead.
Indicates whether this pass is enabled. |
|
public abstract |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders this pass. |
|
public |
setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy) Sets the depth texture. |
|
public |
setEnabled(value: Boolean) this method was deprecated. Use enabled instead.
Enables or disables this pass. |
|
public |
setRenderer(renderer: WebGLRenderer) this method was deprecated.
Sets the renderer |
|
public |
Sets the size. |
|
protected |
setFullscreenMaterial(value: Material) this method was deprecated. Use fullscreenMaterial instead.
Sets the fullscreen material. |
Public Constructors
Public Members
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 render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source
Disables the global stencil test.
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. |