docs.unity3d.com
    Show / Hide Table of Contents

    Class WhiteBalance

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

    Inheritance
    Object
    VolumeComponent
    WhiteBalance
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Post-processing/White Balance", new Type[]{typeof(HDRenderPipeline)})]
    public sealed class WhiteBalance : VolumeComponent, IPostProcessComponent

    Fields

    temperature

    Controls the color temperature HDRP uses for white balancing.

    Declaration
    [Tooltip("Controls the color temperature HDRP uses for white balancing.")]
    public ClampedFloatParameter temperature
    Field Value
    Type Description
    ClampedFloatParameter

    tint

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

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

    Methods

    IsActive()

    Tells if the effect needs to be rendered or not.

    Declaration
    public bool IsActive()
    Returns
    Type Description
    Boolean

    true if the effect should be rendered, false otherwise.

    Implements
    IPostProcessComponent.IsActive()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023