ImageSharp/src/ImageSharp/Processing/Processors/Overlays/GlowProcessor.cs

// Copyright (c) Six Labors and contributors.
// Licensed under the Apache License, Version 2.0.

using SixLabors.ImageSharp.PixelFormats;
using SixLabors.ImageSharp.Primitives;

namespace SixLabors.ImageSharp.Processing.Processors.Overlays
{
    /// <summary>
    /// Defines a radial glow effect applicable to an <see cref="Image"/>.
    /// </summary>
    public sealed class GlowProcessor : IImageProcessor
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="GlowProcessor" /> class.
        /// </summary>
        /// <param name="color">The color or the glow.</param>
        public GlowProcessor(Color color)
            : this(color, 0)
        {
        }


        /// <summary>
        /// Initializes a new instance of the <see cref="GlowProcessor" /> class.
        /// </summary>
        /// <param name="color">The color or the glow.</param>
        /// <param name="options">The options effecting blending and composition.</param>
        public GlowProcessor(Color color, GraphicsOptions options)
            : this(color, 0, options)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="GlowProcessor" /> class.
        /// </summary>
        /// <param name="color">The color or the glow.</param>
        /// <param name="radius">The radius of the glow.</param>
        internal GlowProcessor(Color color, ValueSize radius)
            : this(color, radius, GraphicsOptions.Default)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="GlowProcessor" /> class.
        /// </summary>
        /// <param name="color">The color or the glow.</param>
        /// <param name="radius">The radius of the glow.</param>
        /// <param name="options">The options effecting blending and composition.</param>
        internal GlowProcessor(Color color, ValueSize radius, GraphicsOptions options)
        {
            this.GlowColor = color;
            this.Radius = radius;
            this.GraphicsOptions = options;
        }

        /// <summary>
        /// Gets the options effecting blending and composition
        /// </summary>
        public GraphicsOptions GraphicsOptions { get; }

        /// <summary>
        /// Gets the glow color to apply.
        /// </summary>
        public Color GlowColor { get; }

        /// <summary>
        /// Gets the the radius.
        /// </summary>
        internal ValueSize Radius { get;  }

        /// <inheritdoc />
        public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>()
            where TPixel : struct, IPixel<TPixel>
        {
            return new GlowProcessor<TPixel>(this);
        }
    }
}