Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetAsyncCompilation(CommandBuffer, bool)

Adds shader compilation mode command in the CommandBuffer.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor
public static void SetAsyncCompilation(CommandBuffer cmd, bool allow)

Parameters

cmd

CommandBuffer
Target CommandBuffer.

allow

bool
Is async Shader compilation allowed or not.

Remarks

The Editor compiles Shader Variants on-demand, the first time rendering requires a particular Shader Variant. By default, asynchronous Shader compilation is only enabled for requests that originate from the Game View or Scene View. With this method, you can add commands to CommandBuffer that control the Shader compilation during the execution of the buffer. This lets you disable and enable asynchronous compilation on specific parts of rendering, both for Game View, Scene View and other Views, for example custom tools. To restore the previous compilation mode, see ShaderUtil.RestoreAsyncCompilation.
Additional Resources: ShaderUtil.RestoreAsyncCompilation, ShaderUtil.allowAsyncCompilation, ShaderUtil.anythingCompiling, ShaderUtil.IsPassCompiled, ShaderUtil.CompilePass.