class in UnityEngine
/
Inherits from:Object
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseAn 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 Enlighten 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"); } }
Additional resources: 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). |
bakedGI | Whether to enable the Baked Global Illumination system for this Scene. |
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). |
environmentImportanceSampling | Determines whether Progressive Lightmappers use importance sampling when they sample environment lighting while baking. |
environmentSampleCount | Specifies the number of samples the Progressive Lightmapper uses when sampling indirect lighting from the skybox. (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 you use the Gaussian filter. (Editor only). |
filteringGaussianRadiusAO | Specifies the radius the Progressive Lightmapper uses to filter the direct lighting component of the lightmap when you use the Gaussian filter. (Editor only). |
filteringGaussianRadiusDirect | Specifies the radius the Progressive Lightmapper uses to filter the indirect lighting component of the lightmap when you use the Gaussian filter. (Editor only). |
filteringGaussianRadiusIndirect | Specifies the method that the Progressive Lightmapper uses 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 whether the Editor calculates the final global illumination light bounce at the same resolution as the baked lightmap. |
indirectResolution | Defines the number of texels that Enlighten Realtime Global Illumination 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). |
lightmapCompression | The level of compression the Editor uses for lightmaps. |
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 Enlighten Realtime Global Illumination system for this Scene. |
respectSceneVisibilityWhenBakingGI | When Unity is precomputing or baking Global Illumination, respect the Scene Visibility setting of a [[GameObject] with a MeshRenderer or Terrain component. |
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. |
FindAnyObjectByType | Retrieves any active loaded object of Type type. |
FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.