An object containing settings for precomputing lighting data, that Unity can serialize as a Lighting Settings Asset.
When the Unity Editor precomputes lighting data for a Scene that uses the Baked Global Illumination system or the Realtime Global Illumination system, it uses settings from a LightingSettings
object. The same LightingSettings
object can be assigned to more than one Scene, which makes it possible to share settings across multiple Scenes.
The following example shows how to create a LightingSettings
object and assign it to the active Scene using the Lightmapping.lightingSettings API:
using UnityEngine; using UnityEditor;
public class CreateLightingSettingsExample { [MenuItem("Example/Create Lighting Settings")] static void CreateExampleLightingSettings() { // Create an instance of LightingSettings LightingSettings lightingSettings = new LightingSettings();
// Configure the LightingSettings object lightingSettings.albedoBoost = 8.0f;
// Assign the LightingSettings object to the active Scene Lightmapping.lightingSettings = lightingSettings; } }
The following example shows how to create a LightingSettings
object, and save it to disk as a Lighting Settings Asset using the AssetDatabase.CreateAsset API.
using UnityEngine; using UnityEditor;
public class CreateLightingSettingsExample { [MenuItem("Example/Create Lighting Settings")] static void SaveExampleLightingSettingsToDisk() { // Create an instance of LightingSettings LightingSettings lightingSettings = new LightingSettings();
// Configure the LightingSettings object lightingSettings.albedoBoost = 8.0f;
// Save it to your Project, using the .lighting extension AssetDatabase.CreateAsset(lightingSettings, "Assets/ExampleLightingSettings.lighting"); } }
See Also: Lighting Settings Asset.
albedoBoost | The intensity of surface albedo throughout the Scene when considered in lighting calculations. This value influences the energy of light at each bounce. (Editor only). |
ao | Whether to apply ambient occlusion to lightmaps. (Editor only). |
aoExponentDirect | Determines the degree to which direct lighting is considered when calculating ambient occlusion in lightmaps. (Editor only). |
aoExponentIndirect | Sets the contrast of ambient occlusion that Unity applies to indirect lighting in lightmaps. (Editor only). |
aoMaxDistance | The distance that a ray travels before Unity considers it to be unoccluded when calculating ambient occlusion in lightmaps. (Editor only). |
autoGenerate | Whether the Unity Editor automatically precomputes lighting data when the Scene data changes. (Editor only). |
bakedGI | Whether to enable the Baked Global Illumination system for this Scene. |
compressLightmaps | Whether to compress the lightmap textures that the Progressive Lightmapper generates. (Editor only) |
denoiserTypeAO | Determines the type of denoising that the Progressive Lightmapper applies to ambient occlusion in lightmaps. (Editor only). |
denoiserTypeDirect | Determines the denoiser that the Progressive Lightmapper applies to direct lighting. (Editor only). |
denoiserTypeIndirect | Determines the denoiser that the Progressive Lightmapper applies to indirect lighting. (Editor only). |
directionalityMode | Determines whether the lightmapper should generate directional or non-directional lightmaps. (Editor only). |
directSampleCount | Specifies the number of samples the Progressive Lightmapper uses for direct lighting calculations. (Editor only). |
environmentSampleCount | Specifies the number of samples the Progressive Lightmapper uses when sampling indirect lighting from the skybox. (Editor only). |
exportTrainingData | Whether the Progressive Lightmapper exports machine learning training data to the Project folder when it performs the bake. ( Editor only). |
extractAO | Whether the Progressive Lightmapper extracts Ambient Occlusion to a separate lightmap. (Editor only). |
filteringAtrousPositionSigmaAO | Specifies the threshold the Progressive Lightmapper uses to filter direct light stored in the lightmap when using the A-Trous filter. (Editor only). |
filteringAtrousPositionSigmaDirect | Specifies the threshold the Progressive Lightmapper uses to filter the indirect lighting component of the lightmap when using the A-Trous filter. (Editor only). |
filteringAtrousPositionSigmaIndirect | Specifies the radius the Progressive Lightmapper uses to filter the ambient occlusion component in the lightmap when using Gaussian filter. (Editor only). |
filteringGaussRadiusAO | Specifies the radius the Progressive Lightmapper uses to filter the direct lighting component of the lightmap when using Gaussian filter. (Editor only). |
filteringGaussRadiusDirect | Specifies the radius the Progressive Lightmapper used to filter the indirect lighting component of the lightmap when using Gaussian filter. (Editor only). |
filteringGaussRadiusIndirect | Specifies the method used by the Progressive Lightmapper to reduce noise in lightmaps. (Editor only). |
filteringMode | Specifies the filter type that the Progressive Lightmapper uses for ambient occlusion. (Editor only). |
filterTypeAO | Specifies the filter kernel that the Progressive Lightmapper uses for ambient occlusion. (Editor only). |
filterTypeDirect | Specifies the filter kernel that the Progressive Lightmapper uses for the direct lighting. (Editor only). |
filterTypeIndirect | Specifies the filter kernel that the Progressive Lightmapper uses for indirect lighting. (Editor only). |
finalGather | Specifies whether the final light bounce of the global illumination calculation is calculated at the same resolution as the baked lightmap. (Editor only). |
finalGatherFiltering | Controls whether a denoising filter is applied to the final gather output. |
finalGatherRayCount | Controls the number of rays emitted for every final gather point. A final gather point is a lightmap texel in the final, composited lightmap. (Editor only). |
indirectResolution | Defines the number of texels that Enlighten uses per world unit when calculating indirect lighting. (Editor only). |
indirectSampleCount | Specifies the number of samples the Progressive Lightmapper uses for indirect lighting calculations. (Editor only). |
indirectScale | Multiplies the intensity of of indirect lighting in lightmaps. (Editor only). |
lightmapMaxSize | The maximum size in pixels of an individual lightmap texture. (Editor only). |
lightmapPadding | Sets the distance (in texels) between separate UV tiles in lightmaps. (Editor only). |
lightmapper | Determines which backend to use for baking lightmaps in the Baked Global Illumination system. (Editor only). |
lightmapResolution | Defines the number of texels to use per world unit when generating lightmaps. |
lightProbeSampleCountMultiplier | Specifies the number of samples to use for Light Probes relative to the number of samples for lightmap texels. (Editor only). |
maxBounces | Stores the maximum number of bounces the Progressive Lightmapper computes for indirect lighting. (Editor only) |
minBounces | Stores the minimum number of bounces the Progressive Lightmapper computes for indirect lighting. (Editor only) |
mixedBakeMode | Sets the MixedLightingMode that Unity uses for all Mixed Lights in the Scene. (Editor only). |
prioritizeView | Whether the Progressive Lightmapper prioritizes baking visible texels within the frustum of the Scene view. (Editor only). |
realtimeEnvironmentLighting | Determines the lightmap that Unity stores environment lighting in. |
realtimeGI | Whether to enable the Realtime Global Illumination system for this Scene. |
trainingDataDestination | Determines the name of the destination folder for the exported textures. (Editor only). |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsOfType | Gets a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |