SKManagedPixelSerializer.xml

<Type Name="SKManagedPixelSerializer" FullName="SkiaSharp.SKManagedPixelSerializer">
  <TypeSignature Language="C#" Value="public abstract class SKManagedPixelSerializer : SkiaSharp.SKPixelSerializer" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract SKManagedPixelSerializer extends SkiaSharp.SKPixelSerializer" FrameworkAlternate="skiasharp-1.60" />
  <TypeSignature Language="DocId" Value="T:SkiaSharp.SKManagedPixelSerializer" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SKManagedPixelSerializer extends SkiaSharp.SKPixelSerializer" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
  <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.SKPixelSerializer</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">
      <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
    </Attribute>
    <Attribute FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">
      <AttributeName Language="C#">[System.Obsolete]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Represents a mechanism for serializing pixels.</summary>
    <remarks></remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SKManagedPixelSerializer ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKManagedPixelSerializer.#ctor" />
      <MemberType>Constructor</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>
      <Parameters />
      <Docs>
        <summary>Creates a new instance of <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> with an empty buffer.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="OnEncode">
      <MemberSignature Language="C#" Value="protected abstract SkiaSharp.SKData OnEncode (SkiaSharp.SKPixmap pixmap);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class SkiaSharp.SKData OnEncode(class SkiaSharp.SKPixmap pixmap) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKManagedPixelSerializer.OnEncode(SkiaSharp.SKPixmap)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>SkiaSharp.SKData</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" Index="0" FrameworkAlternate="skiasharp-1.60" />
      </Parameters>
      <Docs>
        <param name="pixmap">The pixel data to encode.</param>
        <summary>Implemented by derived <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> types to encode the specified pixel data.</summary>
        <returns>Returns the encoded pixel data, or <see langword="null" /> if the raw pixels should be used.</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="OnUseEncodedData">
      <MemberSignature Language="C#" Value="protected abstract bool OnUseEncodedData (IntPtr data, IntPtr length);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnUseEncodedData(native int data, native int length) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKManagedPixelSerializer.OnUseEncodedData(System.IntPtr,System.IntPtr)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>SkiaSharp</AssemblyName>
        <AssemblyVersion>1.60.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="data" Type="System.IntPtr" Index="0" FrameworkAlternate="skiasharp-1.60" />
        <Parameter Name="length" Type="System.IntPtr" Index="1" FrameworkAlternate="skiasharp-1.60" />
      </Parameters>
      <Docs>
        <param name="data">The encoded data buffer.</param>
        <param name="length">The length of the encoded data buffer.</param>
        <summary>Implemented by derived <see cref="T:SkiaSharp.SKManagedPixelSerializer" /> types to determine whether the caller should use the specified encoded data instead of encoding a new version.</summary>
        <returns>Returns <see langword="true" /> if the specified encoded data should be used, otherwise <see langword="false" /> to serialize another version.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[
## Remarks

If this method returns `true`, then
<xref:SkiaSharp.SKPixelSerializer.Encode%2A> should not be called to encode
the source data.
]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>