ImageExtensionsDrawInto(Image, Bitmap, Rectangle, Rectangle, IQuantizer, IDitherer, ScalingMode) Method

Draws the source Image into the target Bitmap with possible scaling. This method is similar to Graphics.DrawImage methods, except that this one works between any pair of source and target PixelFormats and supports quantizing and dithering.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0

C#

public static void DrawInto(
	this Image source,
	Bitmap target,
	Rectangle sourceRectangle,
	Rectangle targetRectangle,
	IQuantizer? quantizer = null,
	IDitherer? ditherer = null,
	ScalingMode scalingMode = ScalingMode.Auto
)

VB

<ExtensionAttribute>
Public Shared Sub DrawInto ( 
	source As Image,
	target As Bitmap,
	sourceRectangle As Rectangle,
	targetRectangle As Rectangle,
	Optional quantizer As IQuantizer = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional scalingMode As ScalingMode = ScalingMode.Auto
)

C++

public:
[ExtensionAttribute]
static void DrawInto(
	Image^ source, 
	Bitmap^ target, 
	Rectangle sourceRectangle, 
	Rectangle targetRectangle, 
	IQuantizer^ quantizer = nullptr, 
	IDitherer^ ditherer = nullptr, 
	ScalingMode scalingMode = ScalingMode::Auto
)

F#

[<ExtensionAttribute>]
static member DrawInto : 
        source : Image * 
        target : Bitmap * 
        sourceRectangle : Rectangle * 
        targetRectangle : Rectangle * 
        ?quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?scalingMode : ScalingMode 
(* Defaults:
        let _quantizer = defaultArg quantizer null
        let _ditherer = defaultArg ditherer null
        let _scalingMode = defaultArg scalingMode ScalingMode.Auto
*)
-> unit

Parameters

source Image: The source Image to be drawn into the target.
target Bitmap: The target Bitmap into which source should be drawn.
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.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Image. 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

Note

This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. Use the BitmapDataExtensions.BeginDrawInto or BitmapDataExtensions.DrawIntoAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.
If quantizer is , then this method selects the working color space automatically based on the pixel format of the target bitmap. To apply a specific color space use the GetReadWriteBitmapData(Bitmap, WorkingColorSpace, Color, Byte) method on the target bitmap and use the BitmapDataExtensions.DrawInto methods.

The method has the best performance if sourceRectangle and targetRectangle have the same size, or when scalingMode is NoScaling.

The image to be drawn is automatically clipped if sourceRectangle or targetRectangle exceed bounds, or scalingMode is NoScaling and sourceRectangle and targetRectangle are different.

If target can represent a narrower set of colors, then the result will be automatically quantized to the colors of the target, even if there is no quantizer specified. To use dithering a ditherer must be explicitly specified though.

If quantizer is specified but it uses more/different colors than target can represent, then the result will eventually be quantized to target, though the result may have a poorer quality than expected.

Exceptions

ArgumentNullException	source or target is .
ArgumentOutOfRangeException	scalingMode has an unsupported value.