BitmapExtensionsMakeGrayscale Method

Makes a bitmap grayscale.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 9.2.0

C#

public static void MakeGrayscale(
	this Bitmap bitmap,
	IDitherer? ditherer = null
)

VB

<ExtensionAttribute>
Public Shared Sub MakeGrayscale ( 
	bitmap As Bitmap,
	Optional ditherer As IDitherer = Nothing
)

C++

public:
[ExtensionAttribute]
static void MakeGrayscale(
	Bitmap^ bitmap, 
	IDitherer^ ditherer = nullptr
)

F#

[<ExtensionAttribute>]
static member MakeGrayscale : 
        bitmap : Bitmap * 
        ?ditherer : IDitherer 
(* Defaults:
        let _ditherer = defaultArg ditherer null
*)
-> unit

Parameters

bitmap Bitmap: The Bitmap to make grayscale.
ditherer IDitherer (Optional): An optional IDitherer instance to dither the result if grayscale colors cannot be represented by the PixelFormat or the current palette of the specified bitmap. 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 Bitmap. 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 BitmapDataExtensions.BeginMakeGrayscale or BitmapDataExtensions.MakeGrayscaleAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

This method transforms the bitmap in place (its original content will be overwritten). To return a new instance use the ToGrayscale extension method, which always returns a bitmap with Format32bppArgb format, or the ConvertPixelFormat method with a grayscale quantizer (PredefinedColorsQuantizer.Grayscale, for example).

If bitmap has an indexed PixelFormat and ditherer is , then its palette entries will be transformed instead of the actual pixels. To transform the colors of an indexed Bitmap without changing the palette specify a non- ditherer. Transforming the palette is both faster and provides a better result.

The ditherer is ignored for PixelFormats with more than 16 bits-per-pixel and for the Format16bppGrayScale format.

BitmapExtensionsMakeGrayscale Method

Definition

Parameters

Usage Note

Remarks

See Also

Reference