Interface IPass<Tid>

interface IPass<Tid> {
    dirty?: ValOrFunc<boolean>;
    materialExtension?: MaterialExtension;
    onDirty?: (() => void)[];
    passId?: Tid;
    uniforms?: {
        [name: string]: IUniform;
    };
    setDirty?(): void;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

dirty? materialExtension? onDirty? passId? uniforms?

Methods

setDirty?

Properties

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

Optional passId

passId?: Tid

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

Optional uniforms

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

Type declaration

Methods

Optional 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc