Skip to content

Fill and review API documentation #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 1 commit into from
Closed

Fill and review API documentation #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<Type Name="SKGraphiteBackend" FullName="SkiaSharp.SKGraphiteBackend">
<TypeSignature Language="C#" Value="public enum SKGraphiteBackend" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SKGraphiteBackend extends System.Enum" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKGraphiteBackend" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Identifies the graphics backend that drives a Skia Graphite context.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Graphite is Skia's next-generation GPU renderer; the value selects which native API a
<xref:SkiaSharp.SKGraphiteContext> is bound to.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Dawn">
<MemberSignature Language="C#" Value="Dawn" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteBackend Dawn = int32(0)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteBackend.Dawn" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteBackend</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>The Dawn backend, which targets WebGPU (Direct3D, Metal, or Vulkan depending on the platform).</summary>
</Docs>
</Member>
<Member MemberName="Metal">
<MemberSignature Language="C#" Value="Metal" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteBackend Metal = int32(1)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteBackend.Metal" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteBackend</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The Apple Metal backend.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
<MemberSignature Language="C#" Value="Unknown" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteBackend Unknown = int32(-1)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteBackend.Unknown" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteBackend</ReturnType>
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>The backend is not known or has not been set.</summary>
</Docs>
</Member>
<Member MemberName="Vulkan">
<MemberSignature Language="C#" Value="Vulkan" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteBackend Vulkan = int32(2)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteBackend.Vulkan" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteBackend</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>The Vulkan backend.</summary>
</Docs>
</Member>
</Members>
</Type>
120 changes: 120 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<Type Name="SKGraphiteInsertStatus" FullName="SkiaSharp.SKGraphiteInsertStatus">
<TypeSignature Language="C#" Value="public enum SKGraphiteInsertStatus" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SKGraphiteInsertStatus extends System.Enum" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKGraphiteInsertStatus" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Describes the outcome of inserting a <see cref="T:SkiaSharp.SKGraphiteRecording" /> into a <see cref="T:SkiaSharp.SKGraphiteContext" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddCommandsFailed">
<MemberSignature Language="C#" Value="AddCommandsFailed" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus AddCommandsFailed = int32(3)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.AddCommandsFailed" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>The backend failed to record the commands from the recording.</summary>
</Docs>
</Member>
<Member MemberName="AsyncShaderCompilesFailed">
<MemberSignature Language="C#" Value="AsyncShaderCompilesFailed" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus AsyncShaderCompilesFailed = int32(4)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.AsyncShaderCompilesFailed" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>One or more asynchronous shader compilations required by the recording failed.</summary>
</Docs>
</Member>
<Member MemberName="InvalidRecording">
<MemberSignature Language="C#" Value="InvalidRecording" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus InvalidRecording = int32(1)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.InvalidRecording" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The supplied <see cref="T:SkiaSharp.SKGraphiteRecording" /> was not valid.</summary>
</Docs>
</Member>
<Member MemberName="OutOfOrderRecording">
<MemberSignature Language="C#" Value="OutOfOrderRecording" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus OutOfOrderRecording = int32(5)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.OutOfOrderRecording" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>The recording was submitted out of order relative to its recorder's history.</summary>
</Docs>
</Member>
<Member MemberName="PromiseInstantiationFailed">
<MemberSignature Language="C#" Value="PromiseInstantiationFailed" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus PromiseInstantiationFailed = int32(2)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.PromiseInstantiationFailed" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>A promise image referenced by the recording failed to instantiate.</summary>
</Docs>
</Member>
<Member MemberName="Success">
<MemberSignature Language="C#" Value="Success" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKGraphiteInsertStatus Success = int32(0)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKGraphiteInsertStatus.Success" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKGraphiteInsertStatus</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>The recording was inserted successfully.</summary>
</Docs>
</Member>
</Members>
</Type>
52 changes: 52 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<Type Name="SKImageRescaleGamma" FullName="SkiaSharp.SKImageRescaleGamma">
<TypeSignature Language="C#" Value="public enum SKImageRescaleGamma" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SKImageRescaleGamma extends System.Enum" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKImageRescaleGamma" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Selects the gamma color space used while rescaling an <see cref="T:SkiaSharp.SKImage" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Linear">
<MemberSignature Language="C#" Value="Linear" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleGamma Linear = int32(1)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleGamma.Linear" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleGamma</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Convert to a linear color space, rescale, and convert back for higher-quality results.</summary>
</Docs>
</Member>
<Member MemberName="Src">
<MemberSignature Language="C#" Value="Src" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleGamma Src = int32(0)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleGamma.Src" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleGamma</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Perform the rescale in the source image's gamma-encoded color space.</summary>
</Docs>
</Member>
</Members>
</Type>
86 changes: 86 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<Type Name="SKImageRescaleMode" FullName="SkiaSharp.SKImageRescaleMode">
<TypeSignature Language="C#" Value="public enum SKImageRescaleMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SKImageRescaleMode extends System.Enum" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKImageRescaleMode" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Selects the sampling algorithm used when rescaling an <see cref="T:SkiaSharp.SKImage" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Linear">
<MemberSignature Language="C#" Value="Linear" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleMode Linear = int32(1)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleMode.Linear" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleMode</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Rescale using a single bilinear step.</summary>
</Docs>
</Member>
<Member MemberName="Nearest">
<MemberSignature Language="C#" Value="Nearest" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleMode Nearest = int32(0)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleMode.Nearest" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleMode</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Rescale using nearest-neighbor sampling.</summary>
</Docs>
</Member>
<Member MemberName="RepeatedCubic">
<MemberSignature Language="C#" Value="RepeatedCubic" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleMode RepeatedCubic = int32(3)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleMode.RepeatedCubic" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleMode</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Rescale by repeatedly halving (or doubling) with bicubic filtering until the target size is reached.</summary>
</Docs>
</Member>
<Member MemberName="RepeatedLinear">
<MemberSignature Language="C#" Value="RepeatedLinear" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKImageRescaleMode RepeatedLinear = int32(2)" />
<MemberSignature Language="DocId" Value="F:SkiaSharp.SKImageRescaleMode.RepeatedLinear" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.152.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageRescaleMode</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Rescale by repeatedly halving (or doubling) with bilinear filtering until the target size is reached.</summary>
</Docs>
</Member>
</Members>
</Type>