BitmapDataExtensionsMakeTransparent(IReadWriteBitmapData, IAsyncContext, Color32) Method

If possible, makes the background of this bitmapData transparent, using transparentColor as the background color, and using a context that may belong to a higher level, possibly asynchronous operation. 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: 10.0.0-rc.1

C#

public static bool MakeTransparent(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Color32 transparentColor
)

VB

<ExtensionAttribute>
Public Shared Function MakeTransparent ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	transparentColor As Color32
) As Boolean

C++

public:
[ExtensionAttribute]
static bool MakeTransparent(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Color32 transparentColor
)

F#

[<ExtensionAttribute>]
static member MakeTransparent : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        transparentColor : Color32 -> bool

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to make transparent.
context IAsyncContext: An IAsyncContext instance that contains information for asynchronous processing about the current operation.
transparentColor Color32: Specifies the color to make transparent.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled.

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 blocks the caller thread, but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Tip

See the Examples section of the AsyncHelper class for details about how to create a context for possibly async top level methods.

Note

See the MakeTransparent(IReadWriteBitmapData, Color32) overload for more details.