Bake(Scene)
Starts a synchronous lighting bake job for the target Scene.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEditor.Experimental
- Assembly: UnityEditor.CoreModule
public static bool Bake(Scene targetScene)
Parameters
The Scene to generate lighting data for.
Returns
Type | Description |
|---|---|
| bool | Returns true if Unity successfully completes the lighting bake job. Returns false if Unity does not successfully complete the lighting bake job. |
Remarks
Unity generates lighting data for the target Scene only, but Lights, Renderers, Terrains and emissive Materials from all open Scenes contribute to the lighting. Note that Renderers and Terrains contribute to the lighting only if their StaticEditorFlags.ContributeGI flag is enabled.
Unity calls bakeStarted when it starts the bake, and bakeCompleted when it completes the bake. This function returns when Unity completes the bake. If the bake was not successful, Unity prints a warning to the console.
Note that Unity only performs the bake if Lightmapping.giWorkflowMode is set to Lightmapping.GIWorkflowMode.OnDemand. If this is not the case, this function immediately returns false.
For asynchronous bakes see Lightmapping.BakeAsync.
Additional Resources: Scene.