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 full)

PipelinePassPlugin<ProgressiveBlendPass, "progressive", ProgressivePluginEventTypes>
- ProgressivePlugin

Implements

IShaderPropertiesUpdater

Constructors

constructor

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _pass

_pass?: ProgressiveBlendPass

`Protected` _targets

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

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

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

`Readonly` bufferType

bufferType: TextureDataType

Note - this is not used right now

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = 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:147

dirty

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

mainTexture

get mainTexture(): undefined | Texture
Returns undefined | Texture
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:59

pass

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

target

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

texture

get texture(): undefined | Texture
Returns undefined | Texture
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:42

textures

get textures(): Texture[]
Returns Texture[]
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:54

Methods

`Protected` _beforeRender

_beforeRender(_?, _1?, _2?): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
- Optional _1: ICamera<ICameraEvent, ICameraEventTypes>
- Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>
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:108

`Protected` _createTarget

_createTarget(camera?, recreate?): undefined | WebGLRenderTarget
Parameters
- Optional camera: ICamera<ICameraEvent, ICameraEventTypes>
- recreate: boolean = false
Returns undefined | WebGLRenderTarget
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:81

`Protected` _disposeTarget

_disposeTarget(camera?): void
Parameters
- Optional camera: ICamera<ICameraEvent, ICameraEventTypes>
Returns void
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:94

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

fromJSON

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

getTarget

getTarget(camera?): undefined | WebGLRenderTarget
Parameters
- Optional camera: ICamera<ICameraEvent, ICameraEventTypes>
Returns undefined | WebGLRenderTarget
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:50

importState

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

isConverged

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

isDisabled

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

onAdded

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

onRemove

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

postFrameConvergedRecordingDelta

postFrameConvergedRecordingDelta(_?): 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:140

setDirty

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

toJSON

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

updateShaderProperties

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

Class ProgressivePlugin

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

maxFrameCount: number = 32

bufferType: TextureDataType = UnsignedByteType

enabled: boolean = true

Returns ProgressivePlugin

Properties

Protected _dirty

Protected Optional _pass

Protected _targets

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Readonly bufferType

constructor

enabled

maxFrameCount

Readonly passId

Optional uiConfig

Static Readonly OldPluginType

Static Readonly PluginType

Accessors

convergedPromise

Returns Promise<void>

dirty

Returns boolean

Parameters

value: boolean

Returns void

mainTexture

Returns undefined | Texture

pass

Returns undefined | T

target

Returns undefined | WebGLRenderTarget

texture

Returns undefined | Texture

textures

Returns Texture[]

Methods

Protected _beforeRender

Parameters

Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

Optional _1: ICamera<ICameraEvent, ICameraEventTypes>

Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

Returns boolean

Protected _createPass

Returns ProgressiveBlendPass

Protected _createTarget

Parameters

Optional camera: ICamera<ICameraEvent, ICameraEventTypes>

recreate: boolean = false

Returns undefined | WebGLRenderTarget

Protected _disposeTarget

Parameters

Optional camera: ICamera<ICameraEvent, ICameraEventTypes>

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

`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

`Optional` _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

`Optional` _1: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

`Protected` _createPass

`Protected` _createTarget

`Optional` camera: ICamera<ICameraEvent, ICameraEventTypes>

`Protected` _disposeTarget

`Optional` camera: ICamera<ICameraEvent, ICameraEventTypes>

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` camera: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}

material: {
defines: Record<string, undefined | string | number>;
uniforms: {
[p: string]: IUniform;
};
}

uniforms: {
[p: string]: IUniform;
}