Interface VFXAsset

Defines a VFX to use with VFX Component. For more information, see the VFX Guide.

interface VFXAsset {
    feedbacks: PassWrappers;
    mesh: RenderMesh;
    name: string;
    outputs: PassWrappers;
    properties: Properties;
    simulations: PassWrappers;
    uniqueIdentifier: string;
    clone(): VFXAsset;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

feedbacks mesh name outputs properties simulations uniqueIdentifier

Methods

clone getTypeName isOfType isSame

Properties

Readonlyfeedbacks

feedbacks: PassWrappers

Returns a PassWrapper containing all feedback passes in a VFX asset

mesh

mesh: RenderMesh

When Mesh is selected as a Geometry Type in the VFX Output Container, the system will render particles using this mesh, otherwise particles will be rendered as quads. Refer to the Custom Mesh Emitter built-in asset as a starting point when working with custom meshes.

name

name: string

The name of the Asset in Lens Studio.

Readonlyoutputs

outputs: PassWrappers

Returns a PassWrapper containing all output passes in a VFX asset

Readonlyproperties

properties: Properties

Controls properties for the VFXAsset. Any scriptable properties on a VFX Graph will automatically become properties of this Properties class. For example, if the VFX Graph defines a variable named baseColor, a script would be able to access that property as vfxAsset.properties.baseColor.

Readonlysimulations

simulations: PassWrappers

Returns a PassWrapper containing all simulation passes in a VFX asset

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

clone

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