Class: SSGIPlugin

Plugins.SSGIPlugin

Hierarchy

• MultiFilterPlugin<"", [IFilter<SSRTAOPass, "ssrtgi">]>

  ↳ SSGIPlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "SSGI"

---

dependencies

• dependencies: (typeof AssetManagerPlugin | typeof ProgressivePlugin | typeof GBufferPlugin)[]

Implementation of

IViewerPluginAsync.dependencies

---

_dirty

• Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

MultiFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

MultiFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

MultiFilterPlugin.viewer

---

passes

• get passes(): TTupleRecord<TPasses, "passId">

Returns

TTupleRecord<TPasses, "passId">

Inherited from

MultiFilterPlugin.passes

---

pipeline

• get pipeline(): string[]

Returns

string[]

Inherited from

MultiFilterPlugin.pipeline

• set pipeline(value): void

Parameters

Name	Type
value	string[]

Returns

void

Inherited from

MultiFilterPlugin.pipeline

---

rtgiTarget

• get rtgiTarget(): undefined | WebGLRenderTarget<Texture<TextureEventMap>>

Returns

undefined | WebGLRenderTarget<Texture<TextureEventMap>>

---

enabled

• get enabled(): boolean

Returns

boolean

Overrides

MultiFilterPlugin.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Overrides

MultiFilterPlugin.enabled

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

MultiFilterPlugin.onDispose

---

exportState

▸ exportState(): any

Returns

any

Inherited from

MultiFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

MultiFilterPlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

MultiFilterPlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

MultiFilterPlugin.loadState

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

MultiFilterPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | SSGIPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | SSGIPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

MultiFilterPlugin.fromJSON

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

MultiFilterPlugin.onAdded

---

createPasses

▸ createPasses(v): [IFilter<SSRTAOPass, "ssrtgi">]

Parameters

Name	Type
v	ViewerApp

Returns

[IFilter<SSRTAOPass, "ssrtgi">]

Overrides

MultiFilterPlugin.createPasses

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

MultiFilterPlugin.onRemove

---

setDirty

▸ setDirty(): void

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

MultiFilterPlugin._storeKey

Constructors

constructor

• new SSGIPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

MultiFilterPlugin.constructor