docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Add a settings group

    To add a custom graphics settings group to a Scriptable Render Pipeline, implement the IRenderPipelineGraphicsSettings interface.

    Follow these steps:

    1. Create a class that implements the IRenderPipelineGraphicsSettings interface, then add a [Serializable] attribute.

    2. To set which render pipeline the setting applies to, add a [SupportedOnRenderPipeline] attribute and pass in a RenderPipelineAsset type.

      Note: If you don't add a [SupportedOnRenderPipeline] attribute, the setting applies to any Scriptable Render Pipeline. However each Scriptable Render Pipeline stores its own value for the setting.

    3. Implement the version property. Unity doesn't currently use the version property, but you must implement it.

    Unity adds the new settings group to the Edit > Project Settings > Graphics window.

    For example, the following script adds a settings group called My Settings in the Graphics settings window of the Universal Render Pipeline (URP).

    using System;
    using UnityEngine;
    using UnityEngine.Rendering;
    using UnityEngine.Rendering.Universal;
    
    [Serializable]
    [SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))] 
    
    // Create a new settings group by implementing the IRenderPipelineGraphicsSettings interface
    public class MySettings : IRenderPipelineGraphicsSettings
    {
      // Add a private field for the version property
      int internalVersion = 1;
    
      // Implement the public version property
      public int version => internalVersion;
    
    }
    

    Screenshot of the Project Settings window. The Graphics section contains the new custom settings group from the example script.
    The Edit > Project Settings > Graphics window with the new custom settings group from the example script.

    Change the display order of settings groups

    To change where a settings group appears, use the [UnityEngine.Categorization.CategoryInfo] attribute. For example, the following code gives the settings group the name My Settings and moves the group to the top of the graphics settings window.

    [UnityEngine.Categorization.CategoryInfo(Name = "My Settings", Order = 0)]
    public class MySettings : IRenderPipelineGraphicsSettings
    {
      ...
    }
    

    Additional resources

    • Add a setting

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Change the display order of settings groups
    • Additional resources
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)