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 publicconstructor(scene: Scene, camera: Camera, overrideMaterial: Material)
Constructs a new render pass.
Method Summary Public Methods publicthis method was deprecated. Use clearPass.enabled instead.
Returns the clear pass.
publicgetOverrideMaterial(): Material
this method was deprecated. Use overrideMaterial instead.
Returns the current override material.
publicthis method was deprecated. Use selection instead.
Returns the selection.
publicisBackgroundDisabled(): Boolean
this method was deprecated. Use ignoreBackground instead.
Indicates whether the scene background is disabled.
publicisShadowMapDisabled(): Boolean
this method was deprecated. Use skipShadowMapUpdate instead.
Indicates whether the shadow map auto update is disabled.
publicrender(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean)
Renders the scene.
publicsetBackgroundDisabled(value: Boolean)
this method was deprecated. Use ignoreBackground instead.
Enables or disables the scene background.
publicsetOverrideMaterial(value: *): Material
this method was deprecated. Use overrideMaterial instead.
Sets the override material.
publicsetSelection(value: Selection)
this method was deprecated. Use selection instead.
Sets the selection.
publicsetShadowMapDisabled(value: Boolean)
this method was deprecated. Use skipShadowMapUpdate instead.
Enables or disables the shadow map auto update.
Inherited Summary From class Pass public static getfullscreenGeometry: BufferGeometry
A shared fullscreen triangle.
public getfullscreenMaterial: Material
The fullscreen material.
public set public setmainCamera: Camera
Sets the main camera.
public setmainScene: Scene
Sets the main scene.
public getSets the render to screen flag.
public set publicIndicates whether this pass is enabled.
publicThe name of this pass.
publicOnly relevant for subclassing.
publicOnly relevant for subclassing.
protectedcamera: Camera
The camera.
protectedrenderer: WebGLRenderer
this member was deprecated.
The renderer.
protectedscene: Scene
The scene to render.
publicdispose()
Performs a shallow search for disposable properties and deletes them.
publicgetDepthTexture(): Texture
Returns the current depth texture.
publicgetFullscreenMaterial(): Material
this method was deprecated. Use fullscreenMaterial instead.
Returns the current fullscreen material.
publicinitialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)
Performs initialization tasks.
publicthis method was deprecated. Use enabled instead.
Indicates whether this pass is enabled.
public abstractrender(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean)
Renders this pass.
publicsetDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy)
Sets the depth texture.
publicsetEnabled(value: Boolean)
this method was deprecated. Use enabled instead.
Enables or disables this pass.
publicsetRenderer(renderer: WebGLRenderer)
this method was deprecated.
Sets the renderer
publicsetSize(width: Number, height: Number)
Sets the size.
protectedsetFullscreenMaterial(value: Material)
this method was deprecated. Use fullscreenMaterial instead.
Sets the fullscreen material.
Public Constructors public constructor(scene: Scene, camera: Camera, overrideMaterial: Material) sourceConstructs a new render pass.
Params: Name Type Attribute Description scene SceneThe scene to render.
camera CameraThe camera to use to render the scene.
overrideMaterial MaterialAn override material.
Public Members public camera: * sourceThe camera.
public get clear: Boolean sourcethis get was deprecated. Use clearPass.enabled instead.
Indicates whether the target buffer should be cleared before rendering.
public ignoreBackground: Boolean sourceIndicates whether the scene background should be ignored.
public set mainCamera sourceSets the main camera.
public set mainScene sourceSets the main scene.
public needsSwap: boolean sourceOnly 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.
The current override material.
public set overrideMaterial source public get renderToScreen: * sourceSets the render to screen flag.
If this flag is changed, the fullscreen material will be updated as well.
public set renderToScreen sourceSets the render to screen flag.
If this flag is changed, the fullscreen material will be updated as well.
public scene: * sourceThe scene to render.
public skipShadowMapUpdate: Boolean sourceIndicates whether the shadow map auto update should be skipped.
Public Methods public getClearPass(): ClearPass sourcethis method was deprecated. Use clearPass.enabled instead.
Returns the clear pass.
public getOverrideMaterial(): Material sourcethis method was deprecated. Use overrideMaterial instead.
Returns the current override material.
public getSelection(): Selection sourcethis method was deprecated. Use selection instead.
Returns the selection. Default is null
(no restriction).
this method was deprecated. Use ignoreBackground instead.
Indicates whether the scene background is disabled.
Return: BooleanWhether the scene background is disabled.
public isShadowMapDisabled(): Boolean sourcethis method was deprecated. Use skipShadowMapUpdate instead.
Indicates whether the shadow map auto update is disabled.
Return: BooleanWhether the shadow map update is disabled.
public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) sourceRenders the scene.
Params: Name Type Attribute Description renderer WebGLRendererThe renderer.
inputBuffer WebGLRenderTargetA frame buffer that contains the result of the previous pass.
outputBuffer WebGLRenderTargetA frame buffer that serves as the output render target unless this pass renders to screen.
deltaTime NumberThe time between the last frame and the current one in seconds.
stencilTest BooleanIndicates whether a stencil mask is active.
public setBackgroundDisabled(value: Boolean) sourcethis method was deprecated. Use ignoreBackground instead.
Enables or disables the scene background.
Params: Name Type Attribute Description value BooleanWhether the scene background should be disabled.
public setOverrideMaterial(value: *): Material sourcethis method was deprecated. Use overrideMaterial instead.
Sets the override material.
Params: Name Type Attribute Description value * Return: Materialvalue - The material.
public setSelection(value: Selection) sourcethis method was deprecated. Use selection instead.
Sets the selection. Set to null
to disable.
The selection.
public setShadowMapDisabled(value: Boolean) sourcethis method was deprecated. Use skipShadowMapUpdate instead.
Enables or disables the shadow map auto update.
Params: Name Type Attribute Description value BooleanWhether the shadow map auto update should be disabled.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4