Class ScreenPass

Hierarchy (View Summary)

ExtendedShaderPass
- ScreenPass

Implements

IPipelinePass<"screen">

Index

Constructors

Constructors

constructor

new ScreenPass(shader?: TViewerScreenShader, ...textureID: string[]): ScreenPass
Parameters
- shader: TViewerScreenShader = ''
- ...textureID: string[]
Returns ScreenPass
Overrides ExtendedShaderPass.constructor
- Defined in src/postprocessing/ScreenPass.ts:30

Properties

after

after: string[] = ...

Passes that should run before this pass

clipBackground

clipBackground: boolean = false

clipBackgroundForce

clipBackgroundForce: boolean = false

Force clip background. If this is true clipBackground is overridden. This happens when scene.background and scene.backgroundColor are both null. This is set in ViewerRenderManager.render.

enabled

enabled: boolean = true

`Readonly`isExtendedShaderPass

isExtendedShaderPass: true

material

material: ShaderMaterial2

onDirty

onDirty: (() => void)[] = []

outputColorSpace

outputColorSpace: ColorSpace = SRGBColorSpace

Output Color Space Note: this is ignored when renderToScreen is false (it will take the color space of the render target)

overrideReadBuffer

overrideReadBuffer: null | { texture?: Texture<TextureEventMap> } = null

`Readonly`passId

passId: "screen" = 'screen'

Unique id for the pass. Used to determine the order of passes in the pipeline.

required

required: string[] = ...

Passes that are required to be present in the pipeline to run this pass.

uiConfig

uiConfig: UiObjectConfig

`Static` `Readonly`DEFAULT_TEX_ID

DEFAULT_TEX_ID: "tDiffuse" = 'tDiffuse'

Accessors

isShaderPass2

get isShaderPass2(): boolean
Returns boolean
Deprecated
renamed to isExtendedShaderPass
Inherited from ExtendedShaderPass.isShaderPass2
- Defined in src/postprocessing/ExtendedShaderPass.ts:68

Methods

beforeRender

beforeRender(_: IScene, _1: ICamera, renderManager: ViewerRenderManager): void
This function gets called at the beginning of every frame where this pass would be enabled.
Parameters
- _: IScene
- _1: ICamera
- renderManager: ViewerRenderManager
Returns void
Implementation of IPipelinePass.beforeRender
- Defined in src/postprocessing/ScreenPass.ts:88

dispose

dispose(): void
Returns void
Implementation of IPipelinePass.dispose
Overrides ExtendedShaderPass.dispose
- Defined in src/postprocessing/ScreenPass.ts:71

onPostFrame

onPostFrame(renderManager: IRenderManager): void
This function gets called at the end of every frame where this pass would be enabled.
Parameters
- renderManager: IRenderManager
Returns void
Implementation of IPipelinePass.onPostFrame
- Defined in src/postprocessing/ScreenPass.ts:61

render

render(
    renderer: IWebGLRenderer,
    writeBuffer?:
        | null
        | WebGLMultipleRenderTargets
        | WebGLRenderTarget<Texture<TextureEventMap>>,
    readBuffer?:
        | WebGLMultipleRenderTargets
        | WebGLRenderTarget<Texture<TextureEventMap>>,
    deltaTime?: number,
    maskActive?: boolean,
): void
Parameters
- renderer: IWebGLRenderer
- OptionalwriteBuffer: null | WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>
- OptionalreadBuffer: WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>
- OptionaldeltaTime: number
- OptionalmaskActive: boolean
Returns void
Implementation of IPipelinePass.render
Overrides ExtendedShaderPass.render
- Defined in src/postprocessing/ScreenPass.ts:47

reRender

reRender(
    renderer: IWebGLRenderer,
    writeBuffer?:
        | null
        | WebGLMultipleRenderTargets
        | WebGLRenderTarget<Texture<TextureEventMap>>,
    deltaTime?: number,
    maskActive?: boolean,
): void
Parameters
- renderer: IWebGLRenderer
- OptionalwriteBuffer: null | WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>
- OptionaldeltaTime: number
- OptionalmaskActive: boolean
Returns void
- Defined in src/postprocessing/ScreenPass.ts:57

setDirty

setDirty(): void
Set the pass as dirty. This is implementation specific to the pass/plugin. It generally calls all onDirty and set the viewer dirty.

Returns void
Implementation of IPipelinePass.setDirty
Overrides ExtendedShaderPass.setDirty
- Defined in src/postprocessing/ScreenPass.ts:94

updateShaderProperties

updateShaderProperties(
    updater?:
        | IShaderPropertiesUpdater
        | (undefined | IShaderPropertiesUpdater)[],
): void
to be called from beforeRender or onObjectRender or similar.
Parameters
- Optionalupdater: IShaderPropertiesUpdater | (undefined | IShaderPropertiesUpdater)[]
Returns void
Inherited from ExtendedShaderPass.updateShaderProperties
- Defined in src/postprocessing/ExtendedShaderPass.ts:44

Class ScreenPass

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScreenPass

Properties

after

clipBackground

clipBackgroundForce

enabled

ReadonlyisExtendedShaderPass

material

onDirty

outputColorSpace

overrideReadBuffer

ReadonlypassId

required

uiConfig

Static ReadonlyDEFAULT_TEX_ID

Accessors

isShaderPass2

Returns boolean

Deprecated

Methods

beforeRender

Parameters

Returns void

dispose

Returns void

onPostFrame

Parameters

Returns void

render

Parameters

Returns void

reRender

Parameters

Returns void

setDirty

Returns void

updateShaderProperties

Parameters

Returns void

Settings

On This Page

`Readonly`isExtendedShaderPass

`Readonly`passId

`Static` `Readonly`DEFAULT_TEX_ID