This page contains information on using a Tags
block in your ShaderLabUnity’s language for defining the structure of Shader objects. More info
See in Glossary code to assign tags to a Pass. It also contains information on using the LightMode
tag.
For information on how a ShaderA program that runs on the GPU. More info
See in Glossary object works, and the relationship between Shader objectsAn instance of the Shader class, a Shader object is container for shader programs and GPU instructions, and information that tells Unity how to use them. Use them with materials to determine the appearance of your scene. More info
See in Glossary, SubShaders and Passes, see Shader object fundamentals.
Feature name | Universal 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 (URP) |
High Definition Render Pipeline (HDRP) | Custom SRP | Built-in Render Pipeline |
---|---|---|---|---|
ShaderLab: Pass Tags block | Yes | Yes | Yes | Yes |
ShaderLab: LightMode Pass tag | Yes | Yes | Yes | Yes |
Signature | Function |
---|---|
Tags {"<name1>" = "<value1>" "<name2>" = "<value2>"} |
Applies the given tags to the Pass. You can define as many tags as you like. |
Signature | Function |
---|---|
“LightMode” = “[value]” | Sets the LightMode value for this Pass. |
Valid values for this tag depend on the render pipeline.
These are the valid values for the LightMode
Pass tag in the Built-in Render Pipeline. For more information on the LightMode tag, see ShaderLab: using Pass tags.
Value | Function |
---|---|
Always |
Always rendered; does not apply any lighting. This is the default value. |
ForwardBase |
Used in 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; applies ambient, main directional light, vertex/SH lights and lightmapsA pre-rendered texture that contains the effects of light sources on static objects in the scene. Lightmaps are overlaid on top of scene geometry to create the effect of lighting. More info See in Glossary. |
ForwardAdd |
Used in Forward rendering; applies additive per-pixel lights, one Pass per light. |
Deferred |
Used in Deferred ShadingA rendering path in the Built-in Render Pipeline that places no limit on the number of Lights that can affect a GameObject. All Lights are evaluated per-pixel, which means that they all interact correctly with normal maps and so on. Additionally, all Lights can have cookies and shadows. More info See in Glossary; renders G-buffer. |
ShadowCaster |
Renders object depth into the shadowmap or a depth texture. |
MotionVectors |
Used to calculate per-object motion vectors. |
Vertex |
Used in legacy Vertex Lit rendering when the object is not lightmapped; applies all vertex lights. |
VertexLMRGBM |
Used in legacy Vertex Lit rendering when the object is lightmapped, and on platforms where the lightmap is RGBM encoded (PC & console). |
VertexLM |
Used in legacy Vertex Lit rendering when the object is lightmapped, and on platforms where lightmap is double-LDR encoded (mobile platforms). |
Meta |
This Pass is not used during regular rendering, only for lightmap baking or EnlightenA lighting system by Geomerics used in Unity for Enlighten Realtime Global Illumination. More info See in Glossary Realtime Global IlluminationA group of techniques that model both direct and indirect lighting to provide realistic lighting results. See in Glossary. For more information, see Lightmapping and shaders. |
In the Built-in Render Pipeline, use the PassFlags
Pass tag to specify what data Unity provides to the Pass.
Value | Function |
---|---|
OnlyDirectional | Valid only in the Built-in Render Pipeline, when the rendering path is set to Forward, in a Pass with a LightMode tag value of ForwardBase .Unity provides only the main directional light and ambient/light probe data to this Pass. This means that data of non-important lights is not passed into vertex-light or spherical harmonics shader variables. See Forward rendering path for details. |
Shader "Examples/ExamplePassFlag" { SubShader { Pass { Tags { "LightMode" = "ForwardBase" "PassFlags" = "OnlyDirectional" } // The rest of the code that defines the Pass goes here. } } }
In the Built-in Render Pipeline, the RequireOptions
Pass tag enables or disables a Pass based on project settingsA broad collection of settings which allow you to configure how Physics, Audio, Networking, Graphics, Input and many other areas of your project behave. More info
See in Glossary.
Value | Function |
---|---|
SoftVegetation |
Render this Pass only if QualitySettings-softVegetation is enabled. |
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.