BitmapDataExtensionsDither(IReadWriteBitmapData, IAsyncContext, IQuantizer, IDitherer) Method

Quantizes an IReadWriteBitmapData with the specified quantizer and ditherer, using a context that may belong to a higher level, possibly asynchronous operation.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

C#

public static bool Dither(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	IQuantizer quantizer,
	IDitherer ditherer
)

VB

<ExtensionAttribute>
Public Shared Function Dither ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	quantizer As IQuantizer,
	ditherer As IDitherer
) As Boolean

C++

public:
[ExtensionAttribute]
static bool Dither(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	IQuantizer^ quantizer, 
	IDitherer^ ditherer
)

F#

[<ExtensionAttribute>]
static member Dither : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        quantizer : IQuantizer * 
        ditherer : IDitherer -> bool

Parameters

bitmapData IReadWriteBitmapData: An IReadWriteBitmapData instance to be quantized.
context IAsyncContext: An IAsyncContext instance that contains information for asynchronous processing about the current operation.
quantizer IQuantizer: An IQuantizer implementation to be used for quantizing the specified bitmapData.
ditherer IDitherer: An IDitherer implementation to be used for dithering during the quantization of the specified bitmapData.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadWriteBitmapData. 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).

Remarks

This method blocks the caller thread, but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Tip

See the Examples section of the AsyncHelper class for details about how to create a context for possibly async top level methods.

Note

See the Dither(IReadWriteBitmapData, IQuantizer, IDitherer) overload for more details about the other parameters.

Exceptions

ArgumentNullException	bitmapData, quantizer or ditherer is .
InvalidOperationException	The IQuantizer.Initialize method or the IDitherer.Initialize method returned .