using System;
namespace UnityEngine.Rendering.Universal
{
/// <summary>
/// Option to control motion blur Mode.
/// </summary>
public enum MotionBlurMode
{
/// <summary>
/// Use this if you don't need object motion blur.
/// </summary>
CameraOnly,
/// <summary>
/// Use this if you need object motion blur.
/// </summary>
CameraAndObjects
}
/// <summary>
/// Options to control the quality the motion blur effect.
/// </summary>
public enum MotionBlurQuality
{
/// <summary>
/// Use this to select low motion blur quality.
/// </summary>
Low,
/// <summary>
/// Use this to select medium motion blur quality.
/// </summary>
Medium,
/// <summary>
/// Use this to select high motion blur quality.
/// </summary>
High
}
/// <summary>
/// A volume component that holds settings for the Motion Blur effect.
/// </summary>
/// <remarks>
/// You can add <see cref="VolumeComponent"/> to a <see cref="VolumeProfile"/> in the Editor to apply a Motion Blur post-processing effect.
/// </remarks>
/// <example>
/// <para>This sample code shows how settings can be retrieved and modified in runtime:</para>
/// <code>
/// using System;
/// using UnityEngine;
/// using UnityEngine.Rendering;
/// using UnityEngine.Rendering.Universal;
///
/// public class ModifyVolumeComponent : MonoBehaviour
/// {
/// [SerializeField] VolumeProfile volumeProfile;
/// [SerializeField] VolumeSettings volumeSettings;
///
/// private bool m_HasRetrievedVolumeComponent;
/// private MotionBlur m_VolumeComponent;
///
/// [Serializable]
/// private struct VolumeSettings
/// {
/// public bool active;
/// public MotionBlurModeParameter mode;
/// public MotionBlurQualityParameter quality;
/// public ClampedFloatParameter intensity;
/// public ClampedFloatParameter clamp;
///
/// public void SetVolumeComponentSettings(ref MotionBlur volumeComponent)
/// {
/// volumeComponent.active = active;
/// volumeComponent.mode = mode;
/// volumeComponent.quality = quality;
/// volumeComponent.intensity = intensity;
/// volumeComponent.clamp = clamp;
/// }
///
/// public void GetVolumeComponentSettings(ref MotionBlur volumeComponent)
/// {
/// active = volumeComponent.active;
/// mode = volumeComponent.mode;
/// quality = volumeComponent.quality;
/// intensity = volumeComponent.intensity;
/// clamp = volumeComponent.clamp;
/// }
/// }
///
/// private void Start()
/// {
/// m_HasRetrievedVolumeComponent = GetVolumeComponent(in volumeProfile, ref m_VolumeComponent);
/// if (m_HasRetrievedVolumeComponent)
/// volumeSettings.GetVolumeComponentSettings(ref m_VolumeComponent);
/// }
///
/// private void Update()
/// {
/// if (!m_HasRetrievedVolumeComponent)
/// return;
///
/// volumeSettings.SetVolumeComponentSettings(ref m_VolumeComponent);
/// }
///
/// private static bool GetVolumeComponent(in VolumeProfile volumeProfile, ref MotionBlur volumeComponent)
/// {
/// if (volumeComponent != null)
/// return true;
///
/// if (volumeProfile == null)
/// {
/// Debug.LogError("ModifyVolumeComponent.GetVolumeComponent():\nvolumeProfile has not been assigned.");
/// return false;
/// }
///
/// volumeProfile.TryGet(out MotionBlur component);
/// if (component == null)
/// {
/// Debug.LogError($"ModifyVolumeComponent.GetVolumeComponent():\nMissing component in the \"{volumeProfile.name}\" VolumeProfile ");
/// return false;
/// }
///
/// volumeComponent = component;
/// return true;
/// }
/// }
/// </code>
/// </example>
/// <seealso cref="VolumeProfile"/>
/// <seealso cref="VolumeComponent"/>
/// <seealso cref="IPostProcessComponent"/>
/// <seealso cref="VolumeParameter{T}"/>
/// <seealso cref="MotionBlurModeParameter"/>
/// <seealso cref="MotionBlurQualityParameter"/>
/// <seealso cref="ClampedFloatParameter"/>
[Serializable, VolumeComponentMenu("Post-processing/Motion Blur")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
[URPHelpURL("Post-Processing-Motion-Blur")]
public sealed class MotionBlur : VolumeComponent, IPostProcessComponent
{
/// <summary>
/// The motion blur technique to use. If you don't need object motion blur, CameraOnly will result in better performance.
/// </summary>
[Tooltip("The motion blur technique to use. If you don't need object motion blur, CameraOnly will result in better performance.")]
public MotionBlurModeParameter mode = new MotionBlurModeParameter(MotionBlurMode.CameraOnly);
/// <summary>
/// The quality of the effect. Lower presets will result in better performance at the expense of visual quality.
/// </summary>
[Tooltip("The quality of the effect. Lower presets will result in better performance at the expense of visual quality.")]
public MotionBlurQualityParameter quality = new MotionBlurQualityParameter(MotionBlurQuality.Low);
/// <summary>
/// Sets the intensity of the motion blur effect. Acts as a multiplier for velocities.
/// </summary>
[Tooltip("The strength of the motion blur filter. Acts as a multiplier for velocities.")]
public ClampedFloatParameter intensity = new ClampedFloatParameter(0f, 0f, 1f);
/// <summary>
/// Sets the maximum length, as a fraction of the screen's full resolution, that the velocity resulting from Camera rotation can have.
/// Lower values will improve performance.
/// </summary>
[Tooltip("Sets the maximum length, as a fraction of the screen's full resolution, that the velocity resulting from Camera rotation can have. Lower values will improve performance.")]
public ClampedFloatParameter clamp = new ClampedFloatParameter(0.05f, 0f, 0.2f);
/// <summary>
/// Tells if the post process needs to be rendered or not.
/// </summary>
/// <returns><c>true</c> if the effect should be rendered, <c>false</c> otherwise.</returns>
public bool IsActive() => intensity.value > 0f;
/// <summary>
/// Tells if the post process can run the effect on-tile or if it needs a full pass.
/// </summary>
/// <returns><c>true</c> if it can run on-tile, <c>false</c> otherwise.</returns>
[Obsolete("Unused. #from(2023.1)")]
public bool IsTileCompatible() => false;
}
/// <summary>
/// A <see cref="VolumeParameter"/> that holds a <see cref="MotionBlurMode"/> value.
/// </summary>
[Serializable]
public sealed class MotionBlurModeParameter : VolumeParameter<MotionBlurMode>
{
/// <summary>
/// Creates a new <see cref="MotionBlurModeParameter"/> instance.
/// </summary>
/// <param name="value">The initial value to store in the parameter.</param>
/// <param name="overrideState">The initial override state for the parameter.</param>
public MotionBlurModeParameter(MotionBlurMode value, bool overrideState = false) : base(value, overrideState) { }
}
/// <summary>
/// A <see cref="VolumeParameter"/> that holds a <see cref="MotionBlurQuality"/> value.
/// </summary>
[Serializable]
public sealed class MotionBlurQualityParameter : VolumeParameter<MotionBlurQuality>
{
/// <summary>
/// Creates a new <see cref="MotionBlurQualityParameter"/> instance.
/// </summary>
/// <param name="value">The initial value to store in the parameter.</param>
/// <param name="overrideState">The initial override state for the parameter.</param>
public MotionBlurQualityParameter(MotionBlurQuality value, bool overrideState = false) : base(value, overrideState) { }
}
}