Version: 2022.3
LanguageEnglish
  • C#

Lightmapping

class in UnityEditor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Allows to control the lightmapping job.

Before starting the job the bake settings can be set via LightingSettings.

Additional resources: LightingSettings.

Static Properties

bakedGIThis property is now obsolete. Use LightingSettings.bakedGI.
buildProgressReturns the current lightmapping build progress or 0 if Lightmapping.isRunning is false.
giWorkflowModeThis property is now obsolete. Use LightingSettings.autoGenerate.
isRunningReturns true when the bake job is running, false otherwise (Read Only).
lightingDataAssetThe lighting data asset used by the active Scene.
lightingSettingsThe LightingSettings that will be used for the current Scene. Will throw an exception if it is null.
lightingSettingsDefaultsDefault LightingSettings that Unity uses for Scenes where lightingSettings is not assigned. (Read only)
realtimeGIThis property is now obsolete. Use LightingSettings.realtimeGI.

Static Methods

BakeStarts a synchronous bake job.
BakeAsyncStarts an asynchronous bake job.
BakeMultipleScenesBakes an array of Scenes.
BakeReflectionProbeStarts a synchronous bake job for the probe.
CancelCancels the currently running asynchronous bake job.
ClearDeletes all runtime data for the currently loaded Scenes.
ClearDiskCacheClears the cache used by lightmaps, reflection probes and default reflection.
ClearLightingDataAssetFor the currently loaded Scenes, this method deletes the Lighting Data Asset and any linked lightmaps and Reflection Probe assets.
ForceStopForce the Progressive Path Tracer to stop baking and use the computed results as they are.
GetLightingSettingsForSceneGets the LightingSettings object of a Scene object.
GetTerrainGIChunksGet how many chunks the terrain is divided into for GI baking.
SetLightingSettingsForSceneApplies the settings specified in the LightingSettings object to the Scene object.
SetLightingSettingsForScenesApplies the settings specified in the LightingSettings object to an array of Scene objects.
TetrahedralizeCalculates tetrahderons from positions using Delaunay Tetrahedralization.
TryGetLightingSettingsFetches the Lighting Settings for the current Scene. Will return false if it is null.

Events

bakeCompletedEvent which is called when bake job is completed. Only called when LightingSettings.autoGenerate is set to false.
bakeStartedEvent which is called when a bake is started. Only called when LightingSettings.autoGenerate is set to false.
lightingDataAssetClearedEvent which is called when a LightingData asset is removed from the project.
lightingDataClearedEvent which is called when baked Global Illumination data is cleared from the scene and from renderers.
lightingDataUpdatedEvent which is called when any lighting data is updated as part of the GI backing process.
startedDelegate which is called when bake job is started.

Delegates

OnCompletedFunctionDelegate used by Lightmapping.completed callback.
OnStartedFunctionDelegate used by Lightmapping.started callback.