// Copyright (c) 2010-2014 SharpDX - Alexandre Mutel
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Text;

namespace SharpDX.Direct2D1.Effects
{
    /// <summary>
    /// Built in GaussianBlur effect.
    /// </summary>
    public class GaussianBlur : Effect
    {
        /// <summary>
        /// Initializes a new instance of <see cref="GaussianBlur"/> effect.
        /// </summary>
        /// <param name="context"></param>
        public GaussianBlur(DeviceContext context) : base(context, Effect.GaussianBlur)
        {
        }

        /// <summary>
        /// Gets or sets the amount of blur to be applied to the image. Default: 1.0f
        /// </summary>
        /// <remarks>
        /// You can compute the blur radius of the kernel by multiplying the standard deviation by 3. The units of both the standard deviation and blur radius are DIPs. A value of zero DIPs disables this effect entirely. 
        /// </remarks>
        public float StandardDeviation
        {
            get
            {
                return GetFloatValue((int)GaussianBlurProperties.StandardDeviation);
            }
            set
            {
                SetValue((int)GaussianBlurProperties.StandardDeviation, value);
            }
        }

        /// <summary>
        /// The optimization mode. See <see cref="GaussianBlurOptimization"/> modes for more info.
        /// </summary>
        /// <remarks>
        /// Default value is <see cref="GaussianBlurOptimization.Balanced"/>.
        /// </remarks>
        public GaussianBlurOptimization Optimization
        {
            get
            {
                return GetEnumValue<GaussianBlurOptimization>((int)GaussianBlurProperties.Optimization);
            }
            set
            {
                SetEnumValue((int)GaussianBlurProperties.Optimization, value);
            }
        }

        /// <summary>
        /// The mode used to calculate the border of the image, soft or hard. See <see cref="BorderMode"/> modes for more info.
        /// </summary>
        public BorderMode BorderMode
        {
            get
            {
                return GetEnumValue<BorderMode>((int)GaussianBlurProperties.BorderMode);
            }
            set
            {
                SetEnumValue((int)GaussianBlurProperties.BorderMode, value);
            }
        }
    }
}