Class WindParameter
Generic wind volume parameter.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
public abstract class WindParameter : VolumeParameter<WindParameter.WindParamaterValue>, IEquatable<VolumeParameter<WindParameter.WindParamaterValue>>Constructors
WindParameter(Single, WindParameter.WindOverrideMode, Boolean)
Wind volume parameter constructor.
Declaration
public WindParameter(float value = 0F, WindParameter.WindOverrideMode mode = WindParameter.WindOverrideMode.Global, bool overrideState = false)Parameters
| Type | Name | Description |
|---|---|---|
| Single | value | Initial value. |
| WindParameter.WindOverrideMode | mode | Initial override mode. |
| Boolean | overrideState | Initial override state. |
Methods
GetGlobalValue(HDCamera)
Returns the value stored in the volume.
Declaration
protected abstract float GetGlobalValue(HDCamera camera)Parameters
| Type | Name | Description |
|---|---|---|
| HDCamera | camera | The camera containing the volume stack to evaluate |
Returns
| Type | Description |
|---|---|
| Single | The value for this parameter. |
GetHashCode()
Returns a hash code for the current object.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | A hash code for the current object. |
Overrides
UnityEngine.Rendering.VolumeParameter<UnityEngine.Rendering.HighDefinition.WindParameter.WindParamaterValue>.GetHashCode()
GetValue(HDCamera)
Returns interpolated value from the visual environment.
Declaration
public virtual float GetValue(HDCamera camera)Parameters
| Type | Name | Description |
|---|---|---|
| HDCamera | camera | The camera containing the volume stack to evaluate |
Returns
| Type | Description |
|---|---|
| Single | The value for this parameter. |
Interp(WindParameter.WindParamaterValue, WindParameter.WindParamaterValue, Single)
Interpolates between two values.
Declaration
public override void Interp(WindParameter.WindParamaterValue from, WindParameter.WindParamaterValue to, float t)Parameters
| Type | Name | Description |
|---|---|---|
| WindParameter.WindParamaterValue | from | The start value |
| WindParameter.WindParamaterValue | to | The end value |
| Single | t | The interpolation factor in range [0,1] |
Overrides
UnityEngine.Rendering.VolumeParameter<UnityEngine.Rendering.HighDefinition.WindParameter.WindParamaterValue>.Interp(UnityEngine.Rendering.HighDefinition.WindParameter.WindParamaterValue, UnityEngine.Rendering.HighDefinition.WindParameter.WindParamaterValue, System.Single)