Class WindParameter
Generic wind volume parameter.
Inherited Members
VolumeParameter<WindParameter.WindParamaterValue>.m_Value
VolumeParameter<WindParameter.WindParamaterValue>.value
VolumeParameter<WindParameter.WindParamaterValue>.Override(WindParameter.WindParamaterValue)
VolumeParameter<WindParameter.WindParamaterValue>.SetValue(VolumeParameter)
VolumeParameter<WindParameter.WindParamaterValue>.ToString()
VolumeParameter<WindParameter.WindParamaterValue>.Equals(VolumeParameter<WindParameter.WindParamaterValue>)
VolumeParameter<WindParameter.WindParamaterValue>.Clone()
VolumeParameter.k_DebuggerDisplay
VolumeParameter.m_OverrideState
VolumeParameter.overrideState
VolumeParameter.GetValue<T>()
VolumeParameter.OnEnable()
VolumeParameter.OnDisable()
VolumeParameter.Release()
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public abstract class WindParameter : VolumeParameter<WindParameter.WindParamaterValue>, ICloneable, IEquatable<VolumeParameter<WindParameter.WindParamaterValue>>Constructors
WindParameter(float, WindOverrideMode, bool)
Wind volume parameter constructor.
Declaration
public WindParameter(float value = 0, WindParameter.WindOverrideMode mode = WindOverrideMode.Global, bool overrideState = false)Parameters
| Type | Name | Description |
|---|---|---|
| float | value | Initial value. |
| WindParameter.WindOverrideMode | mode | Initial override mode. |
| bool | 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 |
|---|---|
| float | The value for this parameter. |
GetHashCode()
Returns a hash code for the current object.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int | 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 |
|---|---|
| float | The value for this parameter. |
Interp(WindParamaterValue, WindParamaterValue, float)
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 |
| float | t | The interpolation factor in range [0,1] |