Skip to content

Fill and review API documentation #185

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fill and review API documentation #185

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
84 changes: 51 additions & 33 deletions SkiaSharpAPI/SkiaSharp/GRContext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<TypeSignature Language="DocId" Value="T:SkiaSharp.GRContext" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>SkiaSharp.GRRecordingContext</BaseTypeName>
Expand All @@ -22,7 +22,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -43,7 +43,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRBackend</ReturnType>
Expand All @@ -54,14 +54,32 @@
<remarks />
</Docs>
</Member>
<Member MemberName="CheckAsyncWorkCompletion">
<MemberSignature Language="C#" Value="public void CheckAsyncWorkCompletion ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CheckAsyncWorkCompletion() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRContext.CheckAsyncWorkCompletion" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Polls for completion of pending asynchronous GPU work submitted through this context and dispatches any callbacks that are ready.</summary>
<remarks>Callbacks queued by operations such as <see cref="M:SkiaSharp.SKImage.RequestReadPixels(SkiaSharp.SKImageInfo,SkiaSharp.SKRectI,System.Action{SkiaSharp.SKImageReadPixelsResult})" /> only fire when the context is given a chance to observe that the GPU has finished; call this method (typically once per frame) to drive that dispatch.</remarks>
</Docs>
</Member>
<Member MemberName="CreateDirect3D">
<MemberSignature Language="C#" Value="public static SkiaSharp.GRContext CreateDirect3D (SkiaSharp.GRD3DBackendContext backendContext);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.GRContext CreateDirect3D(class SkiaSharp.GRD3DBackendContext backendContext) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRContext.CreateDirect3D(SkiaSharp.GRD3DBackendContext)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -83,7 +101,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -107,7 +125,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -126,7 +144,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -148,7 +166,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -170,7 +188,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -194,7 +212,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -216,7 +234,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -240,7 +258,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -262,7 +280,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContext</ReturnType>
Expand All @@ -286,7 +304,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -308,7 +326,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -326,7 +344,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -347,7 +365,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -365,7 +383,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -386,7 +404,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -407,7 +425,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -432,7 +450,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
Expand All @@ -454,7 +472,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
Expand All @@ -473,7 +491,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -496,7 +514,7 @@
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
Expand All @@ -515,7 +533,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -533,7 +551,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -555,7 +573,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -579,7 +597,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -600,7 +618,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -621,7 +639,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -642,7 +660,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -663,7 +681,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -684,7 +702,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand Down
27 changes: 21 additions & 6 deletions SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<TypeSignature Language="DocId" Value="T:SkiaSharp.GRVkExtensions" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>SkiaSharp.SKObject</BaseTypeName>
Expand All @@ -15,14 +15,29 @@
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GRVkExtensions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRVkExtensions.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Creates a new, empty Vulkan extensions collection. Call <see cref="M:SkiaSharp.GRVkExtensions.Initialize(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr,System.String[],System.String[])" /> to populate it before use.</summary>
<remarks>Prefer <see cref="M:SkiaSharp.GRVkExtensions.Create(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr,System.String[],System.String[])" /> when the instance and device extension lists are already known; it constructs and initializes the collection in a single call.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static SkiaSharp.GRVkExtensions Create (SkiaSharp.GRVkGetProcedureAddressDelegate getProc, IntPtr vkInstance, IntPtr vkPhysicalDevice, string[] instanceExtensions, string[] deviceExtensions);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.GRVkExtensions Create(class SkiaSharp.GRVkGetProcedureAddressDelegate getProc, native int vkInstance, native int vkPhysicalDevice, string[] instanceExtensions, string[] deviceExtensions) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRVkExtensions.Create(SkiaSharp.GRVkGetProcedureAddressDelegate,System.IntPtr,System.IntPtr,System.String[],System.String[])" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRVkExtensions</ReturnType>
Expand Down Expand Up @@ -52,7 +67,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -70,7 +85,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -93,7 +108,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -118,7 +133,7 @@
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
<AssemblyVersion>4.151.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand Down
Loading