BitmapDataExtensionsTransformColors(IReadWriteBitmapData, IAsyncContext, FuncColor32, Color32, IDitherer) Method

Transforms the colors of this bitmapData using the specified transformFunction delegate inside of an already created, possibly asynchronous context.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0

C#

public static bool TransformColors(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Func<Color32, Color32> transformFunction,
	IDitherer? ditherer
)

VB

<ExtensionAttribute>
Public Shared Function TransformColors ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	transformFunction As Func(Of Color32, Color32),
	ditherer As IDitherer
) As Boolean

C++

public:
[ExtensionAttribute]
static bool TransformColors(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Func<Color32, Color32>^ transformFunction, 
	IDitherer^ ditherer
)

F#

[<ExtensionAttribute>]
static member TransformColors : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        transformFunction : Func<Color32, Color32> * 
        ditherer : IDitherer -> bool

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to be transformed.
context IAsyncContext: An IAsyncContext instance that contains information for asynchronous processing about the current operation.
transformFunction FuncColor32, Color32: The transform function to be used on the colors of the specified bitmapData. It must be thread-safe.
ditherer IDitherer: An optional IDitherer instance to dither the result of the transformation if transformFunction returns colors that is not compatible with the PixelFormat 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.

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 TransformColors(IReadWriteBitmapData, FuncColor32, Color32, IDitherer) overload for more details about the other parameters.

Exceptions

ArgumentNullException

bitmapData or transformFunction is .