BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, Palette, ParallelConfig) Method
Gets the clone of the specified source with identical size and the specified pixelFormat and palette.
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,
KnownPixelFormat pixelFormat,
Palette? palette,
ParallelConfig? parallelConfig
)
<ExtensionAttribute>
Public Shared Function Clone (
source As IReadableBitmapData,
pixelFormat As KnownPixelFormat,
palette As Palette,
parallelConfig As ParallelConfig
) As IReadWriteBitmapData
public:
[ExtensionAttribute]
static IReadWriteBitmapData^ Clone(
IReadableBitmapData^ source,
KnownPixelFormat pixelFormat,
Palette^ palette,
ParallelConfig^ parallelConfig
)
[<ExtensionAttribute>]
static member Clone :
source : IReadableBitmapData *
pixelFormat : KnownPixelFormat *
palette : Palette *
parallelConfig : ParallelConfig -> IReadWriteBitmapData
- source IReadableBitmapData
- An IReadableBitmapData instance to be cloned.
- pixelFormat KnownPixelFormat
- The desired pixel format of the result.
- palette Palette
- If pixelFormat is an indexed format, then specifies the desired Palette of the returned IReadWriteBitmapData instance.
It determines also the BackColor and AlphaThreshold properties of the result.
If , then the target palette is taken from source if it also has a palette of no more entries than the target indexed format can have;
otherwise, a default palette will be used based on pixelFormat.
- 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, Palette, NullableRectangle, AsyncConfig) or
CloneAsync(IReadableBitmapData, KnownPixelFormat, Palette, NullableRectangle, TaskConfig)
(in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
This overload automatically quantizes colors if pixelFormat represents a narrower set of colors than source PixelFormat.
To use a custom quantizer use the overloads with an IQuantizer parameter.
Color depth can be preserved if the target format can represent the colors of the source format without losing information.
See the
Examples section of the
ConvertPixelFormat(Image, PixelFormat, Color[], Color, byte) extension method
for some examples. The
ConvertPixelFormat extensions work the same way
for
Images
as the
Clone extensions for
IReadableBitmapData instances.
