docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Lens Distortion

    The Lens Distortion effect distorts the final rendered picture to simulate the shape of a real-world camera lens.

    Using Lens Distortion

    Lens Distortion uses the Volume framework, so to enable and modify Lens Distortion properties, you must add a Lens Distortion override to a Volume in your Scene. To add Lens Distortion to a Volume:

    1. In the Scene or Hierarchy view, select a GameObject that contains a Volume component to view it in the Inspector.
    2. In the Inspector, go to Add Override > Post-processing and select Lens Distortion. HDRP now applies Lens Distortion to any Camera this Volume affects.

    API

    To access and control this override at runtime, use the Volume scripting API. Because of how the Volume system works, you edit properties in a different way to standard Unity components. There are also other nuances to be aware of too, such as each property has an overrideState. This indicates to the Volume system whether to use the property value you set, or use the default value stored in the Volume Profile. For information on how to use the API correctly, see Volume scripting API.

    Properties

    Property Description
    Intensity Use the slider to set the overall strength of the distortion effect.
    X Multiplier Use the slider to set the distortion intensity on the x-axis. This value acts as a multiplier so you can set this value to 0 to disable distortion on this axis,
    Y Multiplier Use the slider to set the distortion intensity on the y-axis. This value acts as a multiplier so you can set this value to 0 to disable distortion on this axis,
    Center Set the center point of the distortion effect on the screen.
    Scale Use the slider to set the value for global screen scaling. This zooms the render to hide the borders of the screen. When you use a high distortion, pixels on the borders of the screen can break because they rely on information from pixels outside the screen boundaries that don't exist. This property is useful for hiding these broken pixels around the screen border.
    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)