1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
|
using System;
using System.Diagnostics;
namespace FreeImageAPI.Plugins
{
/// <summary>
/// Class representing a FreeImage format.
/// </summary>
public sealed class FreeImagePlugin
{
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly FREE_IMAGE_FORMAT fif;
/// <summary>
/// Initializes a new instance of this class.
/// </summary>
/// <param name="fif">The FreeImage format to wrap.</param>
internal FreeImagePlugin(FREE_IMAGE_FORMAT fif)
{
this.fif = fif;
}
/// <summary>
/// Gets the format of this instance.
/// </summary>
public FREE_IMAGE_FORMAT FIFormat
{
get
{
return fif;
}
}
/// <summary>
/// Gets or sets whether this plugin is enabled.
/// </summary>
public bool Enabled
{
get
{
return (FreeImage.IsPluginEnabled(fif) == 1);
}
set
{
FreeImage.SetPluginEnabled(fif, value);
}
}
/// <summary>
/// Gets a string describing the format.
/// </summary>
public string Format
{
get
{
return FreeImage.GetFormatFromFIF(fif);
}
}
/// <summary>
/// Gets a comma-delimited file extension list describing the bitmap formats
/// this plugin can read and/or write.
/// </summary>
public string ExtentsionList
{
get
{
return FreeImage.GetFIFExtensionList(fif);
}
}
/// <summary>
/// Gets a descriptive string that describes the bitmap formats
/// this plugin can read and/or write.
/// </summary>
public string Description
{
get
{
return FreeImage.GetFIFDescription(fif);
}
}
/// <summary>
/// Returns a regular expression string that can be used by
/// a regular expression engine to identify the bitmap.
/// FreeImageQt makes use of this function.
/// </summary>
public string RegExpr
{
get
{
return FreeImage.GetFIFRegExpr(fif);
}
}
/// <summary>
/// Gets whether this plugin can load bitmaps.
/// </summary>
public bool SupportsReading
{
get
{
return FreeImage.FIFSupportsReading(fif);
}
}
/// <summary>
/// Gets whether this plugin can save bitmaps.
/// </summary>
public bool SupportsWriting
{
get
{
return FreeImage.FIFSupportsWriting(fif);
}
}
/// <summary>
/// Checks whether this plugin can save a bitmap in the desired data type.
/// </summary>
/// <param name="type">The desired image type.</param>
/// <returns>True if this plugin can save bitmaps as the desired type, else false.</returns>
public bool SupportsExportType(FREE_IMAGE_TYPE type)
{
return FreeImage.FIFSupportsExportType(fif, type);
}
/// <summary>
/// Checks whether this plugin can save bitmaps in the desired bit depth.
/// </summary>
/// <param name="bpp">The desired bit depth.</param>
/// <returns>True if this plugin can save bitmaps in the desired bit depth, else false.</returns>
public bool SupportsExportBPP(int bpp)
{
return FreeImage.FIFSupportsExportBPP(fif, bpp);
}
/// <summary>
/// Gets whether this plugin can load or save an ICC profile.
/// </summary>
public bool SupportsICCProfiles
{
get
{
return FreeImage.FIFSupportsICCProfiles(fif);
}
}
/// <summary>
/// Checks whether an extension is valid for this format.
/// </summary>
/// <param name="extension">The desired extension.</param>
/// <returns>True if the extension is valid for this format, false otherwise.</returns>
public bool ValidExtension(string extension)
{
return FreeImage.IsExtensionValidForFIF(fif, extension);
}
/// <summary>
/// Checks whether an extension is valid for this format.
/// </summary>
/// <param name="extension">The desired extension.</param>
/// <param name="comparisonType">The string comparison type.</param>
/// <returns>True if the extension is valid for this format, false otherwise.</returns>
public bool ValidExtension(string extension, StringComparison comparisonType)
{
return FreeImage.IsExtensionValidForFIF(fif, extension, comparisonType);
}
/// <summary>
/// Checks whether a filename is valid for this format.
/// </summary>
/// <param name="filename">The desired filename.</param>
/// <returns>True if the filename is valid for this format, false otherwise.</returns>
public bool ValidFilename(string filename)
{
return FreeImage.IsFilenameValidForFIF(fif, filename);
}
/// <summary>
/// Checks whether a filename is valid for this format.
/// </summary>
/// <param name="filename">The desired filename.</param>
/// <param name="comparisonType">The string comparison type.</param>
/// <returns>True if the filename is valid for this format, false otherwise.</returns>
public bool ValidFilename(string filename, StringComparison comparisonType)
{
return FreeImage.IsFilenameValidForFIF(fif, filename, comparisonType);
}
/// <summary>
/// Gets a descriptive string that describes the bitmap formats
/// this plugin can read and/or write.
/// </summary>
/// <returns>A descriptive string that describes the bitmap formats.</returns>
public override string ToString()
{
return Description;
}
}
}
|