BitmapDataExtensionsBeginCombine(IReadableBitmapData, IReadWriteBitmapData, FuncColorF, ColorF, ColorF, NullableRectangle, NullablePoint, AsyncConfig) Method

public static IAsyncResult BeginCombine(
	this IReadableBitmapData source,
	IReadWriteBitmapData target,
	Func<ColorF, ColorF, ColorF> combineFunction,
	Rectangle? sourceRectangle = null,
	Point? targetLocation = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginCombine ( 
	source As IReadableBitmapData,
	target As IReadWriteBitmapData,
	combineFunction As Func(Of ColorF, ColorF, ColorF),
	Optional sourceRectangle As Rectangle? = Nothing,
	Optional targetLocation As Point? = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginCombine(
	IReadableBitmapData^ source, 
	IReadWriteBitmapData^ target, 
	Func<ColorF, ColorF, ColorF>^ combineFunction, 
	Nullable<Rectangle> sourceRectangle = nullptr, 
	Nullable<Point> targetLocation = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginCombine : 
        source : IReadableBitmapData * 
        target : IReadWriteBitmapData * 
        combineFunction : Func<ColorF, ColorF, ColorF> * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?targetLocation : Nullable<Point> * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _sourceRectangle = defaultArg sourceRectangle null
        let _targetLocation = defaultArg targetLocation null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

source  IReadableBitmapData

The source IReadableBitmapData to be combined with the target.

target  IReadWriteBitmapData

The target IReadWriteBitmapData into which the combined result should be written.

combineFunction  FuncColorF, ColorF, ColorF

The custom function to be used to combine the colors of the bitmaps. Its first parameter represents a pixel in source, whereas the second parameter represents the corresponding pixel in target. The function must be thread-safe, as it might be called concurrently.

sourceRectangle  NullableRectangle  (Optional)

A Rectangle that specifies the portion of the source to be combined, or to take the entire source. This parameter is optional.
Default value: .

targetLocation  NullablePoint  (Optional)

A Point that specifies the target location, or to write the combined result to the top-left corner of the target. Target size will be always the same as the source size. This parameter is optional.
Default value: .

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

Usage Note

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

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

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

Reference