Class WhiteBalance

A volume component that holds settings for the White Balance effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
WhiteBalance
Implements
Inherited Members
ScriptableObject.CreateInstance<T>()
Object.GetEntityId()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.Universal
Assembly: Unity.RenderPipelines.Universal.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/White Balance")]
[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
public sealed class WhiteBalance : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent
Remarks

You can add VolumeComponent to a VolumeProfile in the Editor to apply a White Balance post-processing effect.

Examples

This sample code shows how settings can be retrieved and modified in runtime:

using System;
using UnityEngine;
using UnityEngine.Rendering;
using UnityEngine.Rendering.Universal;

public class ModifyVolumeComponent : MonoBehaviour
{
[SerializeField] VolumeProfile volumeProfile;
[SerializeField] VolumeSettings volumeSettings;


private bool m_HasRetrievedVolumeComponent;
private WhiteBalance m_VolumeComponent;

[Serializable]
private struct VolumeSettings
{
    public bool active;
    public ClampedFloatParameter temperature;
    public ClampedFloatParameter tint;

    public void SetVolumeComponentSettings(ref WhiteBalance volumeComponent)
    {
        volumeComponent.active = active;
        volumeComponent.temperature = temperature;
        volumeComponent.tint = tint;
    }

    public void GetVolumeComponentSettings(ref WhiteBalance volumeComponent)
    {
        active = volumeComponent.active;
        temperature = volumeComponent.temperature;
        tint = volumeComponent.tint;
    }
}

private void Start()
{
    m_HasRetrievedVolumeComponent = GetVolumeComponent(in volumeProfile, ref m_VolumeComponent);
    if (m_HasRetrievedVolumeComponent)
        volumeSettings.GetVolumeComponentSettings(ref m_VolumeComponent);
}

private void Update()
{
    if (!m_HasRetrievedVolumeComponent)
        return;

    volumeSettings.SetVolumeComponentSettings(ref m_VolumeComponent);
}

private static bool GetVolumeComponent(in VolumeProfile volumeProfile, ref WhiteBalance volumeComponent)
{
    if (volumeComponent != null)
        return true;

    if (volumeProfile == null)
    {
        Debug.LogError("ModifyVolumeComponent.GetVolumeComponent():\nvolumeProfile has not been assigned.");
        return false;
    }

    volumeProfile.TryGet(out WhiteBalance component);
    if (component == null)
    {
        Debug.LogError($"ModifyVolumeComponent.GetVolumeComponent():\nMissing component in the \"{volumeProfile.name}\" VolumeProfile ");
        return false;
    }

    volumeComponent = component;
    return true;
}



}

Fields

temperature

Controls the color temperature URP uses for white balancing.

Declaration
[Tooltip("Sets the white balance to a custom color temperature.")]
public ClampedFloatParameter temperature
Field Value
Type Description
ClampedFloatParameter
See Also

tint

Controls the white balance color to compensate for a green or magenta tint.

Declaration
[Tooltip("Sets the white balance to compensate for a green or magenta tint.")]
public ClampedFloatParameter tint
Field Value
Type Description
ClampedFloatParameter
See Also

Methods

IsActive()

Tells if the post process needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

true if the effect should be rendered, false otherwise.
See Also

Implements

See Also