BitmapDataExtensionsClip(IReadableBitmapData, Rectangle) Method

Clips the specified source using the specified clippingRegion. Unlike the Clone methods, this one returns a wrapper, providing access only to the specified region of the original source. This overload does not dispose source when the result is disposed.
See the Remarks section of the Clip(IReadableBitmapData, Rectangle, Boolean) overload for details.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 9.0.0

C#

public static IReadableBitmapData Clip(
	this IReadableBitmapData source,
	Rectangle clippingRegion
)

VB

<ExtensionAttribute>
Public Shared Function Clip ( 
	source As IReadableBitmapData,
	clippingRegion As Rectangle
) As IReadableBitmapData

C++

public:
[ExtensionAttribute]
static IReadableBitmapData^ Clip(
	IReadableBitmapData^ source, 
	Rectangle clippingRegion
)

F#

[<ExtensionAttribute>]
static member Clip : 
        source : IReadableBitmapData * 
        clippingRegion : Rectangle -> IReadableBitmapData

Parameters

source IReadableBitmapData: The source bitmap data to be clipped.
clippingRegion Rectangle: A Rectangle that specifies a region within the source.

Return Value

IReadableBitmapData
An IReadableBitmapData that provides access only to the specified region withing the source.

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

Exceptions

ArgumentNullException	source is .
ArgumentOutOfRangeException	clippingRegion has no overlapping region with source bounds.