Type of Sky that is generated procedurally based on user input parameters.
    public class ProceduralSky : Sky

ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky.

The ProceduralSky is updated on the CPU after the parameters change. It is stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for real-time updates during gameplay. However, with a small enough texture size, it can still be updated relatively frequently, as it is updated on a background thread when multi-threading is available.

Inheritance Chain

Constructors

    public ProceduralSky()

Properties

    public Color GroundBottomColor { get; set; }

Color of the ground at the bottom.

    public float GroundCurve { get; set; }

How quickly the GroundHorizonColor fades into the GroundBottomColor.

    public float GroundEnergy { get; set; }

Amount of energy contribution from the ground.

    public Color GroundHorizonColor { get; set; }

Color of the ground at the horizon.

    public float SkyCurve { get; set; }

How quickly the SkyHorizonColor fades into the SkyTopColor.

    public float SkyEnergy { get; set; }

Amount of energy contribution from the sky.

    public Color SkyHorizonColor { get; set; }

Color of the sky at the horizon.

    public Color SkyTopColor { get; set; }

Color of the sky at the top.

    public float SunAngleMax { get; set; }

Distance from center of sun where it fades out completely.

    public float SunAngleMin { get; set; }

Distance from sun where it goes from solid to starting to fade.

    public Color SunColor { get; set; }

The sun’s color.

    public float SunCurve { get; set; }

How quickly the sun fades away between SunAngleMin and SunAngleMax.

    public float SunEnergy { get; set; }

Amount of energy contribution from the sun.

    public float SunLatitude { get; set; }

The sun’s height using polar coordinates.

    public float SunLongitude { get; set; }

The direction of the sun using polar coordinates.

    public TextureSizeEnum TextureSize { get; set; }

Size of Texture that the ProceduralSky will generate. The size is set using TextureSize.

Methods

    [Obsolete("GetGroundBottomColor is deprecated. Use the GroundBottomColor property instead.")]
    public Color GetGroundBottomColor()

Getter for GroundBottomColor

    [Obsolete("GetGroundCurve is deprecated. Use the GroundCurve property instead.")]
    public float GetGroundCurve()

Getter for GroundCurve

    [Obsolete("GetGroundEnergy is deprecated. Use the GroundEnergy property instead.")]
    public float GetGroundEnergy()

Getter for GroundEnergy

    [Obsolete("GetGroundHorizonColor is deprecated. Use the GroundHorizonColor property instead.")]
    public Color GetGroundHorizonColor()

Getter for GroundHorizonColor

    [Obsolete("GetSkyCurve is deprecated. Use the SkyCurve property instead.")]
    public float GetSkyCurve()

Getter for SkyCurve

    [Obsolete("GetSkyEnergy is deprecated. Use the SkyEnergy property instead.")]
    public float GetSkyEnergy()

Getter for SkyEnergy

    [Obsolete("GetSkyHorizonColor is deprecated. Use the SkyHorizonColor property instead.")]
    public Color GetSkyHorizonColor()

Getter for SkyHorizonColor

    [Obsolete("GetSkyTopColor is deprecated. Use the SkyTopColor property instead.")]
    public Color GetSkyTopColor()

Getter for SkyTopColor

    [Obsolete("GetSunAngleMax is deprecated. Use the SunAngleMax property instead.")]
    public float GetSunAngleMax()

Getter for SunAngleMax

    [Obsolete("GetSunAngleMin is deprecated. Use the SunAngleMin property instead.")]
    public float GetSunAngleMin()

Getter for SunAngleMin

    [Obsolete("GetSunColor is deprecated. Use the SunColor property instead.")]
    public Color GetSunColor()

Getter for SunColor

    [Obsolete("GetSunCurve is deprecated. Use the SunCurve property instead.")]
    public float GetSunCurve()

Getter for SunCurve

    [Obsolete("GetSunEnergy is deprecated. Use the SunEnergy property instead.")]
    public float GetSunEnergy()

Getter for SunEnergy

    [Obsolete("GetSunLatitude is deprecated. Use the SunLatitude property instead.")]
    public float GetSunLatitude()

Getter for SunLatitude

    [Obsolete("GetSunLongitude is deprecated. Use the SunLongitude property instead.")]
    public float GetSunLongitude()

Getter for SunLongitude

    [Obsolete("GetTextureSize is deprecated. Use the TextureSize property instead.")]
    public TextureSizeEnum GetTextureSize()

Getter for TextureSize

    [Obsolete("SetGroundBottomColor is deprecated. Use the GroundBottomColor property instead.")]
    public void SetGroundBottomColor(Color color)

Setter for GroundBottomColor

    [Obsolete("SetGroundCurve is deprecated. Use the GroundCurve property instead.")]
    public void SetGroundCurve(float curve)

Setter for GroundCurve

    [Obsolete("SetGroundEnergy is deprecated. Use the GroundEnergy property instead.")]
    public void SetGroundEnergy(float energy)

Setter for GroundEnergy

    [Obsolete("SetGroundHorizonColor is deprecated. Use the GroundHorizonColor property instead.")]
    public void SetGroundHorizonColor(Color color)

Setter for GroundHorizonColor

    [Obsolete("SetSkyCurve is deprecated. Use the SkyCurve property instead.")]
    public void SetSkyCurve(float curve)

Setter for SkyCurve

    [Obsolete("SetSkyEnergy is deprecated. Use the SkyEnergy property instead.")]
    public void SetSkyEnergy(float energy)

Setter for SkyEnergy

    [Obsolete("SetSkyHorizonColor is deprecated. Use the SkyHorizonColor property instead.")]
    public void SetSkyHorizonColor(Color color)

Setter for SkyHorizonColor

    [Obsolete("SetSkyTopColor is deprecated. Use the SkyTopColor property instead.")]
    public void SetSkyTopColor(Color color)

Setter for SkyTopColor

    [Obsolete("SetSunAngleMax is deprecated. Use the SunAngleMax property instead.")]
    public void SetSunAngleMax(float degrees)

Setter for SunAngleMax

    [Obsolete("SetSunAngleMin is deprecated. Use the SunAngleMin property instead.")]
    public void SetSunAngleMin(float degrees)

Setter for SunAngleMin

    [Obsolete("SetSunColor is deprecated. Use the SunColor property instead.")]
    public void SetSunColor(Color color)

Setter for SunColor

    [Obsolete("SetSunCurve is deprecated. Use the SunCurve property instead.")]
    public void SetSunCurve(float curve)

Setter for SunCurve

    [Obsolete("SetSunEnergy is deprecated. Use the SunEnergy property instead.")]
    public void SetSunEnergy(float energy)

Setter for SunEnergy

    [Obsolete("SetSunLatitude is deprecated. Use the SunLatitude property instead.")]
    public void SetSunLatitude(float degrees)

Setter for SunLatitude

    [Obsolete("SetSunLongitude is deprecated. Use the SunLongitude property instead.")]
    public void SetSunLongitude(float degrees)

Setter for SunLongitude

    [Obsolete("SetTextureSize is deprecated. Use the TextureSize property instead.")]
    public void SetTextureSize(TextureSizeEnum size)

Setter for TextureSize

Inner Types

TextureSizeEnum

Name Value Description
Size256    
Size512    
Size1024    
Size2048    
Size4096    
Max 5 Represents the size of the [enum TextureSize] enum.
Tags: