From 8a8f88815e2d2c3c19a1425c3b7360376ae287d3 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 30 Jun 2026 07:54:31 +0000
Subject: [PATCH] Fill and review API documentation
Fill 8 `To be added.` placeholders introduced by stub regen: SKSurface.DisposeManaged, SKImageFilter.CreateEmpty + 3 CreateCrop overloads, 2 SKColorFilter.CreateOverdraw overloads, SKPaint.GetFastBounds.
Fix 23 lint findings across 16 type files (1 invalid-cref, 4 repeated-word, 1 spelling, 17 accessor-verb).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
SkiaSharpAPI/HarfBuzzSharp/HBColor.xml | 3 +-
.../CustomRenderingView.xml | 2 +-
SkiaSharpAPI/SkiaSharp/SKBitmap.xml | 2 +-
SkiaSharpAPI/SkiaSharp/SKColorFilter.xml | 46 ++++++++-
.../SkiaSharp/SKColorspacePrimariesCicp.xml | 2 +-
.../SkiaSharp/SKFrontBufferedStream.xml | 2 +-
SkiaSharpAPI/SkiaSharp/SKImageFilter.xml | 97 +++++++++++++++++++
SkiaSharpAPI/SkiaSharp/SKImageInfo.xml | 2 +-
.../SkiaSharp/SKJpegEncoderOptions.xml | 6 +-
SkiaSharpAPI/SkiaSharp/SKNativeObject.xml | 4 +-
SkiaSharpAPI/SkiaSharp/SKPaint.xml | 25 +++++
SkiaSharpAPI/SkiaSharp/SKPath.xml | 4 +-
SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 6 +-
.../SkiaSharp/SKPngEncoderOptions.xml | 4 +-
SkiaSharpAPI/SkiaSharp/SKSize.xml | 4 +-
SkiaSharpAPI/SkiaSharp/SKSizeI.xml | 2 +-
SkiaSharpAPI/SkiaSharp/SKStream.xml | 2 +-
SkiaSharpAPI/SkiaSharp/SKSurface.xml | 18 ++++
.../SkiaSharp/SKSurfaceProperties.xml | 4 +-
.../SkiaSharp/SKWebpEncoderOptions.xml | 4 +-
20 files changed, 213 insertions(+), 26 deletions(-)
diff --git a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml
index cff17d14..d1a63650 100644
--- a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml
+++ b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml
@@ -165,7 +165,8 @@ Console.WriteLine(red); // #FFFF0000
The object to compare with the current color.
Determines whether the specified object is equal to the current color.
- if the specified object is equal to the current color; otherwise, .
+
+ if the specified object is equal to the current color; otherwise, .
diff --git a/SkiaSharpAPI/SkiaSharp.Views.Tizen/CustomRenderingView.xml b/SkiaSharpAPI/SkiaSharp.Views.Tizen/CustomRenderingView.xml
index e8bcee0f..152692a6 100644
--- a/SkiaSharpAPI/SkiaSharp.Views.Tizen/CustomRenderingView.xml
+++ b/SkiaSharpAPI/SkiaSharp.Views.Tizen/CustomRenderingView.xml
@@ -29,7 +29,7 @@
The parent object.
- Initializes a new instance of the class.
+ Initializes a new instance of the class.
Use this constructor when creating the view programmatically from code.
diff --git a/SkiaSharpAPI/SkiaSharp/SKBitmap.xml b/SkiaSharpAPI/SkiaSharp/SKBitmap.xml
index 29fbdf04..5b8f226e 100644
--- a/SkiaSharpAPI/SkiaSharp/SKBitmap.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKBitmap.xml
@@ -1595,7 +1595,7 @@
SkiaSharp.SKColor[]
- Gets all the pixels as an array of colors.
+ Gets or sets all the pixels as an array of colors.
The array of colors.
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorFilter.xml b/SkiaSharpAPI/SkiaSharp/SKColorFilter.xml
index 5d40c51a..8dc5781b 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorFilter.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorFilter.xml
@@ -51,7 +51,7 @@
The source color used with the specified mode.
- The blend mode mode that is applied to each color.
+ The blend mode that is applied to each color.
Creates a new color filter that uses the specified color and mode.
Returns the new , or if the mode will have no effect.
If the is , this function will return (since that mode will have no effect on the result).
@@ -284,6 +284,50 @@
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKColorFilter
+
+
+
+
+
+ The palette of colors used to visualize overdraw levels.
+ Creates a color filter that maps each source alpha value to a color from the specified palette, used to visualize overdraw when drawing.
+ Returns the new , or on error.
+
+
+
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKColorFilter
+
+
+
+
+
+ The palette of colors used to visualize overdraw levels.
+ Creates a color filter that maps each source alpha value to a color from the specified palette, used to visualize overdraw when drawing.
+ Returns the new , or on error.
+
+
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
index 9c6b6bd6..b50d3291 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
@@ -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 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
diff --git a/SkiaSharpAPI/SkiaSharp/SKFrontBufferedStream.xml b/SkiaSharpAPI/SkiaSharp/SKFrontBufferedStream.xml
index cbbafa31..78e0f480 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFrontBufferedStream.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFrontBufferedStream.xml
@@ -243,7 +243,7 @@
System.Int64
- Gets the position within the current stream.
+ Gets or sets the position within the current stream.
The current position within the stream.
diff --git a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml
index f5b7b60d..c14fdc93 100644
--- a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml
@@ -657,6 +657,84 @@
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKImageFilter
+
+
+
+
+
+ The crop rectangle that limits the output.
+ Creates an image filter that restricts the output of its input to the specified rectangle.
+ Returns the new , or on error.
+
+
+
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKImageFilter
+
+
+
+
+
+
+ The crop rectangle that limits the output.
+ The tile mode used to fill pixels outside the crop rectangle.
+ 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.
+ Returns the new , or on error.
+
+
+
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKImageFilter
+
+
+
+
+
+
+
+ [System.Runtime.CompilerServices.Nullable(2)]
+
+
+
+
+
+ The crop rectangle that limits the output.
+ The tile mode used to fill pixels outside the crop rectangle.
+ The input filter to apply the crop to, or to use the source bitmap.
+ 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.
+ Returns the new , or on error.
+
+
+
@@ -1275,6 +1353,25 @@
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ SkiaSharp.SKImageFilter
+
+
+
+ Creates an image filter that produces no output.
+ Returns the new , or on error.
+
+
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKImageInfo.xml b/SkiaSharpAPI/SkiaSharp/SKImageInfo.xml
index f57a0258..7dd4583d 100644
--- a/SkiaSharpAPI/SkiaSharp/SKImageInfo.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKImageInfo.xml
@@ -129,7 +129,7 @@
SkiaSharp.SKAlphaType
- Gets the transparency type for the image info.
+ Gets or sets the transparency type for the image info.
One of the enumeration values that specifies the transparency type.
diff --git a/SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml b/SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml
index 4fa3e165..76aa2f7b 100644
--- a/SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml
@@ -77,7 +77,7 @@
SkiaSharp.SKJpegEncoderAlphaOption
- Gets or sets the value to control how alpha is handled.
+ Gets the value to control how alpha is handled.
One of the enumeration values that specifies how alpha is handled.
JPEGs must be opaque, so this instructs the encoder on how to handle input images with alpha.
@@ -112,7 +112,7 @@
SkiaSharp.SKJpegEncoderDownsample
- Gets or sets the downsampling factor for the U and V components.
+ Gets the downsampling factor for the U and V components.
One of the enumeration values that specifies the downsampling factor.
This is only meaningful if the image is not gray, since gray will not be encoded as YUV.
@@ -248,7 +248,7 @@
System.Int32
- Gets or sets the quality of the encoding in the range 0 to 100.
+ Gets the quality of the encoding in the range 0 to 100.
The encoding quality value from 0 (lowest) to 100 (highest).
diff --git a/SkiaSharpAPI/SkiaSharp/SKNativeObject.xml b/SkiaSharpAPI/SkiaSharp/SKNativeObject.xml
index b3aceaf7..fa04d0df 100644
--- a/SkiaSharpAPI/SkiaSharp/SKNativeObject.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKNativeObject.xml
@@ -183,7 +183,7 @@
System.Boolean
- Gets or sets a value indicating whether the call the public should be no-op.
+ Gets a value indicating whether the call the public should be no-op.
if the public Dispose call should be ignored; otherwise, .
This only affects the public disposal. Objects that own this one can still forcefull trigger a dispose using .
@@ -202,7 +202,7 @@
System.Boolean
- Gets or sets a value indicating whether the object has already been disposed.
+ Gets a value indicating whether the object has already been disposed.
if the object has been disposed; otherwise, .
diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml
index 90f49106..be73d709 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml
@@ -301,6 +301,31 @@ The example above produces the following:
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ System.Boolean
+
+
+
+
+
+
+ The original geometry bounds, before this paint is applied.
+ 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.
+ Computes a rectangle that contains the original geometry expanded to include any effects (such as stroking or mask/image filters) applied by this paint.
+
+ if the expanded bounds were computed; otherwise, .
+
+
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml
index 37aae424..a29808fa 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPath.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml
@@ -916,7 +916,7 @@ the first point is automatically set to (0, 0).
SkiaSharp.SKPathConvexity
- Gets or sets the path's convexity.
+ Gets the path's convexity.
One of the enumeration values that specifies the path's convexity.
If it is currently unknown, then this function will attempt to compute the convexity (and cache the result).
@@ -1344,7 +1344,7 @@ the first point is automatically set to (0, 0).
System.IntPtr
- Gets the handle to the underlying native path object.
+ Gets or sets the handle to the underlying native path object.
The underlying native sk_path_t handle.
diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
index ad9b8509..99e67f24 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
@@ -301,9 +301,11 @@
The starting distance along the contour for the segment.
The ending distance along the contour for the segment.
The to receive the extracted path segment.
- to start the segment with a move-to command; otherwise, .
+
+ to start the segment with a move-to command; otherwise, .
Copies a segment of the path contour, between the specified distances, into the specified path builder.
- if a valid segment was extracted; otherwise, .
+
+ if a valid segment was extracted; otherwise, .
diff --git a/SkiaSharpAPI/SkiaSharp/SKPngEncoderOptions.xml b/SkiaSharpAPI/SkiaSharp/SKPngEncoderOptions.xml
index 7556c19e..27ec8a6a 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPngEncoderOptions.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPngEncoderOptions.xml
@@ -123,7 +123,7 @@
SkiaSharp.SKPngEncoderFilterFlags
- Gets or sets the filtering flags.
+ Gets the filtering flags.
The filtering flags.
If a single filter is chosen, then that filter will be used for every row.
@@ -214,7 +214,7 @@
System.Int32
- Gets or sets the compression level in the range 0..9.
+ Gets the compression level in the range 0..9.
The compression level in the range 0..9.
A value of 0 is a special case to skip compression entirely, creating dramatically larger PNGs.
diff --git a/SkiaSharpAPI/SkiaSharp/SKSize.xml b/SkiaSharpAPI/SkiaSharp/SKSize.xml
index 77058a72..7b6a0292 100644
--- a/SkiaSharpAPI/SkiaSharp/SKSize.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKSize.xml
@@ -295,7 +295,7 @@
The structure to be converted.
Converts the specified structure to a structure.
- The structure structure to which this operator converts.
+ The structure to which this operator converts.
@@ -317,7 +317,7 @@
The structure to be converted.
Converts the specified structure to a structure.
- The structure structure to which this operator converts.
+ The structure to which this operator converts.
diff --git a/SkiaSharpAPI/SkiaSharp/SKSizeI.xml b/SkiaSharpAPI/SkiaSharp/SKSizeI.xml
index 6dcbb9e3..c5462863 100644
--- a/SkiaSharpAPI/SkiaSharp/SKSizeI.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKSizeI.xml
@@ -295,7 +295,7 @@
The structure to be converted.
Converts the specified structure to a structure.
- The structure structure to which this operator converts.
+ The structure to which this operator converts.
diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml
index 82f42602..f8f71ec9 100644
--- a/SkiaSharpAPI/SkiaSharp/SKStream.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKStream.xml
@@ -216,7 +216,7 @@
System.Int32
- Gets the current position in the stream. If this is not supported, the position will be reported as 0.
+ Gets or sets the current position in the stream. If this is not supported, the position will be reported as 0.
The current position in the stream, or 0 if not supported.
diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml
index c97c23f4..07da5d20 100644
--- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml
@@ -1634,6 +1634,24 @@ The example above produces the following:
Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.
+
+
+
+
+ Method
+
+ SkiaSharp
+ 4.150.0.0
+
+
+ System.Void
+
+
+
+ Implemented by derived types to destroy any managed objects.
+
+
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKSurfaceProperties.xml b/SkiaSharpAPI/SkiaSharp/SKSurfaceProperties.xml
index a5befd0b..81542215 100644
--- a/SkiaSharpAPI/SkiaSharp/SKSurfaceProperties.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKSurfaceProperties.xml
@@ -126,7 +126,7 @@
SkiaSharp.SKSurfacePropsFlags
- Gets or sets the flags.
+ Gets the flags.
The surface property flags.
@@ -163,7 +163,7 @@
SkiaSharp.SKPixelGeometry
- Gets or sets the LCD geometry of each pixel on the surface.
+ Gets the LCD geometry of each pixel on the surface.
The LCD geometry of each pixel on the surface.
diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml
index d3a1d916..e5ea3886 100644
--- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml
@@ -57,7 +57,7 @@
SkiaSharp.SKWebpEncoderCompression
- Gets or sets the compression level.
+ Gets the compression level.
The compression level.
@@ -210,7 +210,7 @@
System.Single
- Gets or sets the quality of the encoding.
+ Gets the quality of the encoding.
The quality of the encoding in the range 0.0 to 100.0.
If the compression is lossy, then the quality corresponds to the visual quality. Lower values are smaller, but will have reduced quality.