BitmapDataExtensionsDrawInto(IReadableBitmapData, IReadWriteBitmapData, IAsyncContext, Rectangle, Rectangle, IQuantizer, IDitherer, ScalingMode) Method

Draws the source IReadableBitmapData into the target IReadWriteBitmapData using scaling and blending, 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 DrawInto(
	this IReadableBitmapData source,
	IReadWriteBitmapData target,
	IAsyncContext? context,
	Rectangle sourceRectangle,
	Rectangle targetRectangle,
	IQuantizer? quantizer = null,
	IDitherer? ditherer = null,
	ScalingMode scalingMode = ScalingMode.Auto
)

Parameters

source  IReadableBitmapData
The source IReadableBitmapData to be drawn into the target.
target  IReadWriteBitmapData
The target IReadWriteBitmapData into which source should be drawn.
context  IAsyncContext
An IAsyncContext instance that contains information for asynchronous processing about the current operation.
sourceRectangle  Rectangle
A Rectangle that specifies the portion of the source to be drawn into the target.
targetRectangle  Rectangle
A Rectangle that specifies the location and size of the drawn source.
quantizer  IQuantizer  (Optional)
An IQuantizer instance to be used for the drawing. If not specified, then the drawing operation might automatically pick a quantizer based on target PixelFormat. This parameter is optional.
Default value: .
ditherer  IDitherer  (Optional)
The ditherer to be used for the drawing. Might be ignored if quantizer is not specified and target PixelFormat format has at least 24 bits-per-pixel size. This parameter is optional.
Default value: .
scalingMode  ScalingMode  (Optional)
Specifies the scaling mode if the bitmap data to be drawn needs to be resized. This parameter is optional.
Default value: Auto.

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

Exceptions

ArgumentNullExceptionsource or target is .
ArgumentOutOfRangeExceptionscalingMode has an unsupported value.

See Also