BitmapDataExtensionsMakeGrayscale(IReadWriteBitmapData, IDitherer, ParallelConfig) Method
Makes this bitmapData grayscale.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
public static bool MakeGrayscale(
this IReadWriteBitmapData bitmapData,
IDitherer? ditherer,
ParallelConfig? parallelConfig
)
<ExtensionAttribute>
Public Shared Function MakeGrayscale (
bitmapData As IReadWriteBitmapData,
ditherer As IDitherer,
parallelConfig As ParallelConfig
) As Boolean
public:
[ExtensionAttribute]
static bool MakeGrayscale(
IReadWriteBitmapData^ bitmapData,
IDitherer^ ditherer,
ParallelConfig^ parallelConfig
)
[<ExtensionAttribute>]
static member MakeGrayscale :
bitmapData : IReadWriteBitmapData *
ditherer : IDitherer *
parallelConfig : ParallelConfig -> bool
- bitmapData IReadWriteBitmapData
- The IReadWriteBitmapData to make grayscale.
- ditherer IDitherer
- An optional IDitherer instance to dither the result if grayscale colors
cannot be represented by the PixelFormat or the current palette of the specified bitmapData.
- 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.
Boolean, if the operation completed successfully.
, if the operation has been canceled and the
ThrowIfCanceled property
of the
parallelConfig parameter was
.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).
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
BeginMakeGrayscale
or
MakeGrayscaleAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
This method transforms the bitmapData in place (its original content will be overwritten). To return a new instance
use the ToGrayscale extension method, which returns a new instance,
or the Clone method with a grayscale
quantizer (PredefinedColorsQuantizer.Grayscale, for example).
If bitmapData has an indexed PixelFormat and ditherer is ,
then its palette entries are tried to be transformed instead of the actual pixels in the first place (if it is supported by bitmapData).
To transform the colors of an indexed IBitmapData without changing the palette specify a non- ditherer.
Transforming the palette is both faster and provides a better result.
If ditherer is , this method attempts to preserve the original color depth, including wide pixel formats.
The ditherer may have no effect for KnownPixelFormats with more than 16 bits-per-pixel and for grayscale formats.
