Class OutlineRenderPass<TP, T>

Type Parameters

TP extends IPassID = IPassID
T extends WebGLRenderTarget | undefined = WebGLRenderTarget | undefined

Hierarchy

RenderPass
- OutlineRenderPass

Implements

IPipelinePass<TP>

Index

Constructors

Properties

after before enabled isOutlineRenderPass onDirty overrideMaterial passId required scene? target uiConfig

Methods

beforeRender dispose render setDirty

Constructors

constructor

new OutlineRenderPass<
    TP extends string = string,
    T extends
        undefined | WebGLRenderTarget<Texture<TextureEventMap>> =
        | undefined
        | WebGLRenderTarget<Texture<TextureEventMap>>,
>(
    passId: TP,
    _getSelectedObjectOrMaterial: () => SelectionObject | SelectionObjectArr,
    target: ValOrFunc<T>,
    overrideMaterial: ShaderMaterial,
): OutlineRenderPass<TP, T>
Type Parameters
- TP extends string = string
- T extends undefined | WebGLRenderTarget<Texture<TextureEventMap>> = undefined | WebGLRenderTarget<Texture<TextureEventMap>>
Parameters
- passId: TP
- _getSelectedObjectOrMaterial: () => SelectionObject | SelectionObjectArr
- target: ValOrFunc<T>
- overrideMaterial: ShaderMaterial
Returns OutlineRenderPass<TP, T>
Overrides RenderPass.constructor

Properties

after

after: string[] = ...

Passes that should run before this pass

before

before: string[] = ...

Passes that should run after this pass

enabled

enabled: boolean = true

`Readonly`isOutlineRenderPass

isOutlineRenderPass: true

onDirty

onDirty: () => void[] = []

overrideMaterial

overrideMaterial: ShaderMaterial

`Readonly`passId

passId: TP

required

required: string[] = ...

Passes that are required to be present in the pipeline to run this pass.

`Optional`scene

scene?: IScene<ISceneEventMap>

target

target: ValOrFunc<T>

uiConfig

uiConfig: UiObjectConfig

Methods

beforeRender

beforeRender(scene: IScene, camera: ICamera, _: IRenderManager): void
This function gets called at the beginning of every frame where this pass would be enabled.
Parameters
- scene: IScene
- camera: ICamera
- _: IRenderManager
Returns void
Implementation of IPipelinePass.beforeRender

dispose

dispose(): void
Returns void
Implementation of IPipelinePass.dispose
Overrides RenderPass.dispose

render

render(
    renderer: IWebGLRenderer,
    writeBuffer?: null | WebGLRenderTarget<Texture<TextureEventMap>>,
    _1?: WebGLRenderTarget<Texture<TextureEventMap>>,
    deltaTime?: number,
    maskActive?: boolean,
): void
Renders to target
Parameters
- renderer: IWebGLRenderer
- OptionalwriteBuffer: null | WebGLRenderTarget<Texture<TextureEventMap>>
  this is ignored? or used as transmissionRenderTarget?
- Optional_1: WebGLRenderTarget<Texture<TextureEventMap>>
  this is ignored
- OptionaldeltaTime: number
- OptionalmaskActive: boolean
Returns void
Implementation of IPipelinePass.render
Overrides RenderPass.render

setDirty

setDirty(): void
Set the pass as dirty. This is implementation specific to the pass/plugin. It generally calls all onDirty and set the viewer dirty.

Returns void
Implementation of IPipelinePass.setDirty