Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

Lightmapping

class in UnityEditor

/

Implemented 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 LightmapEditorSettings.

See Also: LightmapEditorSettings.

Static Properties

bakedGIIs baked GI enabled?
bounceBoostBoost the albedo.
buildProgressReturns the current lightmapping build progress or 0 if Lightmapping.isRunning is false.
completedDelegate which is called when bake job is completed.
giWorkflowModeThe lightmap baking workflow mode used. Iterative mode is default, but you can switch to on demand mode which bakes only when the user presses the bake button.
indirectOutputScaleScale for indirect lighting.
isRunningReturns true when the bake job is running, false otherwise (Read Only).
lightingDataAssetThe lighting data asset used by the active scene.
realtimeGIIs realtime GI enabled?

Static Methods

BakeStars 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 lightmap assets and makes all lights behave as if they weren't baked yet.
ClearDiskCacheClears the cache used by lightmaps, reflection probes and default reflection.
ClearLightingDataAssetRemove the lighting data asset used by the current scene.
ForceStopForce the Progressive Path Tracer to stop baking and use the computed results as they are.
GetTerrainGIChunksGet how many chunks the terrain is divided into for GI baking.
TetrahedralizeCalculates a Delaunay Tetrahedralization of the 'positions' point set - the same way the lightmapper.

Events

startedDelegate which is called when bake job is started.

Delegates

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

Did you find this page useful? Please give it a rating: