Version: 2019.3
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.
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

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.
GetTerrainGIChunksGet how many chunks the terrain is divided into for GI baking.
TetrahedralizeCalculates tetrahderons from positions using Delaunay Tetrahedralization.

Events

bakeCompletedEvent which is called when bake job is completed. Only called in Lightmapping.GIWorkflowMode.OnDemand mode.
bakeStartedEvent which is called when a bake is started. Only called in Lightmapping.GIWorkflowMode.OnDemand mode.
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.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961