Skip to content

Fill and review API documentation #169

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 #169

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
3 changes: 2 additions & 1 deletion SkiaSharpAPI/HarfBuzzSharp/HBColor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,8 @@ Console.WriteLine(red); // #FFFF0000
<Docs>
<param name="obj">The object to compare with the current color.</param>
<summary>Determines whether the specified object is equal to the current color.</summary>
<returns><see langword="true" /> if the specified object is equal to the current color; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if the specified object is equal to the current color; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion SkiaSharpAPI/SkiaSharp.Views.Tizen/CustomRenderingView.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</Parameters>
<Docs>
<param name="parent">The parent object.</param>
<summary>Initializes a new instance of the <see cref="SkiaSharp.Views.Tizen.CustomRenderingView" /> class.</summary>
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.Tizen.CustomRenderingView" /> class.</summary>
<remarks>Use this constructor when creating the view programmatically from code.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion SkiaSharpAPI/SkiaSharp/SKBitmap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1595,7 +1595,7 @@
<ReturnType>SkiaSharp.SKColor[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets all the pixels as an array of colors.</summary>
<summary>Gets or sets all the pixels as an array of colors.</summary>
<value>The array of colors.</value>
<remarks />
</Docs>
Expand Down
46 changes: 45 additions & 1 deletion SkiaSharpAPI/SkiaSharp/SKColorFilter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
</Parameters>
<Docs>
<param name="c">The source color used with the specified mode.</param>
<param name="mode">The blend mode mode that is applied to each color.</param>
<param name="mode">The blend mode that is applied to each color.</param>
<summary>Creates a new color filter that uses the specified color and mode.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />, or <see langword="null" /> if the mode will have no effect.</returns>
<remarks>If the <paramref name="mode" /> is <see cref="F:SkiaSharp.SKBlendMode.Dst" />, this function will return <see langword="null" /> (since that mode will have no effect on the result).</remarks>
Expand Down Expand Up @@ -284,6 +284,50 @@
<remarks />
</Docs>
</Member>
<Member MemberName="CreateOverdraw">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateOverdraw (SkiaSharp.SKColor[] colors);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateOverdraw(valuetype SkiaSharp.SKColor[] colors) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateOverdraw(SkiaSharp.SKColor[])" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColorFilter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colors" Type="SkiaSharp.SKColor[]" />
</Parameters>
<Docs>
<param name="colors">The palette of colors used to visualize overdraw levels.</param>
<summary>Creates a color filter that maps each source alpha value to a color from the specified palette, used to visualize overdraw when drawing.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateOverdraw">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateOverdraw (ReadOnlySpan&lt;SkiaSharp.SKColor&gt; colors);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateOverdraw(valuetype System.ReadOnlySpan`1&lt;valuetype SkiaSharp.SKColor&gt; colors) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColorFilter.CreateOverdraw(System.ReadOnlySpan{SkiaSharp.SKColor})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKColorFilter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colors" Type="System.ReadOnlySpan&lt;SkiaSharp.SKColor&gt;" />
</Parameters>
<Docs>
<param name="colors">The palette of colors used to visualize overdraw levels.</param>
<summary>Creates a color filter that maps each source alpha value to a color from the specified palette, used to visualize overdraw when drawing.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKColorFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateSrgbToLinearGamma">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKColorFilter CreateSrgbToLinearGamma ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKColorFilter CreateSrgbToLinearGamma() cil managed" />
Expand Down
2 changes: 1 addition & 1 deletion SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

`SKColorspacePrimariesCicp` enumerates the standard color primaries defined by the ITU-T H.273 and ISO/IEC 23001-8 specifications. These values are used as parameters when calling <xref:SkiaSharp.SKColorSpace.CreateCicp*> to create a CICP-specified color space.

Each member's numeric value corresponds directly to the "Colour primaries" code point in Table 2 of ITU-T H.273.
Each member's numeric value corresponds directly to the color primaries code point in Table 2 of ITU-T H.273.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion SkiaSharpAPI/SkiaSharp/SKFrontBufferedStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the position within the current stream.</summary>
<summary>Gets or sets the position within the current stream.</summary>
<value>The current position within the stream.</value>
<remarks />
</Docs>
Expand Down
97 changes: 97 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKImageFilter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,84 @@
<remarks />
</Docs>
</Member>
<Member MemberName="CreateCrop">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateCrop (SkiaSharp.SKRect rect);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateCrop(valuetype SkiaSharp.SKRect rect) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKImageFilter.CreateCrop(SkiaSharp.SKRect)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageFilter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rect" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="rect">The crop rectangle that limits the output.</param>
<summary>Creates an image filter that restricts the output of its input to the specified rectangle.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateCrop">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateCrop (SkiaSharp.SKRect rect, SkiaSharp.SKShaderTileMode tileMode);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateCrop(valuetype SkiaSharp.SKRect rect, valuetype SkiaSharp.SKShaderTileMode tileMode) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKImageFilter.CreateCrop(SkiaSharp.SKRect,SkiaSharp.SKShaderTileMode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageFilter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rect" Type="SkiaSharp.SKRect" />
<Parameter Name="tileMode" Type="SkiaSharp.SKShaderTileMode" />
</Parameters>
<Docs>
<param name="rect">The crop rectangle that limits the output.</param>
<param name="tileMode">The tile mode used to fill pixels outside the crop rectangle.</param>
<summary>Creates an image filter that restricts the output of its input to the specified rectangle and uses the given tile mode for samples outside that rectangle.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateCrop">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateCrop (SkiaSharp.SKRect rect, SkiaSharp.SKShaderTileMode tileMode, SkiaSharp.SKImageFilter? input);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateCrop(valuetype SkiaSharp.SKRect rect, valuetype SkiaSharp.SKShaderTileMode tileMode, class SkiaSharp.SKImageFilter input) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKImageFilter.CreateCrop(SkiaSharp.SKRect,SkiaSharp.SKShaderTileMode,SkiaSharp.SKImageFilter)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageFilter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rect" Type="SkiaSharp.SKRect" />
<Parameter Name="tileMode" Type="SkiaSharp.SKShaderTileMode" />
<Parameter Name="input" Type="SkiaSharp.SKImageFilter">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="rect">The crop rectangle that limits the output.</param>
<param name="tileMode">The tile mode used to fill pixels outside the crop rectangle.</param>
<param name="input">The input filter to apply the crop to, or <see langword="null" /> to use the source bitmap.</param>
<summary>Creates an image filter that restricts the output of the input filter to the specified rectangle and uses the given tile mode for samples outside that rectangle.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateDilate">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateDilate (float radiusX, float radiusY);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateDilate(float32 radiusX, float32 radiusY) cil managed" />
Expand Down Expand Up @@ -1275,6 +1353,25 @@
<remarks />
</Docs>
</Member>
<Member MemberName="CreateEmpty">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateEmpty ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateEmpty() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKImageFilter.CreateEmpty" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKImageFilter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates an image filter that produces no output.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKImageFilter" />, or <see langword="null" /> on error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateErode">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageFilter CreateErode (float radiusX, float radiusY);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImageFilter CreateErode(float32 radiusX, float32 radiusY) cil managed" />
Expand Down
2 changes: 1 addition & 1 deletion SkiaSharpAPI/SkiaSharp/SKImageInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
<ReturnType>SkiaSharp.SKAlphaType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the transparency type for the image info.</summary>
<summary>Gets or sets the transparency type for the image info.</summary>
<value>One of the enumeration values that specifies the transparency type.</value>
<remarks />
</Docs>
Expand Down
6 changes: 3 additions & 3 deletions SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
<ReturnType>SkiaSharp.SKJpegEncoderAlphaOption</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the value to control how alpha is handled.</summary>
<summary>Gets the value to control how alpha is handled.</summary>
<value>One of the enumeration values that specifies how alpha is handled.</value>
<remarks>JPEGs must be opaque, so this instructs the encoder on how to handle input images with alpha.</remarks>
</Docs>
Expand Down Expand Up @@ -112,7 +112,7 @@
<ReturnType>SkiaSharp.SKJpegEncoderDownsample</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the downsampling factor for the U and V components.</summary>
<summary>Gets the downsampling factor for the U and V components.</summary>
<value>One of the enumeration values that specifies the downsampling factor.</value>
<remarks>This is only meaningful if the image is not gray, since gray will not be encoded as YUV.</remarks>
</Docs>
Expand Down Expand Up @@ -248,7 +248,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the quality of the encoding in the range 0 to 100.</summary>
<summary>Gets the quality of the encoding in the range 0 to 100.</summary>
<value>The encoding quality value from 0 (lowest) to 100 (highest).</value>
<remarks />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions SkiaSharpAPI/SkiaSharp/SKNativeObject.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the call the public <see cref="M:SkiaSharp.SKNativeObject.Dispose" /> should be no-op.</summary>
<summary>Gets a value indicating whether the call the public <see cref="M:SkiaSharp.SKNativeObject.Dispose" /> should be no-op.</summary>
<value>
<see langword="true" /> if the public Dispose call should be ignored; otherwise, <see langword="false" />.</value>
<remarks>This only affects the public disposal. Objects that own this one can still forcefull trigger a dispose using <see cref="M:SkiaSharp.SKNativeObject.DisposeInternal" />.</remarks>
Expand All @@ -202,7 +202,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the object has already been disposed.</summary>
<summary>Gets a value indicating whether the object has already been disposed.</summary>
<value>
<see langword="true" /> if the object has been disposed; otherwise, <see langword="false" />.</value>
<remarks />
Expand Down
25 changes: 25 additions & 0 deletions SkiaSharpAPI/SkiaSharp/SKPaint.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,31 @@ The example above produces the following:
<remarks />
</Docs>
</Member>
<Member MemberName="GetFastBounds">
<MemberSignature Language="C#" Value="public bool GetFastBounds (SkiaSharp.SKRect bounds, out SkiaSharp.SKRect fastBounds);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetFastBounds(valuetype SkiaSharp.SKRect bounds, [out] valuetype SkiaSharp.SKRect&amp; fastBounds) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPaint.GetFastBounds(SkiaSharp.SKRect,SkiaSharp.SKRect@)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>4.150.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
<Parameter Name="fastBounds" Type="SkiaSharp.SKRect" RefType="out" />
</Parameters>
<Docs>
<param name="bounds">The original geometry bounds, before this paint is applied.</param>
<param name="fastBounds">When this method returns, contains the bounds expanded to include any effects (such as stroking or mask/image filters) contributed by this paint. This parameter is treated as uninitialized.</param>
<summary>Computes a rectangle that contains the original geometry expanded to include any effects (such as stroking or mask/image filters) applied by this paint.</summary>
<returns>
<see langword="true" /> if the expanded bounds were computed; otherwise, <see langword="false" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetFillPath">
<MemberSignature Language="C#" Value="public SkiaSharp.SKPath GetFillPath (SkiaSharp.SKPath src);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKPath GetFillPath(class SkiaSharp.SKPath src) cil managed" />
Expand Down
4 changes: 2 additions & 2 deletions SkiaSharpAPI/SkiaSharp/SKPath.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,7 +916,7 @@ the first point is automatically set to (0, 0).
<ReturnType>SkiaSharp.SKPathConvexity</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the path's convexity.</summary>
<summary>Gets the path's convexity.</summary>
<value>One of the enumeration values that specifies the path's convexity.</value>
<remarks>If it is currently unknown, then this function will attempt to compute the convexity (and cache the result).</remarks>
</Docs>
Expand Down Expand Up @@ -1344,7 +1344,7 @@ the first point is automatically set to (0, 0).
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the handle to the underlying native path object.</summary>
<summary>Gets or sets the handle to the underlying native path object.</summary>
<value>The underlying native <c>sk_path_t</c> handle.</value>
<remarks></remarks>
</Docs>
Expand Down
6 changes: 4 additions & 2 deletions SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,11 @@
<param name="start">The starting distance along the contour for the segment.</param>
<param name="stop">The ending distance along the contour for the segment.</param>
<param name="dst">The <see cref="T:SkiaSharp.SKPathBuilder" /> to receive the extracted path segment.</param>
<param name="startWithMoveTo"><see langword="true" /> to start the segment with a move-to command; otherwise, <see langword="false" />.</param>
<param name="startWithMoveTo">
<see langword="true" /> to start the segment with a move-to command; otherwise, <see langword="false" />.</param>
<summary>Copies a segment of the path contour, between the specified distances, into the specified path builder.</summary>
<returns><see langword="true" /> if a valid segment was extracted; otherwise, <see langword="false" />.</returns>
<returns>
<see langword="true" /> if a valid segment was extracted; otherwise, <see langword="false" />.</returns>
<remarks></remarks>
</Docs>
</Member>
Expand Down
Loading