// <copyright file="DisposalMethod.cs" company="James Jackson-South">
// Copyright (c) James Jackson-South and contributors.
// Licensed under the Apache License, Version 2.0.
// </copyright>

namespace ImageSharp.Formats
{
    /// <summary>
    /// Provides enumeration for instructing the decoder what to do with the last image
    /// in an animation sequence.
    /// <see href="http://www.w3.org/Graphics/GIF/spec-gif89a.txt"/> section 23
    /// </summary>
    public enum DisposalMethod
    {
        /// <summary>
        /// No disposal specified. The decoder is not required to take any action.
        /// </summary>
        Unspecified = 0,

        /// <summary>
        /// Do not dispose. The graphic is to be left in place.
        /// </summary>
        NotDispose = 1,

        /// <summary>
        /// Restore to background color. The area used by the graphic must be restored to
        /// the background color.
        /// </summary>
        RestoreToBackground = 2,

        /// <summary>
        /// Restore to previous. The decoder is required to restore the area overwritten by the
        /// graphic with what was there prior to rendering the graphic.
        /// </summary>
        RestoreToPrevious = 3
    }
}