ImageExtensionsSaveAsAnimatedGif(IEnumerableImage, Stream, IEnumerableTimeSpan, IQuantizer, IDitherer) Method

public static void SaveAsAnimatedGif(
	this IEnumerable<Image> frames,
	Stream stream,
	IEnumerable<TimeSpan>? delays,
	IQuantizer? quantizer = null,
	IDitherer? ditherer = null
)

<ExtensionAttribute>
Public Shared Sub SaveAsAnimatedGif ( 
	frames As IEnumerable(Of Image),
	stream As Stream,
	delays As IEnumerable(Of TimeSpan),
	Optional quantizer As IQuantizer = Nothing,
	Optional ditherer As IDitherer = Nothing
)

public:
[ExtensionAttribute]
static void SaveAsAnimatedGif(
	IEnumerable<Image^>^ frames, 
	Stream^ stream, 
	IEnumerable<TimeSpan>^ delays, 
	IQuantizer^ quantizer = nullptr, 
	IDitherer^ ditherer = nullptr
)

[<ExtensionAttribute>]
static member SaveAsAnimatedGif : 
        frames : IEnumerable<Image> * 
        stream : Stream * 
        delays : IEnumerable<TimeSpan> * 
        ?quantizer : IQuantizer * 
        ?ditherer : IDitherer 
(* Defaults:
        let _quantizer = defaultArg quantizer null
        let _ditherer = defaultArg ditherer null
*)
-> unit 

Parameters

frames  IEnumerableImage

The frames to save into the GIF data stream.

stream  Stream

The stream into the GIF data is to be saved.

delays  IEnumerableTimeSpan

The collection of the delays to be used for the animation. If or empty, then a default 100 ms delay will be used for all frames. If contains less elements than frames, then the last value will be re-used for the remaining frames.

quantizer  IQuantizer  (Optional)

An optional quantizer to be used for the frames. If , then for frames with a non-indexed pixel format a quantizer returned by the OptimizedPaletteQuantizer.Wu method will be used. This parameter is optional.
Default value: .

ditherer  IDitherer  (Optional)

An optional ditherer to be used when quantizing the frames. This parameter is optional.
Default value: .

Usage Note

When frames contain multi-frame instances, this method takes only the current frame. You can extract images by the ExtractBitmaps extension method.

The enumerator of frames is evaluated in a lazy manner. You can even dispose the previous image once the next one is queried.

Though this method does not support reporting progress directly, you can pass an iterator to the frames parameter that can track how many images have already been processed.

The resolution of the animation is determined by the first frame. If subsequent frames have different sizes, then they will be centered.

If quantizer supports an optimized palette for each frames (like OptimizedPaletteQuantizer), then some frames of the animation might have even more than 256 colors (depending on the differences between frames).

Reference