Lightmapping
Allows to control the lightmapping job.
Read time 3 minutesLast updated 2 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
public static class Lightmapping
Remarks
Before starting the job the bake settings can be set via LightingSettings.
Additional Resources: LightingSettings.
Static Properties
Property | Description |
|---|---|
| bakedGI | This property is now obsolete. Use LightingSettings.bakedGI. |
| bakeOnSceneLoad | Determines whether lighting data should be generated when loading a scene, for scenes that have not already been baked. |
| buildProgress | Returns the current lightmapping build progress or 0 if Lightmapping.isRunning is false. |
| isRunning | Returns true when the bake job is running, false otherwise (Read Only). |
| lightingDataAsset | The lighting data asset used by the active Scene. |
| lightingSettings | The LightingSettings that will be used for the current Scene. Will throw an exception if it is null. |
| lightingSettingsDefaults | Default LightingSettings that Unity uses for Scenes where Lightmapping.lightingSettings is not assigned. (Read only) |
Static Methods
Method | Description |
|---|---|
| AddBakeDelegate | Set a delegate that bakes additional data. This delegate must set its done parameter to true once baking is finished to unlock the baking pipeline. |
| Bake | Starts a synchronous bake job. |
| BakeAsync | Starts an asynchronous bake job. |
| BakeMultipleScenes | Bakes an array of Scenes. |
| BakeReflectionProbe | Starts a synchronous bake job for the probe. |
| Cancel | Cancels the currently running asynchronous bake job. |
| Clear | Deletes all runtime data for the currently loaded Scenes. |
| ClearDiskCache | Clears the cache used by lightmaps, reflection probes and default reflection. |
| ClearLightingDataAsset | For the currently loaded Scenes, this method deletes the Lighting Data Asset and any linked lightmaps and Reflection Probe assets. |
| GetLightingDataAssetForScene | Gets the LightingDataAsset associated with a specific scene. This method will return null if the scene has no LightingDataAsset, or the scene is invalid. |
| GetLightingSettingsForScene | Gets the LightingSettings object of a Scene object. |
| GetTerrainGIChunks | Get how many chunks the terrain is divided into for GI baking. |
| HasDynamicGILightmapTextures | Determines whether any of the currently loaded scenes have Enlighten Dynamic GI lightmaps. |
| RemoveBakeDelegate | Remove a delegate that bakes additional data. |
| SetLightingDataAssetForScene | Sets the LightingDataAsset associated with a specific scene. |
| SetLightingSettingsForScene | Applies the settings specified in the LightingSettings object to the Scene object. |
| SetLightingSettingsForScenes | Applies the settings specified in the LightingSettings object to an array of Scene objects. |
| Tetrahedralize | Calculates tetrahderons from positions using Delaunay Tetrahedralization. |
| TryGetLightingSettings | Fetches the Lighting Settings for the current Scene. Will return false if it is null. |
Static Events
Member | Description |
|---|---|
| bakeCancelled | Event which is called when bake job is cancelled. |
| bakeCompleted | Event which is called when bake job is completed. Only called when LightingSettings.autoGenerate is set to false. |
| bakeStarted | Event which is called when a bake is started. Only called when LightingSettings.autoGenerate is set to false. |
| inputExtraction | Event which is called when the bake job calls ExtractFromScene. This happens when a bake is started from the Editor or a bake is started with the lightmapping API. Additional Resources: Lightmapping.Bake, Lightmapping.BakeAsync. |
| lightingDataAssetCleared | Event which is called when a LightingData asset is removed from the project. |
| lightingDataCleared | Event which is called when baked Global Illumination data is cleared from the scene and from renderers. |
| lightingDataUpdated | Event which is called when any lighting data is updated as part of the GI backing process. |
Enums
Enum | Description |
|---|---|
| Lightmapping.BakeOnSceneLoadMode | Enum describing whether a scene should be baked on load. |
| Lightmapping.GIWorkflowMode | Workflow mode for lightmap baking. Default is Iterative. |
Delegates
Delegate | Description |
|---|---|
| Lightmapping.AdditionalBakeDelegate | Delegate called at the last stage of the baking pipeline. |
| Lightmapping.BakeDelegate | Delegate called at the last stage of the baking pipeline. |
| Lightmapping.InputExtractionFunction | Delegate used by InputExtraction callback. This can be used to modify the BakeInput in order to customize baking. |
| Lightmapping.OnCompletedFunction | Delegate used by Lightmapping.completed callback. |
| Lightmapping.OnStartedFunction | Delegate used by Lightmapping.started callback. |