BitmapDataExtensionsMakeOpaqueAsync Method

Makes this bitmapData opaque asynchronously using the specified backColor.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

C#

public static Task<bool> MakeOpaqueAsync(
	this IReadWriteBitmapData bitmapData,
	Color32 backColor,
	IDitherer? ditherer = null,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function MakeOpaqueAsync ( 
	bitmapData As IReadWriteBitmapData,
	backColor As Color32,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

C++

public:
[ExtensionAttribute]
static Task<bool>^ MakeOpaqueAsync(
	IReadWriteBitmapData^ bitmapData, 
	Color32 backColor, 
	IDitherer^ ditherer = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member MakeOpaqueAsync : 
        bitmapData : IReadWriteBitmapData * 
        backColor : Color32 * 
        ?ditherer : IDitherer * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool>

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to make opaque.
backColor Color32: Pixels with alpha in bitmapData will be blended with this color. The Color32.A field of the specified color is ignored.
ditherer IDitherer (Optional): An optional IDitherer instance to dither the result of the transformation if the inverse of the bitmapData has no exact representation with its PixelFormat. 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: .

Return Value

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and the ThrowIfCanceled property in asyncConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadWriteBitmapData. 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

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Tip

See the Remarks section of the MakeOpaque method for more details.