You can change some properties of the URP Asset at runtime with C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary. This can help fine tune performance on devices with hardware that doesn’t perfectly match any of the quality levels in your project.
Note: To change a property of the URP Asset with a C# script, the property must have a
set
method. For more information on these properties, refer to Universal Render Pipeline Asset API.
The following example uses the QualityControls script and QualityController object from the Change Quality Level section, and extends the functionality to locate the active URP Asset and change some of its properties to fit the performance level of the hardware.
Open the QualityControls script.
At the top of the script add using UnityEngine.Rendering
and using UnityEngine.Rendering.Universal
.
Add a method with the name ChangeAssetProperties
and the type void
to the QualityControls
class as shown below.
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Rendering; using UnityEngine.Rendering.Universal; public class QualityController : MonoBehaviour { void Start() { // Select the appropriate Quality Level first SwitchQualityLevel(); } private void SwitchQualityLevel() { // Code from previous example } private void ChangeAssetProperties() { // New code is added to this method } }
Retrieve the active Render PipelineA series of operations that take the contents of a Scene, and displays them on a screen. Unity lets you choose from pre-built render pipelines, or write your own. More info
See in Glossary Asset with GraphicsSettings.currentRenderPipeline
as shown below.
Note: You must use the
as
keyword to cast the Render Pipeline Asset as theUniversalRenderPipelineAsset
type for the script to work correctly.
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Rendering; using UnityEngine.Rendering.Universal; public class QualityController : MonoBehaviour { void Start() { // Select the appropriate Quality Level first SwitchQualityLevel(); } private void SwitchQualityLevel() { // Code from previous example } private void ChangeAssetProperties() { // Locate the current URP Asset UniversalRenderPipelineAsset data = GraphicsSettings.currentRenderPipeline as UniversalRenderPipelineAsset; // Do nothing if Unity can't locate the URP Asset if (!data) return; } }
Add a switch
statement in the ChangeAssetProperties method to set the value of the URP Asset properties.
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Rendering; using UnityEngine.Rendering.Universal; public class QualityController : MonoBehaviour { void Start() { // Select the appropriate Quality Level first SwitchQualityLevel(); } private void SwitchQualityLevel() { // Code from previous example } private void ChangeAssetProperties() { // Locate the current URP Asset UniversalRenderPipelineAsset data = GraphicsSettings.currentRenderPipeline as UniversalRenderPipelineAsset; // Do nothing if Unity can't locate the URP Asset if (!data) return; // Change URP Asset settings based on the size of the device's graphics memory switch (SystemInfo.graphicsMemorySize) { case <= 1024: data.renderScale = 0.7f; data.shadowDistance = 50.0f; break; case <= 3072: data.renderScale = 0.9f; data.shadowDistance = 150.0f; break; default: data.renderScale = 0.7f; data.shadowDistance = 25.0f; break; } } }
Add a call to the ChangeAssetProperties
method in the Start
method. This ensures that the URP Asset only changes when the sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary first loads.
using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Rendering; using UnityEngine.Rendering.Universal; public class QualityController : MonoBehaviour { void Start() { // Select the appropriate Quality Level first SwitchQualityLevel(); // Fine tune performance with specific URP Asset properties ChangeAssetProperties(); } private void SwitchQualityLevel() { // Code from previous example } private void ChangeAssetProperties() { // Locate the current URP Asset UniversalRenderPipelineAsset data = GraphicsSettings.currentRenderPipeline as UniversalRenderPipelineAsset; // Do nothing if Unity can't locate the URP Asset if (!data) return; // Change URP Asset settings based on the size of the device's graphics memory switch (SystemInfo.graphicsMemorySize) { case <= 1024: data.renderScale = 0.7f; data.shadowDistance = 50.0f; break; case <= 3072: data.renderScale = 0.9f; data.shadowDistance = 150.0f; break; default: data.renderScale = 0.7f; data.shadowDistance = 25.0f; break; } } }
Now when this scene loads, Unity detects the system’s total graphics memory and sets the URP Asset properties accordingly.
You can use this method of changing particular URP Asset properties in conjunction with changing quality levels to fine tune the performance of your project for different systems without the need to create a quality level for every target hardware configuration.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.