BitmapDataExtensionsTransformColors(IReadWriteBitmapData, FuncColor64, Color64, 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<Color64, Color64> transformFunction,
ParallelConfig? parallelConfig = null
)
<ExtensionAttribute>
Public Shared Function TransformColors (
bitmapData As IReadWriteBitmapData,
transformFunction As Func(Of Color64, Color64),
Optional parallelConfig As ParallelConfig = Nothing
) As Boolean
public:
[ExtensionAttribute]
static bool TransformColors(
IReadWriteBitmapData^ bitmapData,
Func<Color64, Color64>^ transformFunction,
ParallelConfig^ parallelConfig = nullptr
)
[<ExtensionAttribute>]
static member TransformColors :
bitmapData : IReadWriteBitmapData *
transformFunction : Func<Color64, Color64> *
?parallelConfig : ParallelConfig
(* Defaults:
let _parallelConfig = defaultArg parallelConfig null
*)
-> bool
- bitmapData IReadWriteBitmapData
- The IReadWriteBitmapData to be transformed.
- transformFunction FuncColor64, Color64
- The transform function to be used on the colors of the specified bitmapData. It must be thread-safe.
- parallelConfig ParallelConfig (Optional)
- 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. This parameter is optional.
Default value: .
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, FuncColor64, Color64, AsyncConfig)
or
TransformColorsAsync(IReadWriteBitmapData, FuncColor64, Color64, TaskConfig) (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
If bitmapData has an indexed PixelFormat and it supports setting the Palette, then its palette entries will be transformed instead of the actual pixels.
Though for indexed formats it's preferred to use the TransformColors(IReadWriteBitmapData, FuncColor32, Color32) overload instead.
On multi-core systems transformFunction might be called concurrently so it must be thread-safe.
See the
Examples section of the
BitmapExtensions.TransformColors method for an example.
