BitmapDataExtensionsCombine(IReadableBitmapData, IReadableBitmapData, IWritableBitmapData, IAsyncContext, FuncColorF, ColorF, ColorF, NullablePoint, NullablePoint, NullablePoint, NullableSize) Method

public static bool Combine(
	this IReadableBitmapData source1,
	IReadableBitmapData source2,
	IWritableBitmapData target,
	IAsyncContext? context,
	Func<ColorF, ColorF, ColorF> combineFunction,
	Point? source1Location = null,
	Point? source2Location = null,
	Point? targetLocation = null,
	Size? size = null
)

<ExtensionAttribute>
Public Shared Function Combine ( 
	source1 As IReadableBitmapData,
	source2 As IReadableBitmapData,
	target As IWritableBitmapData,
	context As IAsyncContext,
	combineFunction As Func(Of ColorF, ColorF, ColorF),
	Optional source1Location As Point? = Nothing,
	Optional source2Location As Point? = Nothing,
	Optional targetLocation As Point? = Nothing,
	Optional size As Size? = Nothing
) As Boolean

public:
[ExtensionAttribute]
static bool Combine(
	IReadableBitmapData^ source1, 
	IReadableBitmapData^ source2, 
	IWritableBitmapData^ target, 
	IAsyncContext^ context, 
	Func<ColorF, ColorF, ColorF>^ combineFunction, 
	Nullable<Point> source1Location = nullptr, 
	Nullable<Point> source2Location = nullptr, 
	Nullable<Point> targetLocation = nullptr, 
	Nullable<Size> size = nullptr
)

[<ExtensionAttribute>]
static member Combine : 
        source1 : IReadableBitmapData * 
        source2 : IReadableBitmapData * 
        target : IWritableBitmapData * 
        context : IAsyncContext * 
        combineFunction : Func<ColorF, ColorF, ColorF> * 
        ?source1Location : Nullable<Point> * 
        ?source2Location : Nullable<Point> * 
        ?targetLocation : Nullable<Point> * 
        ?size : Nullable<Size> 
(* Defaults:
        let _source1Location = defaultArg source1Location null
        let _source2Location = defaultArg source2Location null
        let _targetLocation = defaultArg targetLocation null
        let _size = defaultArg size null
*)
-> bool 

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.

context  IAsyncContext

An IAsyncContext instance that contains information for asynchronous processing about the current operation.

combineFunction  FuncColorF, ColorF, ColorF

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: .

Return Value

Usage Note

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.

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, call the Combine(IReadableBitmapData, IReadableBitmapData, IWritableBitmapData, FuncColor32, Color32, Color32, NullablePoint, NullablePoint, NullablePoint, NullableSize, IDitherer, ParallelConfig) overload instead, and specify a ditherer.

Reference