AnimatedGifConfiguration Class

KGy SOFT Drawing Libraries Help
Represents the configuration for encoding a GIF animation by the GifEncoder.EncodeAnimation method.
Inheritance Hierarchy

SystemObject
  KGySoft.Drawing.ImagingAnimatedGifConfiguration

Namespace:  KGySoft.Drawing.Imaging
Assembly:  KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0-preview.2
Syntax

public sealed class AnimatedGifConfiguration

The AnimatedGifConfiguration type exposes the following members.

Constructors

  NameDescription
Public methodAnimatedGifConfiguration(FuncIReadableBitmapData, FuncNullableTimeSpan)
Initializes a new instance of the AnimatedGifConfiguration class.
Public methodAnimatedGifConfiguration(IEnumerableIReadableBitmapData, IEnumerableTimeSpan)
Initializes a new instance of the AnimatedGifConfiguration class.
Public methodAnimatedGifConfiguration(IEnumerableIReadableBitmapData, NullableTimeSpan)
Initializes a new instance of the AnimatedGifConfiguration class.
Top
Properties

  NameDescription
Public propertyAllowClippedFrames
Gets or sets whether the encoder is allowed to add smaller actual frames than the Size of the animation.
Default value: .
See also the Remarks section of the AllowDeltaFrames property for more details.
Public propertyAllowDeltaFrames
Gets or sets whether it is allowed to encode only the changed region of a frame. In some circumstances the value of this property might be ignored.
Default value: .
See the Remarks section for details.
Public propertyAnimationMode
Gets or sets the looping mode of the animation.
Default value: Repeat.
Public propertyDeltaTolerance
Gets or sets the allowed maximum tolerance for detecting changes of consecutive frames when AllowDeltaFrames is .
Default value: 0.
Public propertyDitherer
Gets or sets an optional ditherer to be used when quantizing the frames.
Default value: .
Public propertyEncodeTransparentBorders Obsolete.
Gets or sets whether the transparent borders of the frames should be encoded as part of the frame.
Default value: .
Public propertyQuantizer
Gets or sets an optional quantizer to be used for the frames. Using a non- value forces the quantization also of already indexed images. Should use up to 256 colors; otherwise, the result might be quantized further with using the default system 8-bit palette.
Default value: .
Public propertyReplaceZeroDelays
Gets or sets whether zero delay values are allowed in the result stream, which is usually interpreted as 100 ms by most GIF decoders.
Default value: .
Public propertyReportOverallProgress
Gets or sets whether to report overall and/or sub-task progress when encoding by GifEncoder.BeginEncodeAnimation and GifEncoder.EncodeAnimationAsync methods and the AsyncConfigBase.Progress property is set. When , then both are reported.
Default value: .
Public propertySize
Gets or sets the desired size of the result animation. If , then size is determined by the first frame. If set explicitly or the input frames can have different sizes, then SizeHandling should also be set accordingly.
Default value: .
Public propertySizeHandling
Gets or sets how possibly different input frame sizes are handled.
Default value: ErrorIfDiffers.
Top
See Also

Reference