Editor Scripting API
    Preparing search index...

    Class PassInfo

    The Editor.Assets.Pass on a Editor.Assets.Material.

    // Import built in helpers
    import * as Utils from 'LensStudio:Utils@1.0.js';

    // In the plugin create function
    const model = pluginSystem.findInterface(Editor.Model.IModel);
    const assetManager = model.project.assetManager;
    const destination = destination;

    const material = const assetManager.createNativeAsset('Material', 'Material Name', destination);

    const absGraphPath = new Editor.Path(params.graph_path);
    const pass = await Utils.findOrCreateAsync(assetManager, absGraphPath, destination);
    const passInfo = material.addPass(pass);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    blendMode colorMask cullMode defines depthFunction depthTest depthWrite frustumCulling id instanceCount meta polygonOffset twoSided type uiData

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getPropertyNames getTypeName getTypeName isOfType isSame setPassConfiguration

    Constructors

    Properties

    blendMode: BlendMode

    Blending mode for color output.

    colorMask: vec4b

    RGBA channel mask for color writes.

    cullMode: CullMode

    Face culling mode.

    defines: string[]

    Preprocessor defines applied to shaders.

    depthFunction: DepthFunction

    Depth comparison function.

    depthTest: boolean

    Whether depth testing is enabled.

    depthWrite: boolean

    Whether depth buffer writes are enabled.

    frustumCulling: FrustumCullMode

    Frustum culling mode.

    id: Uuid

    The unique id of the entity.

    instanceCount: number

    Number of instances to render.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    polygonOffset: vec2

    Whether polygon offset is enabled.

    twoSided: boolean

    Whether both front and back faces are rendered.

    type: string

    The entity's type.

    uiData: PassUiData

    UI metadata for this pass.

    Methods

    • Get the list of property names for this pass.

      Returns string[]

    • Returns the type name of this class.

      Returns string

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object refers to the same instance as the given object.

      Parameters

      Returns boolean

    • Applies the given PassConfiguration to this pass, updating its Pass asset, blend mode, and shader defines in a single call.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods