Version: 2022.3
LanguageEnglish
  • C#

VisualEffectAsset

class in UnityEngine.VFX

/

Inherits from:VFX.VisualEffectObject

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

This class contains a graph of the elements needed to describe a visual effect. These include: the visual effects system, generated shaders, and compiled data.

Additional resources: VisualEffect.

Static Properties

PlayEventIDThe default name ID of the play event.
PlayEventNameThe default name of the play event.
StopEventIDThe default name ID of the stop event.
StopEventNameThe default name of the stop event.

Constructors

VisualEffectAssetThe visual effect Asset constructor.

Public Methods

GetEventsGets the name of every Event connected to a system.
GetExposedPropertiesGets the name and type of every exposed property.
GetTextureDimensionGets the TextureDimension of a named exposed Texture.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.