BitmapDataExtensionsCloneAsync(IReadableBitmapData, KnownPixelFormat, Color32, Byte, NullableRectangle, TaskConfig) Method
Gets the clone of the specified portion of source with the specified pixelFormat and color settings asynchronously.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.0.0-preview.1
public static Task<IReadWriteBitmapData?> CloneAsync(
this IReadableBitmapData source,
KnownPixelFormat pixelFormat,
Color32 backColor = default,
byte alphaThreshold = 128,
Rectangle? sourceRectangle = null,
TaskConfig? asyncConfig = null
)
<ExtensionAttribute>
Public Shared Function CloneAsync (
source As IReadableBitmapData,
pixelFormat As KnownPixelFormat,
Optional backColor As Color32 = Nothing,
Optional alphaThreshold As Byte = 128,
Optional sourceRectangle As Rectangle? = Nothing,
Optional asyncConfig As TaskConfig = Nothing
) As Task(Of IReadWriteBitmapData)
public:
[ExtensionAttribute]
static Task<IReadWriteBitmapData^>^ CloneAsync(
IReadableBitmapData^ source,
KnownPixelFormat pixelFormat,
Color32 backColor = Color32(),
unsigned char alphaThreshold = 128,
Nullable<Rectangle> sourceRectangle = nullptr,
TaskConfig^ asyncConfig = nullptr
)
[<ExtensionAttribute>]
static member CloneAsync :
source : IReadableBitmapData *
pixelFormat : KnownPixelFormat *
?backColor : Color32 *
?alphaThreshold : byte *
?sourceRectangle : Nullable<Rectangle> *
?asyncConfig : TaskConfig
(* Defaults:
let _backColor = defaultArg backColor new Color32()
let _alphaThreshold = defaultArg alphaThreshold 128
let _sourceRectangle = defaultArg sourceRectangle null
let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<IReadWriteBitmapData>
- source IReadableBitmapData
- An IReadableBitmapData instance to be cloned.
- pixelFormat KnownPixelFormat
- The desired pixel format of the result.
- backColor Color32 (Optional)
- If pixelFormat does not support alpha or supports only single-bit alpha, then specifies the color of the background.
Source pixels with alpha, which will be opaque in the result will be blended with this color.
The Color32.A property of the background color is ignored. This parameter is optional.
Default value: The default value of the Color32 type, which has the same RGB values as Black. - alphaThreshold Byte (Optional)
- If pixelFormat can represent only single-bit alpha or pixelFormat is an indexed format and the target palette contains a transparent color,
then specifies a threshold value for the Color32.A property, under which the color is considered transparent. If 0,
then the result will not have transparent pixels. This parameter is optional.
Default value: 128. - sourceRectangle NullableRectangle (Optional)
- A Rectangle that specifies the portion of the source to be cloned, or to clone the entire source. This parameter is optional.
Default value: . - asyncConfig TaskConfig (Optional)
- The configuration of the asynchronous 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. This parameter is optional.
Default value: .
TaskIReadWriteBitmapDataA task that represents the asynchronous operation. Its result is the new
IReadWriteBitmapData instance that represents the clone of the specified
source,
or
, if the operation was canceled and the
ThrowIfCanceled property of the
asyncConfig 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 is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.