Interface IPipelinePass<Tid>

interface IPipelinePass<Tid> {
    after?: string[];
    before?: string[];
    dirty?: ValOrFunc<boolean>;
    materialExtension?: MaterialExtension;
    onDirty?: (() => void)[];
    passId: Tid;
    required?: string[];
    uniforms?: {
        [name: string]: IUniform;
    };
    beforeRender?(scene, camera, renderManager): void;
    onPostFrame?(renderManager): void;
    onRegister?(renderer): void;
    onUnregister?(renderer): void;
    setDirty?(): void;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

after? before? dirty? materialExtension? onDirty? passId required? uniforms?

Methods

beforeRender? onPostFrame? onRegister? onUnregister? setDirty?

Properties

Optional after

after?: string[]

Optional before

before?: string[]

Optional dirty

dirty?: ValOrFunc<boolean>

Checked by RenderManager to determine whether to render this frame. A frame is rendered if any pass is dirty. This can be set by the plugin/pass to indicate when to continue rendering. See ProgressivePlugin. This is different from setDirty which is implementation specific to the pass/plugin. It generally calls onDirty and set the viewer dirty.

Optional materialExtension

materialExtension?: MaterialExtension

Optional onDirty

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

Type declaration

    • (): void

    • Returns void

Readonly passId

passId: Tid

Unique id for the pass. Used to determine the order of passes in the pipeline.

Optional required

required?: string[]

Optional uniforms

uniforms?: {
    [name: string]: IUniform;
}

Type declaration

Methods

Optional beforeRender

Optional onPostFrame

Optional onRegister

Optional onUnregister

Optional setDirty

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc