BitmapDataExtensionsInvert(IReadWriteBitmapData, IDitherer, ParallelConfig) Method

Inverts the colors 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 bool Invert(
	this IReadWriteBitmapData bitmapData,
	IDitherer? ditherer,
	ParallelConfig? parallelConfig
)

VB

<ExtensionAttribute>
Public Shared Function Invert ( 
	bitmapData As IReadWriteBitmapData,
	ditherer As IDitherer,
	parallelConfig As ParallelConfig
) As Boolean

C++

public:
[ExtensionAttribute]
static bool Invert(
	IReadWriteBitmapData^ bitmapData, 
	IDitherer^ ditherer, 
	ParallelConfig^ parallelConfig
)

F#

[<ExtensionAttribute>]
static member Invert : 
        bitmapData : IReadWriteBitmapData * 
        ditherer : IDitherer * 
        parallelConfig : ParallelConfig -> bool

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to be inverted.
ditherer IDitherer: An optional IDitherer instance to dither the result of the transformation if the inverse of the bitmapData has no exact representation with its PixelFormat.
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

Boolean
, if the operation completed successfully.
, if the operation has been 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 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).

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 BeginInvert or InvertAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

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.

Tip

See the Examples section of the BitmapExtensions.Invert method for a couple of examples.