Added some more documentation.
This commit is contained in:
Matthew Leibowitz
Родитель
4e0e190822
Коммит
8e20cc0e7d
|
|
@ -236,6 +236,10 @@ Task ("samples")
|
|||
Task ("docs")
|
||||
.Does (() =>
|
||||
{
|
||||
// log TODOs
|
||||
var docFiles = FindTextInFiles ("./docs/**/*.xml", "To be added.");
|
||||
Information ("Documentation missing in {0} files.", docFiles.Length);
|
||||
|
||||
if (!DirectoryExists ("./output/docs/msxml/")) CreateDirectory ("./output/docs/msxml/");
|
||||
RunMdocMSXml (DOCS_PATH, "./output/docs/msxml/");
|
||||
|
||||
|
|
|
|||
|
|
@ -33,8 +33,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The color format.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Height">
|
||||
|
|
@ -51,8 +55,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The height in pixels.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Origin">
|
||||
|
|
@ -69,8 +77,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The pixel origin.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RenderTargetHandle">
|
||||
|
|
@ -86,8 +98,10 @@
|
|||
<ReturnType>System.IntPtr</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>Handle to the 3D API object.</summary>
|
||||
<value>To be added.</value>
|
||||
<summary>The handle to the 3D API object.</summary>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>When using OpenGL, it is the FBO ID.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -105,7 +119,9 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary> The number of samples per pixel.</summary>
|
||||
<value>To be added.</value>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>This is used to influence decisions about applying other forms of anti-aliasing.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -122,9 +138,13 @@
|
|||
<ReturnType>System.Int32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>Number of bits of stencil per-pixel.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>The number of bits of stencil per-pixel.</summary>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Width">
|
||||
|
|
@ -141,8 +161,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The width in pixels.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -34,8 +34,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The color format.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Flags">
|
||||
|
|
@ -70,8 +74,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The height in pixels.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Origin">
|
||||
|
|
@ -88,8 +96,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The pixel origin.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SampleCount">
|
||||
|
|
@ -106,7 +118,9 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary> The number of samples per pixel.</summary>
|
||||
<value>To be added.</value>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>If the render target flag is set and sample count is greater than 0, then an MSAA buffer that resolves to the texture will be created.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -124,7 +138,9 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>Handle to the 3D API object.</summary>
|
||||
<value>To be added.</value>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>When using OpenGL, it is the Texture ID.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -142,8 +158,12 @@
|
|||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>The width in pixels.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -12,8 +12,10 @@
|
|||
</Base>
|
||||
<Interfaces />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Represents an underlying backend 3D API context.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="AbandonContext">
|
||||
|
|
@ -32,9 +34,9 @@
|
|||
<Parameter Name="releaseResources" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="releaseResources">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="releaseResources">Use true to indicate that the underlying 3D context is not yet lost and the <see cref="T:SkiaSharp.GRContext" /> will cleanup all allocated resources before returning. Using false will ensure that the destructors of the <see cref="T:SkiaSharp.GRContext" /> and any of its created resource objects will not make backend 3D API calls.</param>
|
||||
<summary>Abandons all GPU resources and assumes the underlying backend 3D API context is not longer usable. After returning it will assume that the underlying context may no longer be valid.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Create">
|
||||
|
|
@ -53,10 +55,12 @@
|
|||
<Parameter Name="backend" Type="SkiaSharp.GRBackend" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="backend">To be added.</param>
|
||||
<summary>Creates a GRContext for a backend context.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="backend">The backend to use.</param>
|
||||
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context using the default interface for the specified backend.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Create">
|
||||
|
|
@ -76,11 +80,13 @@
|
|||
<Parameter Name="backendContext" Type="SkiaSharp.GRGlInterface" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="backend">To be added.</param>
|
||||
<param name="backendContext">To be added.</param>
|
||||
<summary>Creates a GRContext for a backend context.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="backend">The backend to use.</param>
|
||||
<param name="backendContext">The backend interface to use.</param>
|
||||
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Create">
|
||||
|
|
@ -100,11 +106,13 @@
|
|||
<Parameter Name="backendContext" Type="System.IntPtr" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="backend">To be added.</param>
|
||||
<param name="backendContext">To be added.</param>
|
||||
<summary>Creates a GRContext for a backend context.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="backend">The backend to use.</param>
|
||||
<param name="backendContext">The backend interface to use.</param>
|
||||
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Create">
|
||||
|
|
@ -125,12 +133,14 @@
|
|||
<Parameter Name="options" Type="SkiaSharp.GRContextOptions" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="backend">To be added.</param>
|
||||
<param name="backendContext">To be added.</param>
|
||||
<param name="options">To be added.</param>
|
||||
<summary>Creates a GRContext for a backend context.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="backend">The backend to use.</param>
|
||||
<param name="backendContext">The backend interface to use.</param>
|
||||
<param name="options">The context-creation options.</param>
|
||||
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Create">
|
||||
|
|
@ -151,12 +161,14 @@
|
|||
<Parameter Name="options" Type="SkiaSharp.GRContextOptions" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="backend">To be added.</param>
|
||||
<param name="backendContext">To be added.</param>
|
||||
<param name="options">To be added.</param>
|
||||
<summary>Creates a GRContext for a backend context.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="backend">The backend to use.</param>
|
||||
<param name="backendContext">The backend interface to use.</param>
|
||||
<param name="options">The context-creation options.</param>
|
||||
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Dispose">
|
||||
|
|
@ -192,8 +204,10 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Call to ensure all drawing to the context has been issued to the underlying 3D API.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Flush">
|
||||
|
|
@ -217,9 +231,11 @@
|
|||
<Parameter Name="flagsBitfield" Type="SkiaSharp.GRContextFlushBits" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="flagsBitfield">Flags that control the flushing behavior.</param>
|
||||
<param name="flagsBitfield">Flags that control the flushing behavior. (This is ignored)</param>
|
||||
<summary>Call to ensure all drawing to the context has been issued to the underlying 3D API.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetRecommendedSampleCount">
|
||||
|
|
@ -239,11 +255,11 @@
|
|||
<Parameter Name="dpi" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="config">To be added.</param>
|
||||
<param name="dpi">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="config">The configuration of the render target.</param>
|
||||
<param name="dpi">The display density in dots per inch.</param>
|
||||
<summary>Returns the recommended sample count for a render target when using this context.</summary>
|
||||
<returns>Returns the recommended sample count.</returns>
|
||||
<remarks>May return 0 if MSAA is not supported or recommended to be used by default.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetResourceCacheLimits">
|
||||
|
|
@ -263,10 +279,12 @@
|
|||
<Parameter Name="maxResourceBytes" Type="System.Int64&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="maxResources">To be added.</param>
|
||||
<param name="maxResourceBytes">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="maxResources">The maximum number of resources that can be held in the cache.</param>
|
||||
<param name="maxResourceBytes">The maximum number of bytes of video memory that can be held in the cache.</param>
|
||||
<summary>Returns the current GPU resource cache limits.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetResourceCacheUsage">
|
||||
|
|
@ -286,10 +304,12 @@
|
|||
<Parameter Name="maxResourceBytes" Type="System.Int64&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="maxResources">To be added.</param>
|
||||
<param name="maxResourceBytes">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="maxResources">The number of resources that are held in the cache.</param>
|
||||
<param name="maxResourceBytes">The total number of bytes of video memory held in the cache.</param>
|
||||
<summary>Returns the current GPU resource cache usage.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetResourceCacheLimits">
|
||||
|
|
@ -309,10 +329,10 @@
|
|||
<Parameter Name="maxResourceBytes" Type="System.Int64" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="maxResources">To be added.</param>
|
||||
<param name="maxResourceBytes">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="maxResources">The maximum number of resources that can be held in the cache.</param>
|
||||
<param name="maxResourceBytes">The maximum number of bytes of video memory that can be held in the cache.</param>
|
||||
<summary>Specify the GPU resource cache limits.</summary>
|
||||
<remarks>If the current cache exceeds either of these, it will be purged (LRU) to keep the cache within these limits.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -16,8 +16,12 @@
|
|||
</Attribute>
|
||||
</Attributes>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>
|
||||
<para></para>
|
||||
</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="Discard">
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@
|
|||
</Base>
|
||||
<Interfaces />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>The <see cref="T:SkiaSharp.GRGlInterface" /> is used to interface with OpenGL.</summary>
|
||||
<remarks>A <see cref="T:SkiaSharp.GRContext" /> does not interact directly with the underlying backend, instead it uses an OpenGL interface.</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="AssembleAngleInterface">
|
||||
|
|
@ -32,10 +32,12 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleAngleInterface">
|
||||
|
|
@ -55,11 +57,13 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="context">To be added.</param>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="context">The user data to use in the delegate.</param>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleGlesInterface">
|
||||
|
|
@ -78,10 +82,12 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an OpenGLES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleGlesInterface">
|
||||
|
|
@ -101,11 +107,13 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="context">To be added.</param>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="context">The user data to use in the delegate.</param>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an OpenGLES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleGlInterface">
|
||||
|
|
@ -124,10 +132,12 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleGlInterface">
|
||||
|
|
@ -147,11 +157,13 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="context">To be added.</param>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="context">The user data to use in the delegate.</param>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleInterface">
|
||||
|
|
@ -170,10 +182,12 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AssembleInterface">
|
||||
|
|
@ -193,11 +207,13 @@
|
|||
<Parameter Name="get" Type="SkiaSharp.GRGlGetProcDelegate" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="context">To be added.</param>
|
||||
<param name="get">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="context">The user data to use in the delegate.</param>
|
||||
<param name="get">The delegate used to locate entry points.</param>
|
||||
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Clone">
|
||||
|
|
@ -214,9 +230,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Returns a copy of the current interface.</summary>
|
||||
<returns>Returns a copy.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateDefaultInterface">
|
||||
|
|
@ -233,9 +251,9 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform-default OpenGL implementation.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>On Windows, this is typically ANGLE, on mobile it is typically OpenGLES and on desktop it is typically OpenGL.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateNativeAngleInterface">
|
||||
|
|
@ -252,9 +270,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the ANGLE OpenGL implementation.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateNativeGlInterface">
|
||||
|
|
@ -271,9 +291,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform OpenGL implementation.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateNativeInterface">
|
||||
|
|
@ -295,9 +317,15 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>
|
||||
<para></para>
|
||||
</summary>
|
||||
<returns>
|
||||
<para></para>
|
||||
</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Dispose">
|
||||
|
|
@ -337,10 +365,12 @@
|
|||
<Parameter Name="extension" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="extension">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="extension">The extension to check for.</param>
|
||||
<summary>Checks to see if the underlying OpenGL backend has the specified extension.</summary>
|
||||
<returns>Returns true if the backend has the extension, otherwise false.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Validate">
|
||||
|
|
@ -357,9 +387,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Validates that the <see cref="T:SkiaSharp.GRGlInterface" /> supports its advertised standard.</summary>
|
||||
<returns>Returns true if all the entry points are specified, and any required extensions exist.</returns>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -11,8 +11,10 @@
|
|||
<BaseTypeName>System.Enum</BaseTypeName>
|
||||
</Base>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Various pixel configurations supported.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="Alpha8">
|
||||
|
|
@ -28,7 +30,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>8-bit Alpha.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AlphaHalf">
|
||||
|
|
@ -44,7 +46,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Single 16-bit float channel.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Astc12x12">
|
||||
|
|
@ -60,7 +62,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>12x12 ASTC Compressed Data.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Bgra8888">
|
||||
|
|
@ -76,7 +78,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplied 32-bit channel. Byte order is BGRA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Etc1">
|
||||
|
|
@ -92,7 +94,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>ETC1 Compressed Data.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Index8">
|
||||
|
|
@ -108,7 +110,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>8-bit indexed color channel.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Latc">
|
||||
|
|
@ -124,7 +126,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>LATC/RGTC/3Dc/BC4 Compressed Data.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="R11Eac">
|
||||
|
|
@ -140,7 +142,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>R11 EAC Compressed Data. (Corresponds to section C.3.5 of the OpenGL 4.4 core profile spec)</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Rgb565">
|
||||
|
|
@ -156,7 +158,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>16-bit channel. Byte order is RGB.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Rgba4444">
|
||||
|
|
@ -172,7 +174,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplied 16-bit channel. Byte order is RGBA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Rgba8888">
|
||||
|
|
@ -188,7 +190,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplied 32-bit channel. Byte order is RGBA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RgbaFloat">
|
||||
|
|
@ -204,7 +206,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>32-bit channel. Byte order is RGBA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RgbaHalf">
|
||||
|
|
@ -220,7 +222,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>16-bit channel. Byte order is RGBA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Sbgra8888">
|
||||
|
|
@ -236,7 +238,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplied and sRGB. Byte order is BGRA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Srgba8888">
|
||||
|
|
@ -252,7 +254,7 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplied and sRGB. Byte order is RGBA.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Unknown">
|
||||
|
|
@ -268,7 +270,9 @@
|
|||
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
<para />
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -11,8 +11,10 @@
|
|||
<BaseTypeName>System.Enum</BaseTypeName>
|
||||
</Base>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>The origin of a texture.</summary>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="BottomLeft">
|
||||
|
|
@ -28,7 +30,7 @@
|
|||
<ReturnType>SkiaSharp.GRSurfaceOrigin</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Origin is at the bottom-left.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="TopLeft">
|
||||
|
|
@ -44,7 +46,7 @@
|
|||
<ReturnType>SkiaSharp.GRSurfaceOrigin</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Origin is at the top-left.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -16,10 +16,7 @@
|
|||
</Base>
|
||||
<Docs>
|
||||
<summary>Describes how to interpret the alpha component of a pixel.</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
</para>
|
||||
</remarks>
|
||||
<remarks />
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="Opaque">
|
||||
|
|
@ -80,7 +77,9 @@
|
|||
<ReturnType>SkiaSharp.SKAlphaType</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>
|
||||
<para />
|
||||
</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Unpremul">
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@
|
|||
<param name="doSave">Determines whether you want the <see cref="M:SkiaSharp.SKCanvas.Save" /> method to be invoked on your behalf at this point.</param>
|
||||
<summary>Creates a canvas restore point</summary>
|
||||
<remarks>
|
||||
<para />
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -69,7 +69,9 @@
|
|||
<Parameters />
|
||||
<Docs>
|
||||
<summary>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 creatd. This operation will not do anything if you had previously manually called the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Restore" /> method.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Restore">
|
||||
|
|
@ -91,7 +93,9 @@
|
|||
<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>To be added.</remarks>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -16,11 +16,10 @@
|
|||
</Base>
|
||||
<Interfaces />
|
||||
<Docs>
|
||||
<summary>Raster bitmap.</summary>
|
||||
<summary>The <see cref="T:SkiaSharp.SKBitmap" /> specifies a raster bitmap.</summary>
|
||||
<remarks>
|
||||
<para>This class specifies a raster bitmap. A bitmap has an integer width and height, and a format (colortype), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="T:SkiaSharp.SKCanvas" />, but they are also used to specify the target of a <see cref="T:SkiaSharp.SKCanvas" />' drawing operations.</para>
|
||||
<para>An SkBitmap exposes, which lets a caller write its pixels; the constness is considered to apply to the bitmap's configuration, not its contents.</para>
|
||||
<para>To retrive a pointer to the raw image data of the SKBitmap, call the <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> method, and then call the <see cref="M:SkiaSharp.SKBitmap.GetPixels" /> method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> method. The raw data is laid out in the format configured at the time that the SKBitmap was created.</para>
|
||||
<para>A bitmap has an integer width and height, and a format (colortype), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="T:SkiaSharp.SKCanvas" />, but they are also used to specify the target of a <see cref="T:SkiaSharp.SKCanvas" />' drawing operations.</para>
|
||||
<para>A <see cref="T:SkiaSharp.SKBitmap" /> exposes <see cref="M:SkiaSharp.SKBitmap.GetPixels" />, which lets a caller write its pixels. To retrive a pointer to the raw image data of the bitmap, call the <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> method, and then call the <see cref="M:SkiaSharp.SKBitmap.GetPixels" /> method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> method. The raw data is laid out in the format configured at the time that the bitmap was created.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
|
|
@ -40,11 +39,7 @@
|
|||
<Parameters />
|
||||
<Docs>
|
||||
<summary>Default construct creates a bitmap with zero width and height, and no pixels. Its colortype is set to <see cref="E:SkiaSharp.SKColorType.Unknown." /></summary>
|
||||
<remarks>
|
||||
<para>This constructor does not allocate a backing store for the bitmap.</para>
|
||||
<para>
|
||||
</para>
|
||||
</remarks>
|
||||
<remarks>This constructor does not allocate a backing store for the bitmap.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
@ -84,8 +79,8 @@
|
|||
<Parameter Name="ctable" Type="SkiaSharp.SKColorTable" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="info">Description of the desired image format.</param>
|
||||
<param name="ctable">Color lookup table</param>
|
||||
<param name="info">The description of the desired image format.</param>
|
||||
<param name="ctable">The color lookup table.</param>
|
||||
<summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification and a color table.</summary>
|
||||
<remarks>Use this method to create a bitmap that will use a color lookup table. The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array.</remarks>
|
||||
</Docs>
|
||||
|
|
@ -135,13 +130,9 @@
|
|||
<Docs>
|
||||
<param name="width">Desired width in pixels.</param>
|
||||
<param name="height">Desired height in pixels.</param>
|
||||
<param name="isOpaque">If true, sets the <see cref="T:SkiaSharp.SKAlphaType" /> to Opaque, otherwise it sets it to Premul</param>
|
||||
<param name="isOpaque">If true, sets the <see cref="T:SkiaSharp.SKAlphaType" /> to <see cref="F:SkiaSharp.SKAlphaType.Opaque" />, otherwise it sets it to <see cref="F:SkiaSharp.SKAlphaType.Premul" />.</param>
|
||||
<summary>Creates a bitmap with the given width, height and opacity with color type set to <see cref="E:SkiaSharp.SKColorType.N_32" /></summary>
|
||||
<remarks>
|
||||
<para>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</para>
|
||||
<para>
|
||||
</para>
|
||||
</remarks>
|
||||
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
@ -166,8 +157,8 @@
|
|||
<Docs>
|
||||
<param name="width">Desired width in pixels.</param>
|
||||
<param name="height">Desired height in pixels.</param>
|
||||
<param name="colorType">The desired color type.</param>
|
||||
<param name="alphaType">The desired alpha type.</param>
|
||||
<param name="colorType">The desired <see cref="T:SkiaSharp.SKColorType" />.</param>
|
||||
<param name="alphaType">The desired <see cref="T:SkiaSharp.SKAlphaType" />.</param>
|
||||
<summary>Creates a bitmap with the given width, height, color type and alpha type.</summary>
|
||||
<remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
|
||||
</Docs>
|
||||
|
|
@ -189,11 +180,8 @@
|
|||
<ReturnType>SkiaSharp.SKAlphaType</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>Returns the configured alpha type for the bitmap.</summary>
|
||||
<value>
|
||||
<para>
|
||||
</para>
|
||||
</value>
|
||||
<summary>Gets the configured <see cref="T:SkiaSharp.SKAlphaType" /> for the bitmap.</summary>
|
||||
<value>The configured <see cref="T:SkiaSharp.SKAlphaType" />.</value>
|
||||
<remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -214,9 +202,9 @@
|
|||
<ReturnType>System.Int32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Return the byte size of the pixels, based on the <see cref="P:SkiaSharp.SKBitmap.Height" /> and <see cref="P:SkiaSharp.SKBitmap.RowBytes" />.</summary>
|
||||
<value>The byte size of the pixels.</value>
|
||||
<remarks>Note: this truncates the result to 32-bits.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Bytes">
|
||||
|
|
@ -236,9 +224,11 @@
|
|||
<ReturnType>System.Byte[]</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Gets a copy of all the pixel data as a byte array.</summary>
|
||||
<value>The pixel data.</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="BytesPerPixel">
|
||||
|
|
@ -351,8 +341,7 @@
|
|||
<summary>Copies the contents of the bitmap and returns the copy.</summary>
|
||||
<returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
</para>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -964,12 +953,11 @@
|
|||
<Parameter Name="length" Type="System.IntPtr&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="length">The lenght of the pixel buffer returned.</param>
|
||||
<param name="length">The length of the pixel buffer returned.</param>
|
||||
<summary>Returns the address of the pixels for this SKBitmap</summary>
|
||||
<returns>Returns a pointer to the region that contains the pixel data for this bitmap. This might return <see langword="null" /> if there is no pixel buffer associated with this bitmap.</returns>
|
||||
<returns>Returns a pointer to the region that contains the pixel data for this bitmap. This might return <see langword="null" /> if there is no pixel buffer associated with this bitmap.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
</para>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -1060,8 +1048,7 @@
|
|||
<value>
|
||||
<see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value>
|
||||
<remarks>
|
||||
<para>
|
||||
</para>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
@ -1223,9 +1210,7 @@
|
|||
<Parameters />
|
||||
<Docs>
|
||||
<summary>Marks the bitmap as immutable.</summary>
|
||||
<remarks>
|
||||
<para>Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref.</para>
|
||||
</remarks>
|
||||
<remarks>Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetPixel">
|
||||
|
|
@ -1276,11 +1261,7 @@
|
|||
<Parameters />
|
||||
<Docs>
|
||||
<summary>Call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</summary>
|
||||
<remarks>
|
||||
<para>When you are finished access the pixel memory, call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />. This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image.</para>
|
||||
<para>
|
||||
</para>
|
||||
</remarks>
|
||||
<remarks>When you are finished access the pixel memory, call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />. This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Width">
|
||||
|
|
|
|||
|
|
@ -16,9 +16,7 @@
|
|||
</Base>
|
||||
<Docs>
|
||||
<summary>Describes how to interpret the components of a pixel.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
<remarks />
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="Alpha8">
|
||||
|
|
|
|||
|
|
@ -1,10 +1,6 @@
|
|||
<Namespace Name="SkiaSharp">
|
||||
<Docs>
|
||||
<summary>SkiaSharp is a 2D graphics API powered by the Skia library.</summary>
|
||||
<remarks>
|
||||
<para>For information on getting started with the SkiaSharp library, please visit </para>
|
||||
<format type="text/html">
|
||||
<a href="https://github.com/xamarin/documentation/tree/master/guides/cross-platform/drawing">SkiaSharp</a>.</format>
|
||||
</remarks>
|
||||
<remarks>For information on getting started with the SkiaSharp library, please visit the Xamarin documentation website.</remarks>
|
||||
</Docs>
|
||||
</Namespace>
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче