RenderSettings
The Render Settings contain values for a range of visual elements in your Scene, like fog and ambient light.
Read time 5 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: Object
public sealed class RenderSettings : Object
Remarks
The properties of the Render Settings class can be adjusted both in the Unity Editor through the Lighting Window and using scripts at runtime.
The Render Settings values are stored inside a scene, so changing the properties of this class will change the scene asset as well.
When multiple scenes are loaded at a time, Unity uses the Render Settings from the active scene.
The example below describes a component creating an axis-aligned zone that changes the color of the fog as the camera moves toward the zone. Additional Resources: The Lighting window.
Examples
using UnityEngine;public class FogZone : MonoBehaviour{ public Camera mainCamera; public Vector3 zoneCenter = Vector3.zero; public Vector3 zoneSize = new Vector3(10, 10, 10); public Color fogColorInside = Color.red; public Color fogColorOutside = Color.white; public float transitionRadius = 5.0f; Bounds zoneBounds; void Start() { // Create a bounds object based on the center and size of the zone zoneBounds = new Bounds(zoneCenter, zoneSize); } void Update() { if (mainCamera == null) return; // Calculate the closest point on the box to the camera Vector3 closestPoint = zoneBounds.ClosestPoint(mainCamera.transform.position); float distanceToZone = Vector3.Distance(mainCamera.transform.position, closestPoint); // Determine the interpolation factor based on the transition radius float t = Mathf.Clamp01(distanceToZone / transitionRadius); // Interpolate between the inside and outside fog colors RenderSettings.fogColor = Color.Lerp(fogColorInside, fogColorOutside, t); }}
Static Properties
Property | Description |
|---|---|
| ambientEquatorColor | Ambient lighting coming from the sides. |
| ambientGroundColor | Ambient lighting coming from below. |
| ambientIntensity | How much the light from the Ambient Source affects the Scene. |
| ambientLight | Flat ambient lighting color. |
| ambientMode | Ambient lighting mode. |
| ambientProbe | An ambient probe that captures environment lighting. |
| ambientSkyColor | Ambient lighting coming from above. |
| defaultReflectionMode | Default reflection mode. |
| defaultReflectionResolution | Cubemap resolution for default reflection. |
| flareFadeSpeed | The fade speed of all flares in the Scene. |
| flareStrength | The intensity of all flares in the Scene. |
| fog | Is fog enabled? |
| fogColor | The color of the fog. |
| fogDensity | The density of the exponential fog. |
| fogEndDistance | The ending distance of linear fog. |
| fogMode | Fog mode to use. |
| fogStartDistance | The starting distance of linear fog. |
| haloStrength | Size of the Light halos. |
| reflectionBounces | The number of times a reflection includes other reflections. |
| reflectionIntensity | How much the skybox / custom cubemap reflection affects the Scene. |
| skybox | The global skybox to use. |
| subtractiveShadowColor | The color used for the sun shadows in the Subtractive lightmode. |
| sun | The light used by the procedural skybox. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |