Class MotionBlur | High Definition RP | 9.0.0-preview.71
docs.unity3d.com
    Show / Hide Table of Contents

    Class MotionBlur

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

    Inheritance
    Object
    VolumeComponent
    VolumeComponentWithQuality
    MotionBlur
    Inherited Members
    VolumeComponentWithQuality.quality
    VolumeComponentWithQuality.UsesQualitySettings()
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    public sealed class MotionBlur : VolumeComponentWithQuality, IPostProcessComponent

    Fields

    cameraMotionBlur

    If toggled off, the motion caused by the camera is not considered when doing motion blur.

    Declaration
    [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 velocity resulting from Camera rotation can have.

    Declaration
    [Tooltip("Sets the maximum length, as a fraction of the screen's full resolution, that the velocity resulting from Camera rotation can have.")]
    public ClampedFloatParameter cameraRotationVelocityClamp
    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

    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
    Int32

    Methods

    IsActive()

    Tells if the effect needs to be rendered or not.

    Declaration
    public bool IsActive()
    Returns
    Type Description
    Boolean

    true if the effect should be rendered, false otherwise.

    Implements
    IPostProcessComponent.IsActive()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023