BitmapDataExtensionsCombineAsync(IReadableBitmapData, IReadWriteBitmapData, FuncColor32, Color32, Color32, NullableRectangle, NullablePoint, IDitherer, TaskConfig) Method

Combines the pixels of the source and target bitmaps using the specified combineFunction asynchronously, and writes the result into target.

Definition

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

public static Task<bool> CombineAsync(
	this IReadableBitmapData source,
	IReadWriteBitmapData target,
	Func<Color32, Color32, Color32> combineFunction,
	Rectangle? sourceRectangle = null,
	Point? targetLocation = null,
	IDitherer? ditherer = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function CombineAsync ( 
	source As IReadableBitmapData,
	target As IReadWriteBitmapData,
	combineFunction As Func(Of Color32, Color32, Color32),
	Optional sourceRectangle As Rectangle? = Nothing,
	Optional targetLocation As Point? = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

C++

public:
[ExtensionAttribute]
static Task<bool>^ CombineAsync(
	IReadableBitmapData^ source, 
	IReadWriteBitmapData^ target, 
	Func<Color32, Color32, Color32>^ combineFunction, 
	Nullable<Rectangle> sourceRectangle = nullptr, 
	Nullable<Point> targetLocation = nullptr, 
	IDitherer^ ditherer = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member CombineAsync : 
        source : IReadableBitmapData * 
        target : IReadWriteBitmapData * 
        combineFunction : Func<Color32, Color32, Color32> * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?targetLocation : Nullable<Point> * 
        ?ditherer : IDitherer * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _sourceRectangle = defaultArg sourceRectangle null
        let _targetLocation = defaultArg targetLocation null
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool>

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 FuncColor32, Color32, Color32: 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: .
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 TaskConfig (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

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and the ThrowIfCanceled property in asyncConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadableBitmapData. 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 is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Tip

See the Remarks section of the Combine(IReadableBitmapData, IReadWriteBitmapData, FuncColor32, Color32, Color32, NullableRectangle, NullablePoint, IDitherer, ParallelConfig) method for more details.

Exceptions

ArgumentNullException

source, target or combineFunction is .