Experimental: This feature is currently experimental and is subject to change in later major versions. To use this feature, enable Experimental Operators/Blocks in the Visual Effects tab of your Project's Preferences.

Exposed Property class

The ExposedProperty class is a helper class that stores a property ID based on the property's name. The value that you assign to an ExposedProperty is the string name of a Shader property. The class automatically calls the Shader.PropertyToID(string name) function with the Shader property name as the parameter and stores the integer ID the function returns. When you use this class in a Property, Event, or EventAttribute method in the component API, it implicitly uses this integer.

When you want to access a Shader property, you can either use the property's name or its ID. It is often easier to use the name of the property, however it is more efficient to use the property's integer ID. This class is useful because it combines the convenience of using the property name with the efficiency of using the property ID.

Code example

ExposedProperty m_MyProperty;
VisualEffect m_VFX;

void Start()
{
    m_VFX = GetComponent<VisualEffect>();
    m_MyProperty = "My Property"; // Assign a string.
}

void Update()
{
    vfx.SetFloat(m_MyProperty, someValue); // Uses the property ID.
}