Similar to Pass, except used by VFX Assets.

interface PassWrapper {
    blendMode: BlendMode;
    colorMask: vec4b;
    cullMode: CullMode;
    depthTest: boolean;
    depthWrite: boolean;
    instanceCount: number;
    lineWidth: number;
    name: string;
    polygonOffset: vec2;
    samplers: SamplerWrappers;
    twoSided: boolean;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

blendMode: BlendMode

The blend mode used for rendering.

colorMask: vec4b

Controls the masking of color channels with a vec4b representing each channel with a boolean.

cullMode: CullMode

The cull mode used for rendering.

depthTest: boolean

Enables depth-sorting.

depthWrite: boolean

Enables writing pixels to the depth buffer.

instanceCount: number

Number of times the pass will be rendered. Useful with the Instance ID node in Material Editor.

lineWidth: number

Line width used for rendering.

name: string

The name of the pass wrapper.

polygonOffset: vec2

Changes the position that each polygon gets drawn.

samplers: SamplerWrappers

A proxy class that provides the access to the properties of the passes under the hood of VFX Asset. PassWrapper.samplers property which is tied to the Pass.samplers one. For example:

pass.samplers.texture_name.Fitering = FilteringMode.Nearest
twoSided: boolean

Whether the material renders on both sides of a mesh face.

Methods

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean