BitmapDataExtensionsClear(IWritableBitmapData, Color32, IDitherer) 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: 7.0.0-preview.3
C#
public static void Clear(
	this IWritableBitmapData bitmapData,
	Color32 color,
	IDitherer? ditherer = null
)

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  (Optional)
The ditherer to be used for the clearing. Has no effect if PixelFormat of bitmapData has at least 24 bits-per-pixel size. This parameter is optional.
Default value: .

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 adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. Use the BeginClear or ClearAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

See Also