Class ScreenPass

Hierarchy

ExtendedShaderPass
- ScreenPass

Implements

IPipelinePass<"screen">

Index

Constructors

Properties

_lastReadBuffer? _needsReRender after clipBackground enabled isExtendedShaderPass material onDirty outputColorSpace overrideReadBuffer passId required uiConfig DEFAULT_TEX_ID

Accessors

Methods

beforeRender dispose onPostFrame reRender render setDirty updateShaderProperties

Constructors

constructor

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

Properties

`Private` `Optional` _lastReadBuffer

_lastReadBuffer?: WebGLRenderTarget | WebGLMultipleRenderTargets

`Private` _needsReRender

_needsReRender: boolean = false

after

after: string[] = ...

clipBackground

clipBackground: boolean = false

enabled

enabled: boolean = true

`Readonly` isExtendedShaderPass

isExtendedShaderPass: true = true

material

material: ShaderMaterial2<IMaterialEvent, IMaterialEventTypes>

onDirty

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

outputColorSpace

outputColorSpace: ColorSpace = SRGBColorSpace

overrideReadBuffer

overrideReadBuffer: null | WebGLRenderTarget = null

`Readonly` passId

passId: "screen" = 'screen'

required

required: string[] = ...

uiConfig

uiConfig: UiObjectConfig<any, string, any>

`Static` `Readonly` DEFAULT_TEX_ID

DEFAULT_TEX_ID: "tDiffuse" = 'tDiffuse'

Accessors

isShaderPass2

get isShaderPass2(): boolean
Deprecated
renamed to isExtendedShaderPass

Returns boolean
Inherited from ExtendedShaderPass.isShaderPass2
- Defined in src/postprocessing/ExtendedShaderPass.ts:59

Methods

beforeRender

beforeRender(_, _1, renderManager): void
Parameters
- _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
- _1: ICamera<ICameraEvent, ICameraEventTypes>
- renderManager: ViewerRenderManager
Returns void
Implementation of IPipelinePass.beforeRender
- Defined in src/postprocessing/ScreenPass.ts:70

dispose

dispose(): void
Returns void
Implementation of IPipelinePass.dispose

Overrides ExtendedShaderPass.dispose
- Defined in src/postprocessing/ScreenPass.ts:62

onPostFrame

onPostFrame(renderManager): void
Parameters
- renderManager: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>
Returns void
Implementation of IPipelinePass.onPostFrame
- Defined in src/postprocessing/ScreenPass.ts:56

reRender

reRender(renderer, writeBuffer?, deltaTime?, maskActive?): void
Parameters
- renderer: IWebGLRenderer<IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>>
- Optional writeBuffer: null | WebGLRenderTarget | WebGLMultipleRenderTargets
- Optional deltaTime: number
- Optional maskActive: boolean
Returns void
- Defined in src/postprocessing/ScreenPass.ts:52

render

render(renderer, writeBuffer?, readBuffer?, deltaTime?, maskActive?): void
Parameters
- renderer: IWebGLRenderer<IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>>
- Optional writeBuffer: null | WebGLRenderTarget | WebGLMultipleRenderTargets
- Optional readBuffer: WebGLRenderTarget | WebGLMultipleRenderTargets
- Optional deltaTime: number
- Optional maskActive: boolean
Returns void
Implementation of IPipelinePass.render

Overrides ExtendedShaderPass.render
- Defined in src/postprocessing/ScreenPass.ts:43

setDirty

setDirty(): void
Returns void
Implementation of IPipelinePass.setDirty

Overrides ExtendedShaderPass.setDirty
- Defined in src/postprocessing/ScreenPass.ts:76

updateShaderProperties

updateShaderProperties(updater?): void
Parameters
- Optional updater: IShaderPropertiesUpdater | (undefined | IShaderPropertiesUpdater)[]
Returns void
Implementation of IPipelinePass.updateShaderProperties

Inherited from ExtendedShaderPass.updateShaderProperties
- Defined in src/postprocessing/ExtendedShaderPass.ts:36

Generated using TypeDoc