Class RenderTargetPreviewPlugin<TEvent>

constructor

• new RenderTargetPreviewPlugin<TEvent>(enabled?): RenderTargetPreviewPlugin<TEvent>

• Type Parameters

  • TEvent extends string

  Parameters

  • enabled: boolean = true

  Returns RenderTargetPreviewPlugin<TEvent>

enabled

mainDiv

Optional stylesheet

targetBlocks

toJSON

Static Readonly PluginType

addTarget

• addTarget(target, name, transparent?, originalColorSpace?, visible?, material?): this

• Parameters

  • target: ValOrFunc<undefined | IRenderTarget | {
        texture?: ValOrArr<ITexture>;
    }>

    render target or a function that returns a render target

  • name: string

    name of the target

  • transparent: boolean = false

    if true, the target will be rendered with transparency

  • originalColorSpace: boolean = false

    if true, the target will be rendered in its original color space

  • visible: boolean = true

    initial visibility

  • Optional material: ShaderMaterial<Event, string> | ValOrFunc<string, [string]>

    snippet for ExtendedCopyPass or a custom ExtendedShaderMaterial or three.js ShaderMaterial. Example to read just the red channel (s)=>s + ' = vec4(' + s + '.r);'

  Returns this

dispose

• dispose(): void

• Returns void

downloadTarget

• downloadTarget(target1): this

• Parameters

  • target1: ValOrFunc<undefined | IRenderTarget | {
        texture?: ValOrArr<ITexture>;
    }>

  Returns this

onAdded

• onAdded(viewer): void

• Parameters

  • viewer: ThreeViewer

  Returns void

onRemove

• onRemove(viewer): void

• Parameters

  • viewer: ThreeViewer

  Returns void

refreshUi

• refreshUi(): void

• Returns void

removeTarget

• removeTarget(target): this

• Parameters

  • target: ValOrFunc<undefined | IRenderTarget | {
        texture?: ValOrArr<ITexture>;
    }>

  Returns this

setDirty

• setDirty(): void

• Returns void