File: System\Drawing\Imaging\Effects\ColorMatrixEffect.cs
Web Access
Project: src\src\System.Drawing.Common\src\System.Drawing.Common.csproj (System.Drawing.Common)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
#if NET9_0_OR_GREATER
 
namespace System.Drawing.Imaging.Effects;
 
/// <summary>
///  Color matrix adjustment effect.
/// </summary>
/// <remarks>
///  <para>
///   See <see href="https://learn.microsoft.com/windows/win32/gdiplus/-gdiplus-recoloring-use">Recoloring</see>
///   for examples of using a color matrix to adjust the colors of an image.
///  </para>
/// </remarks>
public unsafe class ColorMatrixEffect : Effect
{
    private readonly ColorMatrix _matrix;
 
    /// <summary>
    ///  Creates a new <see cref="ColorMatrixEffect"/> with the given <paramref name="matrix"/>.
    /// </summary>
    /// <param name="matrix">Color transform matrix.</param>
    public ColorMatrixEffect(ColorMatrix matrix) : base(PInvoke.ColorMatrixEffectGuid)
    {
        fixed (float* p = &matrix.GetPinnableReference())
        {
            PInvokeGdiPlus.GdipSetEffectParameters(NativeEffect, p, (uint)sizeof(GdiPlus.ColorMatrix)).ThrowIfFailed();
            GC.KeepAlive(this);
        }
 
        _matrix = matrix;
    }
 
    /// <summary>
    ///  The color transform matrix.
    /// </summary>
    /// <remarks>
    ///  <para>
    ///   <see cref="ColorMatrix"/> is mutable, but effects do not support changing the matrix after creation.
    ///  </para>
    /// </remarks>
    public ColorMatrix Matrix => _matrix;
}
#endif