Write a rendering loop that iterates over additional lights in the Forward+ and Forward rendering pathsThe technique that a render pipeline uses to render graphics. Choosing a different rendering path affects how lighting and shading are calculated. Some rendering paths are more suited to different platforms and hardware than others. More info
See in Glossary in a URP shaderA program that runs on the GPU. More info
See in Glossary.
The shader example on this page is compatible with both the Forward+ and Forward renderingA rendering path that renders each object in one or more passes, depending on lights that affect the object. Lights themselves are also treated differently by Forward Rendering, depending on their settings and intensity. More info
See in Glossary paths. Unity handles additional lights and non-main directional lights differently in the Forward+ and Forward rendering paths. The Forward+ rendering path does not have a limit of the real-time lights per object, and the GetAdditionalLightsCount
shader method always returns 0 in Forward+. For a comparison of rendering paths, refer to Choose a rendering path in URP.
Add the following include directives in the HLSLPROGRAM
block in the shader file:
#include "Packages/com.unity.render-pipelines.universal/ShaderLibrary/Core.hlsl" #include "Packages/com.unity.render-pipelines.core/ShaderLibrary/CommonMaterial.hlsl" #include "Packages/com.unity.render-pipelines.universal/ShaderLibrary/RealtimeLights.hlsl"
In a shader pass, add the following multi_compile
directive to make the shader compatible with the Forward+ rendering path:
#pragma multi_compile _ _FORWARD_PLUS
In the Forward+ rendering path, the LIGHT_LOOP_BEGIN
macro requires the InputData
struct. Declare the struct in the fragment shader.
InputData inputData = (InputData)0; inputData.positionWS = input.positionWS; inputData.normalWS = input.normalWS; inputData.viewDirectionWS = GetWorldSpaceNormalizeViewDir(input.positionWS); inputData.normalizedScreenSpaceUV = GetNormalizedScreenSpaceUV(input.positionCS);
Use the UNITY_LOOP
macro to implement the additional light loop including directional lights in the Forward+ rendering path:
#if USE_FORWARD_PLUS UNITY_LOOP for (uint lightIndex = 0; lightIndex < min(URP_FP_DIRECTIONAL_LIGHTS_COUNT, MAX_VISIBLE_LIGHTS); lightIndex++) { Light additionalLight = GetAdditionalLight(lightIndex, inputData.positionWS, half4(1,1,1,1)); lighting += MyLightingFunction(inputData.normalWS, additionalLight); } #endif
Use the LIGHT_LOOP_BEGIN
macro to iterate over lights:
// Additional light loop. The GetAdditionalLightsCount method always returns 0 in Forward+. uint pixelLightCount = GetAdditionalLightsCount(); LIGHT_LOOP_BEGIN(pixelLightCount) Light additionalLight = GetAdditionalLight(lightIndex, inputData.positionWS, half4(1,1,1,1)); lighting += MyLightingFunction(inputData.normalWS, additionalLight); LIGHT_LOOP_END
The following URP shader iterates over the additional lights, including non-main directional lights, and uses them in a custom lighting function.
The shader is compatible with both the Forward+ and Forward rendering paths.
Shader "Custom/AdditionalLights" { Properties { } SubShader { Tags { "RenderType" = "Opaque" "RenderPipeline" = "UniversalPipeline" } Cull Off ZWrite On Pass { // The LightMode tag matches the ShaderPassName set in UniversalRenderPipeline.cs. // The SRPDefaultUnlit pass and passes without the LightMode tag are also rendered by URP Name "ForwardLit" Tags { "LightMode" = "UniversalForward" } HLSLPROGRAM #pragma vertex vert #pragma fragment frag // This multi_compile declaration is required for the Forward rendering path #pragma multi_compile _ _ADDITIONAL_LIGHTS // This multi_compile declaration is required for the Forward+ rendering path #pragma multi_compile _ _FORWARD_PLUS #include "Packages/com.unity.render-pipelines.universal/ShaderLibrary/Core.hlsl" #include "Packages/com.unity.render-pipelines.core/ShaderLibrary/CommonMaterial.hlsl" #include "Packages/com.unity.render-pipelines.universal/ShaderLibrary/RealtimeLights.hlsl" struct Attributes { float4 positionOS : POSITION; float3 normalOS : NORMAL; }; struct Varyings { float4 positionCS : SV_POSITION; float3 positionWS : TEXCOORD1; float3 normalWS : TEXCOORD2; }; Varyings vert(Attributes IN) { Varyings OUT; OUT.positionWS = TransformObjectToWorld(IN.positionOS.xyz); OUT.positionCS = TransformWorldToHClip(OUT.positionWS); OUT.normalWS = TransformObjectToWorldNormal(IN.normalOS); return OUT; } float3 MyLightingFunction(float3 normalWS, Light light) { float NdotL = dot(normalWS, normalize(light.direction)); NdotL = (NdotL + 1) * 0.5; return saturate(NdotL) * light.color * light.distanceAttenuation * light.shadowAttenuation; } // This function loops through the lights in the scene float3 MyLightLoop(float3 color, InputData inputData) { float3 lighting = 0; // Get the main light Light mainLight = GetMainLight(); lighting += MyLightingFunction(inputData.normalWS, mainLight); // Get additional lights #if defined(_ADDITIONAL_LIGHTS) // Additional light loop including directional lights. This block is specific to Forward+. #if USE_FORWARD_PLUS UNITY_LOOP for (uint lightIndex = 0; lightIndex < min(URP_FP_DIRECTIONAL_LIGHTS_COUNT, MAX_VISIBLE_LIGHTS); lightIndex++) { Light additionalLight = GetAdditionalLight(lightIndex, inputData.positionWS, half4(1,1,1,1)); lighting += MyLightingFunction(inputData.normalWS, additionalLight); } #endif // Additional light loop. The GetAdditionalLightsCount method always returns 0 in Forward+. uint pixelLightCount = GetAdditionalLightsCount(); LIGHT_LOOP_BEGIN(pixelLightCount) Light additionalLight = GetAdditionalLight(lightIndex, inputData.positionWS, half4(1,1,1,1)); lighting += MyLightingFunction(inputData.normalWS, additionalLight); LIGHT_LOOP_END #endif return color * lighting; } half4 frag(Varyings input) : SV_Target0 { // The Forward+ light loop (LIGHT_LOOP_BEGIN) requires the InputData struct to be in its scope. InputData inputData = (InputData)0; inputData.positionWS = input.positionWS; inputData.normalWS = input.normalWS; inputData.viewDirectionWS = GetWorldSpaceNormalizeViewDir(input.positionWS); inputData.normalizedScreenSpaceUV = GetNormalizedScreenSpaceUV(input.positionCS); float3 surfaceColor = float3(1, 1, 1); float3 lighting = MyLightLoop(surfaceColor, inputData); half4 finalColor = half4(lighting, 1); return finalColor; } ENDHLSL } } }
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.