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

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

Index

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:38

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _pass

_pass?: ProgressiveBlendPass

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Readonly` bufferType

bufferType: TextureDataType

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

maxFrameCount

maxFrameCount: number

`Readonly` passId

passId: "progressive" = 'progressive'

`Optional` target

target?: WebGLRenderTarget

`Optional` texture

texture?: Texture

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "ProgressivePlugin" = 'ProgressivePlugin'

Accessors

dirty

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

enabled

get enabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.enabled
- Defined in src/plugins/base/PipelinePassPlugin.ts:10
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.enabled
- Defined in src/plugins/base/PipelinePassPlugin.ts:16

pass

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

Methods

`Protected` _beforeRender

_beforeRender(): boolean
Protected
This function is called every frame before composer render, if this pass is being used in the pipeline

Returns boolean
Inherited from PipelinePassPlugin._beforeRender
- Defined in src/plugins/base/PipelinePassPlugin.ts:32

`Protected` _createPass

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

`Protected` _createTarget

_createTarget(recreate?): void
Parameters
- recreate: boolean = true
Returns void
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:49

`Protected` _disposeTarget

_disposeTarget(): void
Returns void
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:60

`Protected` _storeKey

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

dispose

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

exportState

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

fromJSON

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

importState

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

isConverged

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from PipelinePassPlugin.onAdded
- Defined in src/plugins/base/PipelinePassPlugin.ts:39

onRemove

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

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:98

setDirty

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

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:60

updateShaderProperties

updateShaderProperties(material): ProgressivePlugin
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 ProgressivePlugin
- Defined in src/plugins/pipeline/ProgressivePlugin.ts:89

Class ProgressivePlugin

Hierarchy

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 Optional _viewer

Readonly bufferType

constructor

maxFrameCount

Readonly passId

Optional target

Optional texture

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

enabled

Returns boolean

Parameters

value: boolean

Returns void

pass

Returns undefined | T

Methods

Protected _beforeRender

Returns boolean

Protected _createPass

Returns ProgressiveBlendPass

Protected _createTarget

Parameters

recreate: boolean = true

Returns void

Protected _disposeTarget

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

dispose

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig & { pass?: any; }

Optional meta: SerializationMetaType

Returns null | ProgressivePlugin | Promise<null | ProgressivePlugin>

importState

Parameters

state: any

Returns Promise<void>

isConverged

Parameters

postRender: boolean = false

Returns boolean

onAdded

Parameters

viewer: ThreeViewer

Returns void

onRemove

Parameters

viewer: ThreeViewer

Returns void

postFrameConvergedRecordingDelta

`Protected` _dirty

`Protected` `Optional` _pass

`Protected` `Optional` _viewer

`Readonly` bufferType

`Readonly` passId

`Optional` target

`Optional` texture

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _beforeRender

`Protected` _createPass

`Protected` _createTarget

`Protected` _disposeTarget

`Protected` _storeKey

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}

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

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