LightingSettings

Description

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 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");
    }
}

See Also: Lighting Settings Asset.

Properties

Inherited Members