BitmapDataExtensionsClear(IWritableBitmapData, IAsyncContext, Color32, IDitherer) Method
Clears the content of the specified bitmapData and fills it with the specified color
inside of an already created, possibly asynchronous context.
KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.1.0
public static bool Clear(
this IWritableBitmapData bitmapData,
IDitherer? ditherer = null
Public Shared Function Clear (
bitmapData As IWritableBitmapData,
context As IAsyncContext,
color As Color32,
Optional ditherer As IDitherer = Nothing
) As Boolean
static bool Clear(
IDitherer^ ditherer = nullptr
static member Clear :
bitmapData : IWritableBitmapData *
context : IAsyncContext *
color : Color32 *
?ditherer : IDitherer
let _ditherer = defaultArg ditherer null
- bitmapData IWritableBitmapData
- The IWritableBitmapData to be cleared.
- context IAsyncContext
- An IAsyncContext instance
that contains information for asynchronous processing about the current operation.
- 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: .
, if the operation completed successfully.
, if the operation has been canceled.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 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.
When reporting progress, this library always passes a DrawingOperation instance to the generic methods of
the IAsyncProgress interface.
See the Examples
section of the AsyncHelper
class for details about how to create a context for possibly async top level methods.