ImageExtensionsSaveAsHighColorGif(Image, String, Boolean, Color, Byte) Method

Encodes the specified image as a multi-layered, single frame GIF image and writes it into the specified file, preserving its original color depth.
See the Remarks section of the SaveAsHighColorGif(Image, Stream, Boolean, Color, Byte) overload for details.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
C#
public static void SaveAsHighColorGif(
	this Image image,
	string fileName,
	bool allowFullScan = false,
	Color backColor = default,
	byte alphaThreshold = 128
)

Parameters

image  Image
The Image to save. If contains multiple images or frames, then only the current image or frame will be saved.
fileName  String
The name of the file to which to save the image. The directory of the specified path is created if it does not exist.
allowFullScan  Boolean  (Optional)
to allow scanning the whole image for each layers to be able to re-use the local palette of the current layer.
to expand the initial layer area to the local pixels only. This parameter is optional.
Default value: .
backColor  Color  (Optional)
Colors with alpha (transparency), whose Color.A property is equal to or greater than alphaThreshold will be blended with this color during the encoding. The alpha value (Color.A property) of the specified background color is ignored. This parameter is optional.
Default value: Empty, which has the same RGB values as Black.
alphaThreshold  Byte  (Optional)
Specifies a threshold value for the Color.A property, under which a pixel is considered transparent. If 0, then the final composite image will not have transparent pixels. This parameter is optional.
Default value: 128.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Image. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullExceptionimage or fileName is .

See Also