Represents a render pass (sometimes called beauty pass) in context of post processing. This pass produces a render for the given scene and camera and can provide multiple outputs via MRT for further processing.
const postProcessing = new RenderPipeline( renderer );
const scenePass = pass( scene, camera );
postProcessing.outputNode = scenePass;
export {}Constructor
new PassNode(scope, scene, camera, options?)| Parameter | Type | Default Value |
|---|---|---|
| scope | "color" | "depth" | — |
| scene | Scene | — |
| camera | Camera | — |
| options? | Object | {} |
Constructs a new pass node.
| Accessor | Type | |
|---|---|---|
| get type | string | |
Properties
| Property | Type | Default Value | |
|---|---|---|---|
| scope | "color" | "depth" | — | |
| scene | Scene | — | |
| camera | Camera | — | |
| options | Object | — | |
| _pixelRatio | number | — | |
| _width | number | — | |
| _height | number | — | |
| renderTarget | RenderTarget | — | |
| overrideMaterial | any | — | |
| transparent | boolean | — | |
| opaque | boolean | — | |
| contextNode | any | — | |
| _contextNodeCache | null | Object | — | |
| _textures | { [x: string]: Texture; } | — | |
| _textureNodes | { [x: string]: TextureNode; } | — | |
| _linearDepthNodes | Object | — | |
| _viewZNodes | Object | — | |
| _previousTextures | { [x: string]: Texture; } | — | |
| _previousTextureNodes | { [x: string]: TextureNode; } | — | |
| _cameraNear | UniformNode | — | |
| _cameraFar | UniformNode | — | |
| _mrt | any | — | |
| _layers | any | — | |
| _resolutionScale | number | — | |
| _viewport | null | Vector4 | — | |
| _scissor | null | Vector4 | — | |
| isPassNode | boolean | — | |
| Method | Type | |
|---|---|---|
| setResolutionScale | (resolutionScale: number) => PassNode | |
| getResolutionScale | () => number | |
| setResolution | (resolution: number) => PassNode | |
| getResolution | () => number | |
| setLayers | (layers: Layers) => PassNode | |
| getLayers | () => any | |
| setMRT | (mrt: MRTNode) => PassNode | |
| getMRT | () => MRTNode | |
| getTexture | (name: string) => Texture | |
| getPreviousTexture | (name: string) => Texture | |
| toggleTexture | (name: string) => void | |
| getTextureNode | (name?: string) => TextureNode | |
| getPreviousTextureNode | (name?: string) => TextureNode | |
| getViewZNode | (name?: string) => Node | |
| getLinearDepthNode | (name?: string) => Node | |
| compileAsync | (renderer: Renderer) => Promise<…> | |
| setup | ({ renderer }: { renderer: any; }) => Node | TextureNode | |
| updateBefore | (frame: any) => void | |
| setSize | (width: number, height: number) => void | |
| setScissor | (x: null | number | Vector4, y: number, width: number, height: number) => void | |
| setViewport | (x: number | Vector4, y: number, width: number, height: number) => void | |
| setPixelRatio | (pixelRatio: number) => void | |
| dispose | () => void | |
Extends
TempNodeTSL function for creating a pass node.
| Parameter | Type | Default Value |
|---|---|---|
| scene | Scene | — |
| camera | Camera | — |
| options | Object | — |
Returns
PassNodeTSL function for creating a pass texture node.
| Parameter | Type | Default Value |
|---|---|---|
| pass | PassNode | — |
| texture | Texture | — |
Returns
PassTextureNodeTSL function for creating a depth pass node.
| Parameter | Type | Default Value |
|---|---|---|
| scene | Scene | — |
| camera | Camera | — |
| options | Object | — |
Returns
PassNode