BitmapDataExtensionsClear(IWritableBitmapData, Color32, IDitherer, ParallelConfig) Method

Clears the content of the specified bitmapData and fills it with the specified color.

Definition

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

C#

public static bool Clear(
	this IWritableBitmapData bitmapData,
	Color32 color,
	IDitherer? ditherer,
	ParallelConfig? parallelConfig
)

VB

<ExtensionAttribute>
Public Shared Function Clear ( 
	bitmapData As IWritableBitmapData,
	color As Color32,
	ditherer As IDitherer,
	parallelConfig As ParallelConfig
) As Boolean

C++

public:
[ExtensionAttribute]
static bool Clear(
	IWritableBitmapData^ bitmapData, 
	Color32 color, 
	IDitherer^ ditherer, 
	ParallelConfig^ parallelConfig
)

F#

[<ExtensionAttribute>]
static member Clear : 
        bitmapData : IWritableBitmapData * 
        color : Color32 * 
        ditherer : IDitherer * 
        parallelConfig : ParallelConfig -> bool

Parameters

bitmapData IWritableBitmapData: The IWritableBitmapData to be cleared.
color Color32: A Color32 that represents the desired result color of the bitmapData. If it has transparency, which is not supported by PixelFormat of bitmapData, then the result might be either completely transparent (depends also on AlphaThreshold), or the color will be blended with BackColor.
ditherer IDitherer: The ditherer to be used for the clearing. Has no effect if PixelFormat of bitmapData has at least 24 bits-per-pixel size.
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.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig parameter was .

Usage Note

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

Note

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 BeginClear or ClearAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.