Class RenderTargetPreviewPlugin<TEvent>

RenderTargetPreviewPlugin is a useful development and debugging plugin that renders any registered render-target to the screen in small collapsable panels.

Type Parameters

  • TEvent extends string

Hierarchy (View Summary)

Constructors

constructor

Properties

_dirty _viewer? _viewerListeners constructor enabled mainDiv stylesheet? targetBlocks toJSON uiConfig? OldPluginType? PluginType

Accessors

dirty

Methods

_onViewerEvent _storeKey addTarget disable dispose downloadTarget enable exportState fromJSON importState isDisabled onAdded onRemove refreshUi removeTarget setDirty

Constructors

constructor

Properties

Protected_dirty

_dirty: boolean = false

Protected Optional_viewer

_viewer?: ThreeViewer

Protected_viewerListeners

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

mainDiv

mainDiv: HTMLDivElement = ...

Optionalstylesheet

stylesheet?: HTMLStyleElement

targetBlocks

targetBlocks: RenderTargetBlock[] = []

toJSON

toJSON: any = null

OptionaluiConfig

uiConfig?: UiObjectConfig = undefined

Static Optional ReadonlyOldPluginType

OldPluginType?: string

Static ReadonlyPluginType

PluginType: "RenderTargetPreviewPlugin" = 'RenderTargetPreviewPlugin'

Accessors

dirty

Methods

Protected_onViewerEvent

Protected_storeKey

addTarget

  • addTarget(
        target: ValOrFunc<
            undefined
            | null
            | IRenderTarget
            | { texture?: ValOrArr<ITexture> },
        >,
        name: string,
        transparent?: boolean,
        originalColorSpace?: boolean,
        visible?: boolean,
        material?: ShaderMaterial | ValOrFunc<string, [string]>,
    ): this

  • Parameters

    • target: ValOrFunc<undefined | null | 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

    • Optionalmaterial: ShaderMaterial | 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

disable

dispose

downloadTarget

enable

exportState

fromJSON

importState

isDisabled

onAdded

onRemove

refreshUi

removeTarget

setDirty

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods