Version: 2019.4
Shader assets
Asynchronous shader compilation
How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

Shader compilation

Overview

Every time you build your project, the Unity Editor compiles all the shaders that your build requires: every required shaderA program that runs on the GPU. More info
See in Glossary
variant, for every required graphics API.

When you’re working in the Unity Editor, the Editor does not compile everything upfront. This is because compiling every variant for every graphics API can take a very long time.

Instead, Unity Editor does this:

  • When it imports a shader asset, it performs some minimal processing (such as Surface Shader generation).
  • When it needs to show a shader variant, it checks the Library/ShaderCache folder.
  • If it finds a previously compiled shader variant that uses identicial source code, it uses that.
  • If it does not find a match, it compiles the required shader variant and saves the result to the cache.

Shader compilation is carried out using a process called UnityShaderCompiler. Multiple UnityShaderCompiler processes can be started (generally one per CPU core in your machine), so that at player build time shader compilation can be done in parallel. While the Editor is not compiling shaders, the compiler processes do nothing and do not consume computer resources.

The shader cache folder can become quite large, if you have a lot of shaders that are changed often. It is safe to delete this folder; it just causes Unity to recompile the shader variants.

At player build time, all the “not yet compiled” shader variants are compiled, so that they are in the game data even if the editor did not happen to use them.

Different shader compilers

Different platforms use different shader compilers for shader program compilation as follows:

  • Platforms that use DirectX use Microsoft’s FXC HLSL compiler.
  • Platforms that use OpenGL (Core & ES) use Microsoft’s FXC HLSL compiler, followed by bytecode translation into GLSL using HLSLcc.
  • Platforms that use Metal use Microsoft’s FXC HLSL compiler, followed by bytecode translation into Metal, using HLSLcc.
  • Platforms that use Vulkan use Microsoft’s FXC HLSL compiler, followed by bytecode translation into SPIR-V, using HLSLcc.
  • Other platforms, such as console platforms, use their respective compilers.
  • Surface ShadersA streamlined way of writing shaders for the Built-in Render Pipeline. More info
    See in Glossary
    use HLSL and MojoShader for code generation analysis step.

You can use predefined shader macros to identify which compiler Unity is using. You might want to use this if you use HLSL syntax that is supported by only one compiler, or to work around a compiler bug.

You can configure various shader compiler settings using pragma directives.

Build time stripping

While building the game, Unity can detect that some of the internal shader variants are not used by the game, and exclude (“strip”) them from build data. Build-time stripping is done for:

  • For shaders that use #pragma shader_feature, Unity automatically checks whether variants are used. If none of the Materials in a build use a variant, that variant it is not included into the build. See internal shader variants documentation. The Standard shader uses this.
  • Shader variants to handle Fog and Lightmapping modes not used by any of the scenesA 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
    are not included into the game data. See the Graphics window if you want to override this behavior.
  • You can also manually identify variants and tell Unity to exclude them from a build using using the OnProcessShader API.

Combination of the above often substantially cuts down on shader data size. For example, a fully compiled Standard shader would take several hundred megabytes, but in typical projects it often ends up taking just a couple megabytes (and is often compressed further by the application packaging process).

Shader assets
Asynchronous shader compilation