SKColorFilter.xml

<Type Name="SKColorFilter" FullName="SkiaSharp.SKColorFilter">
  <TypeSignature Language="C#" Value="public class SKColorFilter : SkiaSharp.SKObject" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SKColorFilter extends SkiaSharp.SKObject" />
  <TypeSignature Language="DocId" Value="T:SkiaSharp.SKColorFilter" />
  <AssemblyInfo>
    <AssemblyName>SkiaSharp</AssemblyName>
    <AssemblyVersion>1.60.0.0</AssemblyVersion>
    <AssemblyVersion>1.68.0.0</AssemblyVersion>
    <AssemblyVersion>2.80.0.0</AssemblyVersion>
    <AssemblyVersion>2.88.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>SkiaSharp.SKObject</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Color filters for use with the <see cref="P:SkiaSharp.SKPaint.ColorFilter" /> property of a <see cref="T:SkiaSharp.SKPaint" />.</summary>
    <remarks></remarks>
  </Docs>
  <Members>
    <Member MemberName="ColorMatrixSize">
      <MemberSignature Language="C#" Value="public const int ColorMatrixSize = 20;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 ColorMatrixSize = (20)" />
      <MemberSignature Language="DocId" Value="F:SkiaSharp.SKColorFilter.ColorMatrixSize" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>20</MemberValue>
      <Docs>
        <summary>The size of the color matrix.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateBlendMode">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateBlendMode (SkiaSharp.SKColor c, SkiaSharp.SKBlendMode mode);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateBlendMode(valuetype SkiaSharp.SKColor c, valuetype SkiaSharp.SKBlendMode mode) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateBlendMode(SkiaSharp.SKColor,SkiaSharp.SKBlendMode)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="c" Type="SkiaSharp.SKColor" />
        <Parameter Name="mode" Type="SkiaSharp.SKBlendMode" />
      </Parameters>
      <Docs>
        <param name="c">The source color used with the specified mode.</param>
        <param name="mode">The blend mode mode that is applied to each color.</param>
        <summary>Creates a new color filter that uses the specified color and mode.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />, or <see langword="null" /> if the mode will have no effect.</returns>
        <remarks>If the <paramref name="mode" /> is <see cref="F:SkiaSharp.SKBlendMode.Dst" />, this function will return <see langword="null" /> (since that mode will have no effect on the result).</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateColorMatrix">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateColorMatrix (float[] matrix);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateColorMatrix(float32[] matrix) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateColorMatrix(System.Single[])" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="matrix" Type="System.Single[]" />
      </Parameters>
      <Docs>
        <param name="matrix">An array of <see cref="F:SkiaSharp.SKColorFilter.ColorMatrixSize" /> elements.</param>
        <summary>Creates a new color filter that transforms a color by a 4x5 (row-major) matrix.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks>The matrix is in row-major order and the translation column is specified in unnormalized, 0...255, space.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateCompose">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateCompose (SkiaSharp.SKColorFilter outer, SkiaSharp.SKColorFilter inner);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateCompose(class SkiaSharp.SKColorFilter outer, class SkiaSharp.SKColorFilter inner) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateCompose(SkiaSharp.SKColorFilter,SkiaSharp.SKColorFilter)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="outer" Type="SkiaSharp.SKColorFilter" />
        <Parameter Name="inner" Type="SkiaSharp.SKColorFilter" />
      </Parameters>
      <Docs>
        <param name="outer">The outer (second) filter to apply.</param>
        <param name="inner">The inner (first) filter to apply.</param>
        <summary>Creates a new composition color filter, whose effect is to first apply the inner filter and then apply the outer filter to the result of the inner.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateHighContrast">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateHighContrast (SkiaSharp.SKHighContrastConfig config);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateHighContrast(valuetype SkiaSharp.SKHighContrastConfig config) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateHighContrast(SkiaSharp.SKHighContrastConfig)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="config" Type="SkiaSharp.SKHighContrastConfig" />
      </Parameters>
      <Docs>
        <param name="config">The high contrast configuration settings.</param>
        <summary>Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks>Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateHighContrast">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateHighContrast (bool grayscale, SkiaSharp.SKHighContrastConfigInvertStyle invertStyle, float contrast);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateHighContrast(bool grayscale, valuetype SkiaSharp.SKHighContrastConfigInvertStyle invertStyle, float32 contrast) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateHighContrast(System.Boolean,SkiaSharp.SKHighContrastConfigInvertStyle,System.Single)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="grayscale" Type="System.Boolean" />
        <Parameter Name="invertStyle" Type="SkiaSharp.SKHighContrastConfigInvertStyle" />
        <Parameter Name="contrast" Type="System.Single" />
      </Parameters>
      <Docs>
        <param name="grayscale">Whether or not the color will be converted to grayscale.</param>
        <param name="invertStyle">Whether or not to invert brightness, lightness, or neither.</param>
        <param name="contrast">The amount to adjust the contrast by, in the range -1.0 through 1.0.</param>
        <summary>Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks>Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateLighting">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateLighting (SkiaSharp.SKColor mul, SkiaSharp.SKColor add);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateLighting(valuetype SkiaSharp.SKColor mul, valuetype SkiaSharp.SKColor add) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateLighting(SkiaSharp.SKColor,SkiaSharp.SKColor)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="mul" Type="SkiaSharp.SKColor" />
        <Parameter Name="add" Type="SkiaSharp.SKColor" />
      </Parameters>
      <Docs>
        <param name="mul">The color to multiply the source color by. The alpha component is ignored.</param>
        <param name="add">The color to add to the source color. The alpha component is ignored.</param>
        <summary>Creates a new lighting color filter that multiplies the RGB channels by one color, and then adds a second color, pinning the result for each component to [0..255].</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateLumaColor">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateLumaColor ();" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateLumaColor() cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateLumaColor" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Creates a new luminance-to-alpha color filter.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateTable">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateTable (byte[] table);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateTable(unsigned int8[] table) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateTable(System.Byte[])" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="table" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="table">The table of values for each color component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
        <summary>Creates a new table color filter.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateTable">
      <MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateTable (byte[] tableA, byte[] tableR, byte[] tableG, byte[] tableB);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateTable(unsigned int8[] tableA, unsigned int8[] tableR, unsigned int8[] tableG, unsigned int8[] tableB) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateTable(System.Byte[],System.Byte[],System.Byte[],System.Byte[])" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKColorFilter</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tableA" Type="System.Byte[]" />
        <Parameter Name="tableR" Type="System.Byte[]" />
        <Parameter Name="tableG" Type="System.Byte[]" />
        <Parameter Name="tableB" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="tableA">The table of values for the alpha component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
        <param name="tableR">The table of values for the red component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
        <param name="tableG">The table of values for the green component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
        <param name="tableB">The table of values for the blue component, with a length of <see cref="F:SkiaSharp.SKColorTable.MaxLength" />.</param>
        <summary>Creates a new table color filter.</summary>
        <returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.Dispose(System.Boolean)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">
          <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
        <summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKColorFilter" /> and optionally releases the managed resources.</summary>
        <remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKColorFilter" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TableMaxLength">
      <MemberSignature Language="C#" Value="public const int TableMaxLength = 256;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 TableMaxLength = (256)" />
      <MemberSignature Language="DocId" Value="F:SkiaSharp.SKColorFilter.TableMaxLength" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.68.0.0</AssemblyVersion>
        <AssemblyVersion>2.80.0.0</AssemblyVersion>
        <AssemblyVersion>2.88.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>256</MemberValue>
      <Docs>
        <summary>The size of a color table for a color component.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
  </Members>
</Type>