Class MotionBlur

A volume component that holds settings for the Motion Blur effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
VolumeComponentWithQuality
MotionBlur
Implements
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Scene)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenuForRenderPipeline("Post-processing/Motion Blur", new Type[] { typeof(HDRenderPipeline) })]
public sealed class MotionBlur : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

cameraMotionBlur

If toggled on camera rotation can be clamped differently.

Declaration
[Header("Camera Velocity")]
[Tooltip("If toggled off, the motion caused by the camera is not considered when doing motion blur.")]
public BoolParameter cameraMotionBlur
Field Value
Type Description
BoolParameter

cameraRotationVelocityClamp

Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera rotation can have. Only valid if specialCameraClampMode is set to CameraClampMode.Rotation or CameraClampMode.SeparateTranslationAndRotation.

Declaration
[Tooltip("Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera rotation can have.")]
public ClampedFloatParameter cameraRotationVelocityClamp
Field Value
Type Description
ClampedFloatParameter

cameraTranslationVelocityClamp

Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera can have. Only valid if specialCameraClampMode is set to CameraClampMode.Translation or CameraClampMode.SeparateTranslationAndRotation.

Declaration
[Tooltip("Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera can have.")]
public ClampedFloatParameter cameraTranslationVelocityClamp
Field Value
Type Description
ClampedFloatParameter

cameraVelocityClamp

Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera movement can have. Only valid if specialCameraClampMode is set to CameraClampMode.FullCameraMotionVector.

Declaration
[Tooltip("Sets the maximum length, as a fraction of the screen's full resolution, that the motion vectors resulting from Camera can have.")]
public ClampedFloatParameter cameraVelocityClamp
Field Value
Type Description
ClampedFloatParameter

depthComparisonExtent

Value used for the depth based weighting of samples. Tweak if unwanted leak of background onto foreground or viceversa is detected.

Declaration
[Tooltip("Value used for the depth based weighting of samples. Tweak if unwanted leak of background onto foreground or viceversa is detected.")]
public ClampedFloatParameter depthComparisonExtent
Field Value
Type Description
ClampedFloatParameter

intensity

Sets the intensity of the motion blur effect. Acts as a multiplier for velocities.

Declaration
[Tooltip("Sets the intensity of the motion blur effect. Acts as a multiplier for velocities.")]
public MinFloatParameter intensity
Field Value
Type Description
MinFloatParameter

maximumVelocity

Controls the maximum velocity, in pixels, that HDRP allows for all sources of motion blur except Camera rotation.

Declaration
[Tooltip("Controls the maximum velocity, in pixels, that HDRP allows for all sources of motion blur except Camera rotation.")]
public ClampedFloatParameter maximumVelocity
Field Value
Type Description
ClampedFloatParameter

minimumVelocity

Controls the minimum velocity, in pixels, that a GameObject must have to contribute to the motion blur effect.

Declaration
[Tooltip("Controls the minimum velocity, in pixels, that a GameObject must have to contribute to the motion blur effect.")]
public ClampedFloatParameter minimumVelocity
Field Value
Type Description
ClampedFloatParameter

specialCameraClampMode

Determine how the component of the motion vectors coming from the camera is clamped. It is important to remember that clamping the camera component separately, velocities relative to camera might change too (e.g. an object parented to a camera when the camera moves might not have a 0 motion vector anymore).

Declaration
[Tooltip("Determine if and how the component of the motion vectors coming from the camera is clamped in a special fashion.")]
public CameraClampModeParameter specialCameraClampMode
Field Value
Type Description
CameraClampModeParameter

Properties

sampleCount

Sets the maximum number of sample points that HDRP uses to compute motion blur.

Declaration
public int sampleCount { get; set; }
Property Value
Type Description
int

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

true if the effect should be rendered, false otherwise.

Implements