osu-framework / osu.Framework / Graphics / OpenGL / ClearInfo.cs

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using osuTK.Graphics;

namespace osu.Framework.Graphics.OpenGL
{
    /// <summary>
    /// Information for how the current frame buffer should be cleared.
    /// </summary>
    public readonly struct ClearInfo
    {
        /// <summary>
        /// The default clear properties, as defined by OpenGL.
        /// </summary>
        public static ClearInfo Default => new ClearInfo(default);

        /// <summary>
        /// The colour to write to the frame buffer.
        /// </summary>
        public readonly Color4 Colour;

        /// <summary>
        /// The depth to write to the frame buffer.
        /// </summary>
        public readonly double Depth;

        /// <summary>
        /// The stencil value to write to the frame buffer.
        /// </summary>
        public readonly int Stencil;

        public ClearInfo(Color4 colour = default, double depth = 1f, int stencil = 0)
        {
            Colour = colour;
            Depth = depth;
            Stencil = stencil;
        }
    }
}