ImageExtensionsDrawInto(Image, Bitmap, Rectangle, Rectangle, 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.

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,
	ScalingMode scalingMode
)

VB

<ExtensionAttribute>
Public Shared Sub DrawInto ( 
	source As Image,
	target As Bitmap,
	sourceRectangle As Rectangle,
	targetRectangle As Rectangle,
	scalingMode As ScalingMode
)

C++

public:
[ExtensionAttribute]
static void DrawInto(
	Image^ source, 
	Bitmap^ target, 
	Rectangle sourceRectangle, 
	Rectangle targetRectangle, 
	ScalingMode scalingMode
)

F#

[<ExtensionAttribute>]
static member DrawInto : 
        source : Image * 
        target : Bitmap * 
        sourceRectangle : Rectangle * 
        targetRectangle : Rectangle * 
        scalingMode : ScalingMode -> 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.
scalingMode ScalingMode: Specifies the scaling mode if the bitmap data to be drawn needs to be resized.

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

Exceptions

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