Added the docs
This commit is contained in:
Родитель
7419a8da5d
Коммит
737eb5c4cc
|
@ -51,7 +51,7 @@
|
|||
<ReturnType>SkiaSharp.GRBackendState</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Reset nothing.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -53,9 +53,11 @@
|
|||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Gets or sets a value indicating whether to avoid allocating stencil buffers.</summary>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>Bugs on certain drivers cause stencil buffers to leak. This flag causes Skia to avoid allocating stencil buffers and use alternate rasterization paths, avoiding the leak.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="BufferMapThreshold">
|
||||
|
|
|
@ -119,7 +119,7 @@
|
|||
<ReturnType>SkiaSharp.GRGlBackendState</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Reset nothing.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="PathRendering">
|
||||
|
|
|
@ -98,7 +98,7 @@
|
|||
<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>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
@ -142,11 +142,11 @@
|
|||
<Parameter Name="flags" Type="SkiaSharp.SKBitmapAllocFlags" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="info">To be added.</param>
|
||||
<param name="ctable">To be added.</param>
|
||||
<param name="flags">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="info">The description of the desired image format.</param>
|
||||
<param name="ctable">The color lookup table.</param>
|
||||
<param name="flags">The additional flags.</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>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
|
@ -14,8 +14,10 @@
|
|||
</Attribute>
|
||||
</Attributes>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Flags to use with <see cref="M:SkiaSharp.SKBitmap..ctor" />.</summary>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="None">
|
||||
|
@ -29,7 +31,7 @@
|
|||
<ReturnType>SkiaSharp.SKBitmapAllocFlags</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Default bitmap allocation flag.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ZeroPixels">
|
||||
|
@ -43,7 +45,7 @@
|
|||
<ReturnType>SkiaSharp.SKBitmapAllocFlags</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Initialize the bitmap with zeroed data.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -2231,11 +2231,11 @@
|
|||
<Parameter Name="paint" Type="SkiaSharp.SKPaint" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="vertices">To be added.</param>
|
||||
<param name="mode">To be added.</param>
|
||||
<param name="paint">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="vertices">The mesh to draw.</param>
|
||||
<param name="mode">The blend mode to use to combine the colors with the texture, before being drawn using the paint. Used if both texture coordinates and colors are present.</param>
|
||||
<param name="paint">The shader/texture.</param>
|
||||
<summary>Draws a set of vertices.</summary>
|
||||
<remarks>If both textures and vertex-colors are <see langword="null" />, it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DrawVertices">
|
||||
|
|
|
@ -30,9 +30,13 @@
|
|||
<ReturnType>SkiaSharp.SKAlphaType</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Gets or sets a value indicating the frame’s alpha value.</summary>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Duration">
|
||||
|
|
|
@ -220,9 +220,13 @@
|
|||
<ReturnType>SkiaSharp.SKTransferFunctionBehavior</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Gets or sets a value indicating whether the decode should do a linear premultiply or a legacy premultiply.</summary>
|
||||
<value>
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Subset">
|
||||
|
|
|
@ -394,9 +394,13 @@
|
|||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<value>To be added.</value>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Gets a value indicating whether or not the color space is sRGB.</summary>
|
||||
<value>
|
||||
<para />
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ToXyzD50">
|
||||
|
|
|
@ -32,7 +32,7 @@
|
|||
<ReturnType>SkiaSharp.SKColorSpaceFlags</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Default construction.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="NonLinearBlending">
|
||||
|
|
|
@ -148,10 +148,10 @@
|
|||
<Docs>
|
||||
<summary>Gets or sets the red X-coordinate.</summary>
|
||||
<value>
|
||||
<para />
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
@ -169,10 +169,10 @@
|
|||
<Docs>
|
||||
<summary>Gets or sets the red Y-coordinate.</summary>
|
||||
<value>
|
||||
<para />
|
||||
<para></para>
|
||||
</value>
|
||||
<remarks>
|
||||
<para />
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
@ -188,9 +188,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
||||
<returns>Returns the XYZ D50 matrix, or <see langword="null" /> if the conversion is not possible.</returns>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ToXyzD50">
|
||||
|
@ -207,10 +209,12 @@
|
|||
<Parameter Name="toXyzD50" Type="SkiaSharp.SKMatrix44" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="toXyzD50">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="toXyzD50">The XYZ D50 matrix.</param>
|
||||
<summary>Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of <see cref="T:SkiaSharp.SKColorSpace" />.</summary>
|
||||
<returns>Returns <see langword="true" /> if the conversion succeeded, otherwise <see langword="false" /> if the conversion is not possible.</returns>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="WX">
|
||||
|
|
|
@ -214,9 +214,11 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Inverts coefficients for a common transfer function equation.</summary>
|
||||
<returns>Returns the mathematically inverted parametric transfer function equation.</returns>
|
||||
<remarks>
|
||||
<para />
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -113,7 +113,7 @@
|
|||
<ReturnType>SkiaSharp.SKCropRectFlags</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>None of the edges have been specified.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="HasTop">
|
||||
|
|
|
@ -356,10 +356,12 @@
|
|||
<Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="pixmap">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
||||
<summary>Copies the pixels from the image into the specified pixmap.</summary>
|
||||
<returns>Returns <see langword="true" /> if the pexels were read, or <see langword="false" /> if there was an error.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ReadPixels">
|
||||
|
@ -378,12 +380,14 @@
|
|||
<Parameter Name="dstRowBytes" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="dstInfo">To be added.</param>
|
||||
<param name="dstPixels">To be added.</param>
|
||||
<param name="dstRowBytes">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
||||
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
||||
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
||||
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
||||
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ReadPixels">
|
||||
|
@ -402,12 +406,14 @@
|
|||
<Parameter Name="srcY" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="pixmap">To be added.</param>
|
||||
<param name="srcX">To be added.</param>
|
||||
<param name="srcY">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="pixmap">The pixmap to read the pixel data into.</param>
|
||||
<param name="srcX">The source x-coordinate to start reading from.</param>
|
||||
<param name="srcY">The source y-coordinate to start reading from.</param>
|
||||
<summary>Copies the pixels from the image into the specified pixmap.</summary>
|
||||
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ReadPixels">
|
||||
|
@ -428,14 +434,16 @@
|
|||
<Parameter Name="srcY" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="dstInfo">To be added.</param>
|
||||
<param name="dstPixels">To be added.</param>
|
||||
<param name="dstRowBytes">To be added.</param>
|
||||
<param name="srcX">To be added.</param>
|
||||
<param name="srcY">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="dstInfo">The image information describing the destination pixel buffer.</param>
|
||||
<param name="dstPixels">The pixel buffer to read the pixel data into.</param>
|
||||
<param name="dstRowBytes">The number of bytes in each row of in the destination buffer.</param>
|
||||
<param name="srcX">The source x-coordinate to start reading from.</param>
|
||||
<param name="srcY">The source y-coordinate to start reading from.</param>
|
||||
<summary>Copies the pixels from the image into the specified buffer.</summary>
|
||||
<returns>Returns <see langword="true" /> if the pixels were read, or <see langword="false" /> if there was an error.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Reset">
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<ReturnType>SkiaSharp.SKSurfacePropsFlags</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Use default properties.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="UseDeviceIndependentFonts">
|
||||
|
|
|
@ -9,8 +9,10 @@
|
|||
<BaseTypeName>System.Enum</BaseTypeName>
|
||||
</Base>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Various flags to be used with <see cref="P:SkiaSharp.SKCodecOptions.PremulBehavior" />.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="Ignore">
|
||||
|
@ -24,7 +26,7 @@
|
|||
<ReturnType>SkiaSharp.SKTransferFunctionBehavior</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Premultiplies, unpremultiplies, and blends ignoring the transfer function. Pixels are treated as if they are linear, regardless of their transfer function encoding.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Respect">
|
||||
|
@ -38,7 +40,7 @@
|
|||
<ReturnType>SkiaSharp.SKTransferFunctionBehavior</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<summary>Converts to a linear space before premultiplying, unpremultiplying, or blending.</summary>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -10,8 +10,10 @@
|
|||
</Base>
|
||||
<Interfaces />
|
||||
<Docs>
|
||||
<summary>To be added.</summary>
|
||||
<remarks>To be added.</remarks>
|
||||
<summary>Represents an immutable set of vertex data that can be used with <see cref="M:SkiaSharp.SKCanvas.DrawVertices" />.</summary>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Members>
|
||||
<Member MemberName="CreateCopy">
|
||||
|
@ -30,12 +32,14 @@
|
|||
<Parameter Name="colors" Type="SkiaSharp.SKColor[]" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="vmode">To be added.</param>
|
||||
<param name="positions">To be added.</param>
|
||||
<param name="colors">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="vmode">How to interpret the array of vertices.</param>
|
||||
<param name="positions">The array of vertices for the mesh.</param>
|
||||
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
||||
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateCopy">
|
||||
|
@ -55,13 +59,15 @@
|
|||
<Parameter Name="colors" Type="SkiaSharp.SKColor[]" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="vmode">To be added.</param>
|
||||
<param name="positions">To be added.</param>
|
||||
<param name="texs">To be added.</param>
|
||||
<param name="colors">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="vmode">How to interpret the array of vertices.</param>
|
||||
<param name="positions">The array of vertices for the mesh.</param>
|
||||
<param name="texs">The coordinates in texture space (not uv space) for each vertex. May be <see langword="null" />.</param>
|
||||
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
||||
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateCopy">
|
||||
|
@ -82,14 +88,16 @@
|
|||
<Parameter Name="indices" Type="System.UInt16[]" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<param name="vmode">To be added.</param>
|
||||
<param name="positions">To be added.</param>
|
||||
<param name="texs">To be added.</param>
|
||||
<param name="colors">To be added.</param>
|
||||
<param name="indices">To be added.</param>
|
||||
<summary>To be added.</summary>
|
||||
<returns>To be added.</returns>
|
||||
<remarks>To be added.</remarks>
|
||||
<param name="vmode">How to interpret the array of vertices.</param>
|
||||
<param name="positions">The array of vertices for the mesh.</param>
|
||||
<param name="texs">The coordinates in texture space (not uv space) for each vertex. May be <see langword="null" />.</param>
|
||||
<param name="colors">The color for each vertex, to be interpolated across the triangle. May be <see langword="null" />.</param>
|
||||
<param name="indices">The array of indices to reference into the vertex (texture coordinates, colors) array.</param>
|
||||
<summary>Creates a new <see cref="T:SkiaSharp.SKVertices" /> instance, making a copy of the vertices and related data.</summary>
|
||||
<returns>Returns the new <see cref="T:SkiaSharp.SKVertices" /> instance.</returns>
|
||||
<remarks>
|
||||
<para></para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Dispose">
|
||||
|
|
Загрузка…
Ссылка в новой задаче