BitmapDataExtensionsTransformColors(IReadWriteBitmapData, FuncColor32, Color32, IDitherer, ParallelConfig) Method
Transforms the colors of this bitmapData using the specified transformFunction delegate.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.2
public static bool TransformColors(
this IReadWriteBitmapData bitmapData,
Func<Color32, Color32> transformFunction,
IDitherer? ditherer,
ParallelConfig? parallelConfig
)
<ExtensionAttribute>
Public Shared Function TransformColors (
bitmapData As IReadWriteBitmapData,
transformFunction As Func(Of Color32, Color32),
ditherer As IDitherer,
parallelConfig As ParallelConfig
) As Boolean
public:
[ExtensionAttribute]
static bool TransformColors(
IReadWriteBitmapData^ bitmapData,
Func<Color32, Color32>^ transformFunction,
IDitherer^ ditherer,
ParallelConfig^ parallelConfig
)
[<ExtensionAttribute>]
static member TransformColors :
bitmapData : IReadWriteBitmapData *
transformFunction : Func<Color32, Color32> *
ditherer : IDitherer *
parallelConfig : ParallelConfig -> bool
- bitmapData IReadWriteBitmapData
- The IReadWriteBitmapData to be transformed.
- transformFunction FuncColor32, Color32
- The transform function to be used on the colors of the specified bitmapData. It must be thread-safe.
- ditherer IDitherer
- An optional IDitherer instance to dither the result of the transformation if transformFunction returns colors
that is not compatible with the PixelFormat 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
BeginTransformColors(IReadWriteBitmapData, FuncColor32, Color32, IDitherer, AsyncConfig)
or
TransformColorsAsync(IReadWriteBitmapData, FuncColor32, Color32, IDitherer, TaskConfig) (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 Clone extension method
with an IQuantizer instance created by the PredefinedColorsQuantizer.FromCustomFunction method.
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.
On multi-core systems transformFunction might be called concurrently so it must be thread-safe.
The ditherer is ignored for KnownPixelFormats with more than 16 bits-per-pixel and for grayscale formats.
See the
Examples section of the
BitmapExtensions.TransformColors method for an example.
