Interface Material

An asset that describes how visual objects should appear. Each Material is a collection of Passes which define the actual rendering passes. Materials are used by MeshVisuals for drawing meshes in the scene.

Example

// Gets the first pass of a material on a sprite and plays the animation from its texture
var sprite = script.getSceneObject().getFirstComponent("Component.SpriteVisual");
var material = sprite.getMaterial(0);
material.getPass(0).baseTex.control.play(-1,0.0);

// Print number of passes
print("Pass count = " + material.getPassCount().toString());
interface Material {
    mainPass: Pass;
    name: string;
    uniqueIdentifier: string;
    clone(): Material;
    getPass(index: number): Pass;
    getPassCount(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

mainPass name uniqueIdentifier

Methods

clone getPass getPassCount getTypeName isOfType isSame

Properties

mainPass

mainPass: Pass

The first Pass of the Material.

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

clone

getPass

  • getPass(index): Pass

  • Returns the Pass of the Material at index index.

    Parameters

    • index: number

    Returns Pass

getPassCount

  • getPassCount(): number

  • Returns the number of Passes for the Material.

    Returns number

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

Settings

Member Visibility

On This Page

Properties
Methods