BitmapDataExtensionsBeginCombine(IReadableBitmapData, IReadableBitmapData, IWritableBitmapData, FuncColor32, Color32, Color32, NullablePoint, NullablePoint, NullablePoint, NullableSize, IDitherer, AsyncConfig) Method

public static IAsyncResult BeginCombine(
	this IReadableBitmapData source1,
	IReadableBitmapData source2,
	IWritableBitmapData target,
	Func<Color32, Color32, Color32> combineFunction,
	Point? source1Location = null,
	Point? source2Location = null,
	Point? targetLocation = null,
	Size? size = null,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginCombine ( 
	source1 As IReadableBitmapData,
	source2 As IReadableBitmapData,
	target As IWritableBitmapData,
	combineFunction As Func(Of Color32, Color32, Color32),
	Optional source1Location As Point? = Nothing,
	Optional source2Location As Point? = Nothing,
	Optional targetLocation As Point? = Nothing,
	Optional size As Size? = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginCombine(
	IReadableBitmapData^ source1, 
	IReadableBitmapData^ source2, 
	IWritableBitmapData^ target, 
	Func<Color32, Color32, Color32>^ combineFunction, 
	Nullable<Point> source1Location = nullptr, 
	Nullable<Point> source2Location = nullptr, 
	Nullable<Point> targetLocation = nullptr, 
	Nullable<Size> size = nullptr, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginCombine : 
        source1 : IReadableBitmapData * 
        source2 : IReadableBitmapData * 
        target : IWritableBitmapData * 
        combineFunction : Func<Color32, Color32, Color32> * 
        ?source1Location : Nullable<Point> * 
        ?source2Location : Nullable<Point> * 
        ?targetLocation : Nullable<Point> * 
        ?size : Nullable<Size> * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _source1Location = defaultArg source1Location null
        let _source2Location = defaultArg source2Location null
        let _targetLocation = defaultArg targetLocation null
        let _size = defaultArg size null
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

source1  IReadableBitmapData

An IReadableBitmapData to be combined with source2.

source2  IReadableBitmapData

An IReadableBitmapData to be combined with source1.

target  IWritableBitmapData

The target IWritableBitmapData to write the combined result into.

combineFunction  FuncColor32, Color32, Color32

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

source1Location  NullablePoint  (Optional)

A Point that specifies the origin in source1 for the operation, or to start with its top-left pixel. This parameter is optional.
Default value: .

source2Location  NullablePoint  (Optional)

A Point that specifies the origin in source2 for the operation, or to start with its top-left pixel. 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: .

size  NullableSize  (Optional)

A Size that specifies the bounds of the combined pixels, or to take the largest possible area. This parameter is optional.
Default value: .

ditherer  IDitherer  (Optional)

The ditherer to be used. Might be ignored if target has a wide enough PixelFormat. 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.

The combined area is automatically clipped if size is larger than the dimensions of the smallest bitmap or the available sizes using the specified locations.

If target can represent a narrower set of colors, then the result will be automatically quantized to the colors of the target. To use dithering a ditherer must be explicitly specified. The ditherer is ignored for KnownPixelFormats with more than 16 bits-per-pixel and for grayscale formats.

Reference