BitmapDataExtensionsClone(IReadableBitmapData, Rectangle, KnownPixelFormat, IQuantizer, IDitherer, ParallelConfig) Method
Gets the clone of the specified portion of source with the specified pixelFormat, using an optional quantizer and ditherer.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
public static IReadWriteBitmapData? Clone(
this IReadableBitmapData source,
Rectangle sourceRectangle,
KnownPixelFormat pixelFormat,
IQuantizer? quantizer,
IDitherer? ditherer,
ParallelConfig? parallelConfig
)
<ExtensionAttribute>
Public Shared Function Clone (
source As IReadableBitmapData,
sourceRectangle As Rectangle,
pixelFormat As KnownPixelFormat,
quantizer As IQuantizer,
ditherer As IDitherer,
parallelConfig As ParallelConfig
) As IReadWriteBitmapData
public:
[ExtensionAttribute]
static IReadWriteBitmapData^ Clone(
IReadableBitmapData^ source,
Rectangle sourceRectangle,
KnownPixelFormat pixelFormat,
IQuantizer^ quantizer,
IDitherer^ ditherer,
ParallelConfig^ parallelConfig
)
[<ExtensionAttribute>]
static member Clone :
source : IReadableBitmapData *
sourceRectangle : Rectangle *
pixelFormat : KnownPixelFormat *
quantizer : IQuantizer *
ditherer : IDitherer *
parallelConfig : ParallelConfig -> IReadWriteBitmapData
- source IReadableBitmapData
- An IReadableBitmapData instance to be cloned.
- sourceRectangle Rectangle
- A Rectangle that specifies the portion of the source to be cloned.
- pixelFormat KnownPixelFormat
- The desired pixel format of the result.
- quantizer IQuantizer
- An optional IQuantizer instance to determine the colors of the result.
If and pixelFormat is an indexed format, then a default palette and quantization logic will be used.
- ditherer IDitherer
- The ditherer to be used. Might be ignored if quantizer is not specified
and pixelFormat represents an at least 24 bits-per-pixel size.
- parallelConfig ParallelConfig
- The configuration of the operation such as parallelization, cancellation, reporting progress, etc.
When Progress is set in this parameter,
then this library always passes a DrawingOperation instance to the generic methods of
the IAsyncProgress interface.
If , then the degree of parallelization is configured automatically.
IReadWriteBitmapDataAn
IReadWriteBitmapData instance that represents the clone of the specified
source, or
, if the operation
was canceled and the
ThrowIfCanceled property
of the
parallelConfig parameter was
.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).
This method blocks the caller as it executes synchronously, though the
parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use
the
BeginClone(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, AsyncConfig) or
CloneAsync(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, TaskConfig)
(in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
If pixelFormat can represent a narrower set of colors, then the result will be automatically quantized to its color space,
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 pixelFormat can represent,
then the result will eventually be quantized to pixelFormat, though the result may have a poorer quality than expected.
Color depth can be preserved if quantizer is not specified and the target format can represent the colors of the source format without losing information.
See the
Examples section of the
ConvertPixelFormat(Image, PixelFormat, IQuantizer?, IDitherer?) extension method
for some examples. The
ConvertPixelFormat extensions work the same way
for
Images
as the
Clone extensions for
IReadableBitmapData instances.
