Class ProgressivePlugin

Progressive Plugin

Adds a post-render pass to blend the last frame with the current frame. This can be used to create a progressive rendering effect which is useful for progressive shadows, gi, denoising, baking, anti-aliasing, and many other effects.

Hierarchy (View Summary)

PipelinePassPlugin<ProgressiveBlendPass, "progressive">
- ProgressivePlugin

Implements

IShaderPropertiesUpdater

Constructors

constructor

new ProgressivePlugin(
    maxFrameCount?: number,
    bufferType?: TextureDataType,
    enabled?: boolean,
): ProgressivePlugin
Parameters
- maxFrameCount: number = 32
- bufferType: TextureDataType = UnsignedByteType
- enabled: boolean = true
Returns ProgressivePlugin
Overrides PipelinePassPlugin.constructor
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:69

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_pass

_pass?: ProgressiveBlendPass

`Protected`_targets

_targets: Map<string, ProgressivePluginTarget> = ...

Different targets for different render cameras. Need to save them all here since we need them in the next frame.

Note - this is not used right now

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

maxFrameCount

maxFrameCount: number

`Readonly`passId

passId: "progressive" = 'progressive'

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Readonly`OldPluginType

OldPluginType: "Progressive" = 'Progressive'

`Static` `Readonly`PluginType

PluginType: "ProgressivePlugin" = 'ProgressivePlugin'

Accessors

convergedPromise

get convergedPromise(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:146

dirty

get dirty(): boolean
Returns boolean
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

mainTexture

get mainTexture(): undefined | Texture<TextureEventMap>
Returns undefined | Texture<TextureEventMap>
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:58

pass

get pass(): undefined | T
Returns undefined | T
Inherited from PipelinePassPlugin.pass
- Defined in src/plugins/base/PipelinePassPlugin.ts:62

target

get target(): undefined | ProgressivePluginTarget
Returns undefined | ProgressivePluginTarget
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:45

texture

get texture(): undefined | Texture<TextureEventMap>
Returns undefined | Texture<TextureEventMap>
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:41

textures

get textures(): Texture<TextureEventMap>[]
Returns Texture<TextureEventMap>[]
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:53

Methods

`Protected`_beforeRender

_beforeRender(
    _?: IScene<ISceneEventMap>,
    _1?: ICamera<ICameraEventMap>,
    _2?: IRenderManager<IRenderManagerEventMap>,
): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional_: IScene<ISceneEventMap>
- Optional_1: ICamera<ICameraEventMap>
- Optional_2: IRenderManager<IRenderManagerEventMap>
Returns boolean
Inherited from PipelinePassPlugin._beforeRender
- Defined in src/plugins/base/PipelinePassPlugin.ts:34

`Protected`_createPass

_createPass(): ProgressiveBlendPass
Returns ProgressiveBlendPass
Overrides PipelinePassPlugin._createPass
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:107

`Protected`_createTarget

_createTarget(
camera?: ICamera<ICameraEventMap>,
recreate?: boolean,
): undefined | WebGLRenderTarget<Texture<TextureEventMap>>
Parameters
- Optionalcamera: ICamera<ICameraEventMap>
- recreate: boolean = false
Returns undefined | WebGLRenderTarget<Texture<TextureEventMap>>
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:80

`Protected`_disposeTarget

_disposeTarget(camera?: ICamera<ICameraEventMap>): void
Parameters
- Optionalcamera: ICamera<ICameraEventMap>
Returns void
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:93

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from PipelinePassPlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from PipelinePassPlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from PipelinePassPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from PipelinePassPlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig & { pass?: any },
meta?: SerializationMetaType,
): null | ProgressivePlugin | Promise<null | ProgressivePlugin>
Parameters
- data: ISerializedConfig & { pass?: any }
- Optionalmeta: SerializationMetaType
Returns null | ProgressivePlugin | Promise<null | ProgressivePlugin>
Overrides PipelinePassPlugin.fromJSON
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:161

getTarget

getTarget(
camera?: ICamera<ICameraEventMap>,
): undefined | ProgressivePluginTarget
Parameters
- Optionalcamera: ICamera<ICameraEventMap>
Returns undefined | ProgressivePluginTarget
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:49

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from PipelinePassPlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isConverged

isConverged(postRender?: boolean): boolean
Parameters
- postRender: boolean = false
  if called after rendering frame.
Returns boolean
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:126

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:114

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:118

postFrameConvergedRecordingDelta

postFrameConvergedRecordingDelta(_?: string): number
Get recording delta post render, For use with animations to sync with converge mode in canvas recorder. See PopmotionPlugin for usage.
Parameters
- _: string = 'CanvasRecorder'
Returns number
- delta time in milliseconds, or 0 when converging, or -1 in case of not recording in converge mode
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:139

setDirty

setDirty(): void
Returns void
Inherited from PipelinePassPlugin.setDirty
- Defined in src/plugins/base/PipelinePassPlugin.ts:74

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig & { pass?: any }
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig & { pass?: any }
Inherited from PipelinePassPlugin.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:66

updateShaderProperties

updateShaderProperties(
    material: {
        defines: Record<string, string | number | undefined>;
        uniforms: { [p: string]: IUniform<any> };
    },
): this
Parameters
- material: {
  defines: Record<string, string | number | undefined>;
  uniforms: { [p: string]: IUniform<any> };
  }
Returns this
Implementation of IShaderPropertiesUpdater.updateShaderProperties
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:130

Class ProgressivePlugin

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProgressivePlugin

Properties

Protected_dirty

Protected Optional_pass

Protected_targets

Protected Optional_viewer

Protected_viewerListeners

ReadonlybufferType

constructor

enabled

isViewerPluginSync

maxFrameCount

ReadonlypassId

OptionaluiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

convergedPromise

Returns Promise<void>

dirty

Returns boolean

Parameters

Returns void

mainTexture

Returns undefined | Texture<TextureEventMap>

pass

Returns undefined | T

target

Returns undefined | ProgressivePluginTarget

texture

Returns undefined | Texture<TextureEventMap>

textures

Returns Texture<TextureEventMap>[]

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns ProgressiveBlendPass

Protected_createTarget

Parameters

Returns undefined | WebGLRenderTarget<Texture<TextureEventMap>>

Protected_disposeTarget

Parameters

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | ProgressivePlugin | Promise<null | ProgressivePlugin>

getTarget

Parameters

Returns undefined | ProgressivePluginTarget

importState

Parameters

`Protected`_dirty

`Protected` `Optional`_pass

`Protected`_targets

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`bufferType

`Readonly`passId

`Optional`uiConfig

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected`_createPass

`Protected`_createTarget

`Protected`_disposeTarget

`Protected`_onViewerEvent

`Protected`_storeKey