BitmapDataExtensionsClear(IWritableBitmapData, Color32, IDitherer) Method
Clears the content of the specified bitmapData and fills it with the specified color.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0
public static void Clear(
this IWritableBitmapData bitmapData,
Color32 color,
IDitherer? ditherer = null
)
<ExtensionAttribute>
Public Shared Sub Clear (
bitmapData As IWritableBitmapData,
color As Color32,
Optional ditherer As IDitherer = Nothing
)
public:
[ExtensionAttribute]
static void Clear(
IWritableBitmapData^ bitmapData,
Color32 color,
IDitherer^ ditherer = nullptr
)
[<ExtensionAttribute>]
static member Clear :
bitmapData : IWritableBitmapData *
color : Color32 *
?ditherer : IDitherer
(* Defaults:
let _ditherer = defaultArg ditherer null
*)
-> unit
- 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: .
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).
This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use
the
Clear(IWritableBitmapData, Color32, IDitherer, ParallelConfig) overload to configure these, while still executing the method synchronously. Alternatively, use
the
BeginClear or
ClearAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
