Interface IPass<Tid>

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

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

dirty? materialExtension? onDirty? passId? uniforms?

Methods

setDirty?

Properties

Optionaldirty

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.

OptionalmaterialExtension

materialExtension?: MaterialExtension

OptionalonDirty

onDirty?: () => void[]

OptionalpassId

passId?: Tid

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

Optionaluniforms

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

Methods

OptionalsetDirty

  • 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

On This Page

Properties
Methods