SKAutoCanvasRestore.xml

<Type Name="SKAutoCanvasRestore" FullName="SkiaSharp.SKAutoCanvasRestore">
  <TypeSignature Language="C#" Value="public class SKAutoCanvasRestore : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SKAutoCanvasRestore extends System.Object implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:SkiaSharp.SKAutoCanvasRestore" />
  <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>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>Convenience class used to restore the canvas state in a using statement.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[
## Remarks

This class can be used in a using statement to save the state of the canvas
(matrix, clip and draw filter) allowing you to change these components and have
them automatically undone by virtue of having the
<xref:SkiaSharp.SKAutoCanvasRestore.Dispose> method restore the canvas state to
the state it was when this instance was created.

## Examples

```csharp
SKCanvas canvas = ...;

using (new SKAutoCanvasRestore(canvas)) {
    // perform some transform
    canvas.RotateDegrees(45);

    // draw as usual
    var paint = new SKPaint ();
    canavs.DrawRect (10, 10, 100, 100, paint);

    // automatically restore to original transform
}
```
]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SKAutoCanvasRestore (SkiaSharp.SKCanvas canvas);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class SkiaSharp.SKCanvas canvas) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKAutoCanvasRestore.#ctor(SkiaSharp.SKCanvas)" />
      <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>
        <Parameter Name="canvas" Type="SkiaSharp.SKCanvas" />
      </Parameters>
      <Docs>
        <param name="canvas">The canvas whose state will be preserved.</param>
        <summary>Creates a canvas restore point, invoking the <see cref="M:SkiaSharp.SKCanvas.Save" /> method.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SKAutoCanvasRestore (SkiaSharp.SKCanvas canvas, bool doSave);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class SkiaSharp.SKCanvas canvas, bool doSave) cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKAutoCanvasRestore.#ctor(SkiaSharp.SKCanvas,System.Boolean)" />
      <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>
        <Parameter Name="canvas" Type="SkiaSharp.SKCanvas" />
        <Parameter Name="doSave" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="canvas">The canvas whose state will be preserved.</param>
        <param name="doSave">Whether or not to invoke <see cref="M:SkiaSharp.SKCanvas.Save" /> method at this point.</param>
        <summary>Creates a canvas restore point.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKAutoCanvasRestore.Dispose" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <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 />
      <Docs>
        <summary>
          <para>Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was created.</para>
          <para>This operation will not do anything if you had previously manually called the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Restore" /> method.</para>
        </summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Restore">
      <MemberSignature Language="C#" Value="public void Restore ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Restore() cil managed" />
      <MemberSignature Language="DocId" Value="M:SkiaSharp.SKAutoCanvasRestore.Restore" />
      <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 />
      <Docs>
        <summary>Restores the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd.</summary>
        <remarks></remarks>
      </Docs>
    </Member>
  </Members>
</Type>