BitmapDataExtensionsToGrayscale(IReadableBitmapData, ParallelConfig) Method

Returns a new IReadWriteBitmapData, which is the grayscale version of the specified bitmapData.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
C#
public static IReadWriteBitmapData? ToGrayscale(
	this IReadableBitmapData bitmapData,
	ParallelConfig? parallelConfig
)

Parameters

bitmapData  IReadableBitmapData
The IReadableBitmapData to convert to grayscale.
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.

Return Value

IReadWriteBitmapData
An IReadWriteBitmapData containing the grayscale version of the original bitmapData, or , if the operation was canceled and the ThrowIfCanceled property of the parallelConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadableBitmapData. 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 blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginToGrayscale or ToGrayscaleAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

This method always returns a new IReadWriteBitmapData with a pixel format matching the original color depth.

To make an IReadWriteBitmapData grayscale without creating a new instance use the MakeGrayscale method.

See Also