BitmapDataExtensionsBeginMakeTransparent(IReadWriteBitmapData, Color32, AsyncConfig) Method

If possible, begins to make the background of this bitmapData transparent asynchronously, using transparentColor as the background color. If the bitmapData does not support transparency, then the pixels that have the same color as transparentColor will be set to the BackColor of bitmapData.

Definition

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

C#

public static IAsyncResult BeginMakeTransparent(
	this IReadWriteBitmapData bitmapData,
	Color32 transparentColor,
	AsyncConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function BeginMakeTransparent ( 
	bitmapData As IReadWriteBitmapData,
	transparentColor As Color32,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

C++

public:
[ExtensionAttribute]
static IAsyncResult^ BeginMakeTransparent(
	IReadWriteBitmapData^ bitmapData, 
	Color32 transparentColor, 
	AsyncConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member BeginMakeTransparent : 
        bitmapData : IReadWriteBitmapData * 
        transparentColor : Color32 * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to make transparent.
transparentColor Color32: Specifies the color to make transparent.
asyncConfig AsyncConfig (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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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

In .NET Framework 4.0 and above you can use also the MakeTransparentAsync(IReadWriteBitmapData, Color32, TaskConfig) method.

To finish the operation and to get the exception that occurred during the operation you have to call the EndMakeTransparent method.

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 MakeTransparent(IReadWriteBitmapData, Color32) method for more details.