Class SkySettings | High Definition RP | 8.0.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class SkySettings

    Base class for custom Sky Settings.

    Inheritance
    Object
    SkySettings
    GradientSky
    HDRISky
    PhysicallyBasedSky
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    public abstract class SkySettings : VolumeComponent

    Fields

    desiredLuxValue

    Absolute intensity (in lux) of the sky.

    Declaration
    public FloatParameter desiredLuxValue
    Field Value
    Type Description
    FloatParameter

    exposure

    Exposure of the sky.

    Declaration
    public FloatParameter exposure
    Field Value
    Type Description
    FloatParameter

    includeSunInBaking

    True if the sun disk should be included in the baking information (where available).

    Declaration
    public BoolParameter includeSunInBaking
    Field Value
    Type Description
    BoolParameter

    multiplier

    Intensity Multipler of the sky.

    Declaration
    public MinFloatParameter multiplier
    Field Value
    Type Description
    MinFloatParameter

    rotation

    Rotation of the sky.

    Declaration
    public ClampedFloatParameter rotation
    Field Value
    Type Description
    ClampedFloatParameter

    skyIntensityMode

    Intensity mode of the sky.

    Declaration
    public SkyIntensityParameter skyIntensityMode
    Field Value
    Type Description
    SkyIntensityParameter

    updateMode

    Update mode of the sky.

    Declaration
    public EnvUpdateParameter updateMode
    Field Value
    Type Description
    EnvUpdateParameter

    updatePeriod

    In case of real-time update mode, time between updates. 0 means every frame.

    Declaration
    public MinFloatParameter updatePeriod
    Field Value
    Type Description
    MinFloatParameter

    upperHemisphereLuxColor

    Informative helper that displays Show the color of Shadow.

    Declaration
    public Vector3Parameter upperHemisphereLuxColor
    Field Value
    Type Description
    Vector3Parameter

    upperHemisphereLuxValue

    Informative helper that displays the relative intensity (in Lux) for the current HDR texture set in HDRI Sky.

    Declaration
    public MinFloatParameter upperHemisphereLuxValue
    Field Value
    Type Description
    MinFloatParameter

    Methods

    GetHashCode()

    Returns the hash code of the sky parameters.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    The hash code of the sky parameters.

    GetSkyRendererType()

    Returns the class type of the SkyRenderer associated with this Sky Settings.

    Declaration
    public abstract Type GetSkyRendererType()
    Returns
    Type Description
    Type

    The class type of the SkyRenderer associated with this Sky Settings.

    Back to top
    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