ShareX/ShareX.ImageEffectsLib/ImageEffect.cs

72 lines
2.0 KiB
C#

#region License Information (GPL v3)
/*
ShareX - A program that allows you to take screenshots and share any file type
Copyright (c) 2007-2024 ShareX Team
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Optionally you can also view the license at <http://www.gnu.org/licenses/>.
*/
#endregion License Information (GPL v3)
using Newtonsoft.Json;
using ShareX.HelpersLib;
using System.ComponentModel;
using System.Drawing;
namespace ShareX.ImageEffectsLib
{
public abstract class ImageEffect
{
[DefaultValue(true), Browsable(false)]
public bool Enabled { get; set; }
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
[DefaultValue(""), Browsable(false)]
public string Name { get; set; }
protected ImageEffect()
{
Enabled = true;
}
public abstract Bitmap Apply(Bitmap bmp);
protected virtual string GetSummary()
{
return null;
}
public override string ToString()
{
if (!string.IsNullOrEmpty(Name))
{
return Name;
}
string name = GetType().GetDescription();
string summary = GetSummary();
if (!string.IsNullOrEmpty(summary))
{
name = $"{name}: {summary}";
}
return name;
}
}
}