GifEncoderBeginEncodeAnimation Method

Begins to encode the frames of the specified configuration as an animated GIF image and to write it into the specified stream.


Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.0.0-preview.1
public static IAsyncResult BeginEncodeAnimation(
	AnimatedGifConfiguration configuration,
	Stream stream,
	AsyncConfig? asyncConfig = null


configuration  AnimatedGifConfiguration
An AnimatedGifConfiguration instance describing the configuration of the encoding.
stream  Stream
The stream to save the encoded animation into.
asyncConfig  AsyncConfig  (Optional)
The configuration of the asynchronous operation such as parallelization, cancellation, reporting progress, etc. When Progress is set in this parameter, then this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface. This parameter is optional.
Default value: .

Return Value

An IAsyncResult that represents the asynchronous operation, which could still be pending.


In .NET Framework 4.0 and above you can use also the EncodeAnimationAsync method.

To finish the operation and to get the exception that occurred during the operation you have to call the EndEncodeAnimation method.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.


See the Remarks section of the EncodeAnimation method for more details.


ArgumentNullExceptionconfiguration or stream is .
ArgumentExceptionconfiguration is invalid.

See Also