From 06051a035ff004d302983816825a1e2ed8a26395 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 21 May 2026 19:25:53 +0000
Subject: [PATCH] Fill API documentation placeholders
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
SkiaSharpAPI/HarfBuzzSharp/Face.xml | 156 +++---
SkiaSharpAPI/HarfBuzzSharp/Font.xml | 38 +-
.../SkiaSharp.Views.Blazor/_Imports.xml | 4 +-
.../SkiaSharp.Views.Gtk/GTKExtensions.xml | 130 ++---
.../SkiaSharp.Views.Gtk/SKDrawingArea.xml | 4 +-
.../SkiaSharp/GRVkYcbcrComponents.xml | 92 ++--
.../SkiaSharp/GrVkYcbcrConversionInfo.xml | 18 +-
SkiaSharpAPI/SkiaSharp/SKCanvas.xml | 68 +--
SkiaSharpAPI/SkiaSharp/SKColorSpace.xml | 10 +-
SkiaSharpAPI/SkiaSharp/SKColorType.xml | 6 +-
.../SkiaSharp/SKColorspacePrimariesCicp.xml | 49 +-
.../SkiaSharp/SKColorspaceTransferFnCicp.xml | 53 +-
.../SkiaSharp/SKDocumentXpsOptions.xml | 78 ++-
SkiaSharpAPI/SkiaSharp/SKFontArguments.xml | 53 +-
.../SkiaSharp/SKFontPaletteOverride.xml | 80 ++-
.../SkiaSharp/SKFontVariationAxis.xml | 101 ++--
.../SKFontVariationPositionCoordinate.xml | 80 ++-
SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | 127 +++--
SkiaSharpAPI/SkiaSharp/SKMatrix.xml | 16 +-
SkiaSharpAPI/SkiaSharp/SKPaint.xml | 74 +--
SkiaSharpAPI/SkiaSharp/SKPath.xml | 6 +-
SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml | 500 +++++++++---------
SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 14 +-
SkiaSharpAPI/SkiaSharp/SKStream.xml | 6 +-
SkiaSharpAPI/SkiaSharp/SKSurface.xml | 26 +-
SkiaSharpAPI/SkiaSharp/SKTypeface.xml | 76 +--
SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml | 93 ++--
SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml | 69 ++-
SkiaSharpAPI/index.xml | 196 +++----
29 files changed, 1254 insertions(+), 969 deletions(-)
diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml
index d97f97eb..104b868d 100644
--- a/SkiaSharpAPI/HarfBuzzSharp/Face.xml
+++ b/SkiaSharpAPI/HarfBuzzSharp/Face.xml
@@ -167,10 +167,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance.
+ Retrieves the design-space coordinates for the specified named instance.
+ An array of design-space coordinate values, one per variation axis, for the named instance.
+
@@ -190,11 +190,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance.
+ The span to receive the design-space coordinate values.
+ Fills the provided span with the design-space coordinates for the specified named instance.
+ The number of coordinates written into .
+
@@ -213,10 +213,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance.
+ Gets the number of design-space coordinates for the specified named instance.
+ The number of design-space coordinates (one per variation axis) for the named instance.
+
@@ -235,10 +235,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance.
+ Gets the name table entry ID for the PostScript name of the specified named instance.
+ The corresponding to the PostScript name of the named instance.
+
@@ -257,10 +257,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance.
+ Gets the name table entry ID for the subfamily name of the specified named instance.
+ The corresponding to the subfamily name of the named instance.
+
@@ -279,10 +279,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the color entry within the palette.
+ Gets the name table entry ID for the display name of the specified palette color entry.
+ The for the display name of the palette color entry.
+
@@ -301,10 +301,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the color palette.
+ Retrieves all colors in the specified color palette.
+ An array of BGRA-packed color values (blue in the high byte, alpha in the low byte) for the palette.
+
@@ -324,11 +324,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the color palette.
+ The span of values to receive the BGRA-packed colors (blue in the high byte, alpha in the low byte).
+ Fills the provided span with all colors in the specified color palette.
+ The number of colors written into .
+
@@ -347,10 +347,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the color palette.
+ Gets the flags that describe the intended usage of the specified color palette.
+ One of the values describing the palette.
+
@@ -369,10 +369,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the color palette.
+ Gets the name table entry ID for the display name of the specified color palette.
+ The for the display name of the palette.
+
@@ -391,10 +391,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The span to receive the variation axis information.
+ Fills the provided span with information about each OpenType variation axis.
+ The number of axis info entries written into .
+
@@ -428,9 +428,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether the face contains a COLR table with color layer data.
+ if the face has a COLR color layers table; otherwise, .
+
@@ -446,9 +446,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether the face contains a CBDT/CBLC table with PNG color bitmaps.
+ if the face has PNG color bitmap tables; otherwise, .
+
@@ -464,9 +464,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether the face contains an SVG table with color glyph outlines.
+ if the face has an SVG color table; otherwise, .
+
@@ -482,9 +482,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether the face contains a CPAL table with color palettes.
+ if the face has a CPAL color palette table; otherwise, .
+
@@ -500,9 +500,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether the face contains OpenType variation (fvar) data.
+ if the face has OpenType variation data; otherwise, .
+
@@ -573,9 +573,9 @@
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets the number of named instances defined in the font's fvar table.
+ The number of named variation instances, or 0 if the face has no variation data.
+
@@ -591,9 +591,9 @@
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets the number of color palettes defined in the font's CPAL table.
+ The number of CPAL palettes, or 0 if the face has no CPAL table.
+
@@ -653,11 +653,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The four-byte tag identifying the variation axis (for example, wght for weight).
+ When this method returns, contains the axis information if the axis was found. This parameter is treated as uninitialized.
+ Attempts to find a variation axis by its four-byte tag.
+ if the axis was found; otherwise, .
+
@@ -691,9 +691,9 @@
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets the number of variation axes defined in the font's fvar table.
+ The number of variation axes, or 0 if the face has no variation data.
+
@@ -709,9 +709,9 @@
HarfBuzzSharp.OpenTypeVarAxisInfo[]
- To be added.
- To be added.
- To be added.
+ Gets an array containing information about each variation axis defined in the font's fvar table.
+ An array of values, one per variation axis.
+
diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml
index b9693d38..522ff178 100644
--- a/SkiaSharpAPI/HarfBuzzSharp/Font.xml
+++ b/SkiaSharpAPI/HarfBuzzSharp/Font.xml
@@ -321,10 +321,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The span to receive the normalized variation coordinate values (each in the range -16384 to +16384).
+ Fills the provided span with the current normalized variation axis coordinates for the font.
+ The number of coordinates written into .
+
@@ -579,9 +579,9 @@
- To be added.
- To be added.
- To be added.
+ The design-space coordinate values, one per variation axis in the face's fvar table.
+ Sets the font's variation axes using design-space coordinate values.
+
@@ -600,9 +600,9 @@
- To be added.
- To be added.
- To be added.
+ The normalized coordinate values (each in the range -16384 to +16384), one per variation axis.
+ Sets the font's variation axes using normalized coordinate values.
+
@@ -621,9 +621,9 @@
- To be added.
- To be added.
- To be added.
+ The zero-based index of the named instance to apply.
+ Sets the font's variation axes to match the specified named instance.
+
@@ -642,9 +642,9 @@
- To be added.
- To be added.
- To be added.
+ The variation tag-value pairs to apply. Unspecified axes retain their current values.
+ Sets one or more variation axes on the font using tag-value pairs.
+
@@ -1250,9 +1250,9 @@
System.Int32[]
- To be added.
- To be added.
- To be added.
+ Gets the current normalized variation axis coordinates for the font.
+ An array of normalized coordinate values (each in the range -16384 to +16384), one per variation axis.
+
diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml
index 719b610c..98cf2e75 100644
--- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml
+++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml
@@ -73,8 +73,8 @@
- To be added.
- To be added.
+ This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code.
+
diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml
index f6a6007e..37811d63 100644
--- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml
+++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml
@@ -70,13 +70,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Gdk.Rectangle.
+ A Gdk.Rectangle with the same integer bounds as .
+
@@ -90,13 +90,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Gdk.RGBA.
+ A Gdk.RGBA with the corresponding red, green, blue, and alpha components normalized to the range [0, 1].
+
@@ -110,13 +110,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Gdk.RGBA.
+ A Gdk.RGBA with the corresponding red, green, blue, and alpha components.
+
@@ -130,13 +130,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Graphene.Point.
+ A Graphene.Point with the same X and Y coordinates.
+
@@ -150,13 +150,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Graphene.Point3D.
+ A Graphene.Point3D with the same X, Y, and Z coordinates.
+
@@ -170,13 +170,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Graphene.Rect.
+ A Graphene.Rect with the same origin and size.
+
@@ -190,13 +190,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Converts an to a Graphene.Size.
+ A Graphene.Size with the same width and height.
+
@@ -491,13 +491,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Gdk.RGBA to convert.
+ Converts a Gdk.RGBA to an .
+ An with components scaled from the [0, 1] range to [0, 255].
+
@@ -511,13 +511,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Gdk.RGBA to convert.
+ Converts a Gdk.RGBA to an .
+ An with the corresponding red, green, blue, and alpha components.
+
@@ -594,13 +594,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Graphene.Point to convert.
+ Converts a Graphene.Point to an .
+ An with the same X and Y coordinates.
+
@@ -614,13 +614,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Graphene.Point3D to convert.
+ Converts a Graphene.Point3D to an .
+ An with the same X, Y, and Z coordinates.
+
@@ -665,13 +665,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Graphene.Rect to convert.
+ Converts a Graphene.Rect to an .
+ An with the same origin and size.
+
@@ -720,13 +720,13 @@
-
+
- To be added.
- To be added.
- To be added.
- To be added.
+ The Graphene.Size to convert.
+ Converts a Graphene.Size to an .
+ An with the same width and height.
+
diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml
index e23eec26..b2ebbf17 100644
--- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml
+++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml
@@ -89,8 +89,8 @@
- To be added.
- To be added.
+ Releases the resources used by the current instance of the class.
+
diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml
index c216be8c..78d84f0c 100644
--- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml
+++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml
@@ -15,8 +15,30 @@
- To be added.
- To be added.
+ Describes the component swizzle mapping for a Vulkan YCbCr sampler conversion.
+ ) that
+determines which source component feeds each destination channel.
+
+Use this struct when constructing a to
+configure a Vulkan YCbCr-converted image for use with SkiaSharp's GPU back-end.
+
+## Examples
+
+```csharp
+var components = new GRVkYcbcrComponents
+{
+ R = 0, // VK_COMPONENT_SWIZZLE_IDENTITY
+ G = 0,
+ B = 0,
+ A = 0,
+};
+```
+]]>
@@ -37,9 +59,9 @@
System.UInt32
- To be added.
- To be added.
- To be added.
+ Gets or sets the component swizzle value that maps to the alpha channel.
+ A VkComponentSwizzle value (as an unsigned integer) specifying the source channel for the alpha component.
+
@@ -60,9 +82,9 @@
System.UInt32
- To be added.
- To be added.
- To be added.
+ Gets or sets the component swizzle value that maps to the blue channel.
+ A VkComponentSwizzle value (as an unsigned integer) specifying the source channel for the blue component.
+
@@ -89,10 +111,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if the two instances are equal; otherwise, .
+
@@ -116,10 +138,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is a and is equal to the current instance; otherwise, .
+
@@ -140,9 +162,9 @@
System.UInt32
- To be added.
- To be added.
- To be added.
+ Gets or sets the component swizzle value that maps to the green channel.
+ A VkComponentSwizzle value (as an unsigned integer) specifying the source channel for the green component.
+
@@ -164,9 +186,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -186,11 +208,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are equal.
+ if is equal to ; otherwise, .
+
@@ -210,11 +232,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are not equal.
+ if is not equal to ; otherwise, .
+
@@ -235,9 +257,9 @@
System.UInt32
- To be added.
- To be added.
- To be added.
+ Gets or sets the component swizzle value that maps to the red channel.
+ A VkComponentSwizzle value (as an unsigned integer) specifying the source channel for the red component.
+
diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml
index 0828f037..010815ec 100644
--- a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml
+++ b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml
@@ -68,9 +68,9 @@
SkiaSharp.GRVkYcbcrComponents
- To be added.
- To be added.
- To be added.
+ Gets or sets the component swizzle mapping for the YCbCr conversion.
+ A value describing how each channel is remapped.
+
@@ -351,9 +351,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets or sets a value indicating whether the sampler filter must match the chroma filter.
+ if the sampler filter must match the chroma reconstruction filter; otherwise, .
+
@@ -374,9 +374,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets or sets a value indicating whether the image supports linear filtering during YCbCr conversion.
+ if linear filtering is supported; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml
index 936510d8..8a84f9c1 100644
--- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml
@@ -3000,12 +3000,12 @@ contours intersect each other (think ).
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The surface to draw.
+ The point at which to position the top-left corner of the surface image.
+ The sampling options to use when scaling or filtering the surface image.
+ The paint to apply, or to draw without additional effects.
+ Draws the specified surface onto this canvas at the given point, using the specified sampling options.
+
@@ -3059,13 +3059,13 @@ contours intersect each other (think ).
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The surface to draw.
+ The x-coordinate of the top-left corner of the surface image.
+ The y-coordinate of the top-left corner of the surface image.
+ The sampling options to use when scaling or filtering the surface image.
+ The paint to apply, or to draw without additional effects.
+ Draws the specified surface onto this canvas at the given coordinates, using the specified sampling options.
+
@@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use
-
-
-
+
+
+
Method
SkiaSharp
- 3.116.0.0
- 3.119.0.0
- 4.147.0.0
+ 2.80.0.0
+ 2.88.0.0
System.Void
-
-
-
- [System.Runtime.CompilerServices.IsReadOnly]
-
-
-
+
- The matrix to set as the current transformation matrix.
+ The matrix that will be copied into the current matrix.
Replaces the current matrix with a copy of the specified matrix.
-
-
-
+
+
+
Method
SkiaSharp
- 2.80.0.0
- 2.88.0.0
+ 3.116.0.0
+ 3.119.0.0
+ 4.147.0.0
System.Void
-
+
+
+
+ [System.Runtime.CompilerServices.IsReadOnly]
+
+
+
- The matrix that will be copied into the current matrix.
+ The matrix to set as the current transformation matrix.
Replaces the current matrix with a copy of the specified matrix.
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml
index 9e7e0d87..3f1d41c4 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml
@@ -36,11 +36,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ One of the enumeration values that identifies the color primaries as defined by ITU-T H.273.
+ One of the enumeration values that identifies the opto-electronic transfer function as defined by ITU-T H.273.
+ Creates a color space from CICP (Coding-Independent Code Points) primaries and transfer function identifiers.
+ A new that corresponds to the specified CICP parameters, or if the combination is not supported.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml
index 50e64301..6bccd0a9 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml
@@ -155,7 +155,7 @@
25
- To be added.
+ Stores BGRA pixels as four 10-bit extended-range (XR) components packed into 64 bits (8 bytes per pixel).
@@ -234,7 +234,7 @@
27
- To be added.
+ Stores a single red channel as a 16-bit unsigned normalized value (2 bytes per pixel).
@@ -519,7 +519,7 @@
26
- To be added.
+ Stores RGB channels as three 16-bit floating-point values with a 16-bit padding component (8 bytes per pixel). The fourth component is unused.
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
index 6648c6d8..c9b13827 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml
@@ -10,8 +10,29 @@
System.Enum
- To be added.
- To be added.
+ Specifies the color primaries of a color space using CICP (Coding-Independent Code Points) codes as defined in ITU-T H.273.
+ when calling
+ to create an `SKColorSpace` from
+CICP metadata embedded in images (such as AVIF, HEIF, or JPEG XL).
+
+## Examples
+
+```csharp
+// Create the sRGB-equivalent color space via CICP codes
+var colorSpace = SKColorSpace.CreateCicp(
+ SKColorspacePrimariesCicp.Rec709,
+ SKColorspaceTransferFnCicp.Iec6196621);
+```
+]]>
@@ -28,7 +49,7 @@
8
- To be added.
+ Color primaries for generic film (Illuminant C).
@@ -45,7 +66,7 @@
22
- To be added.
+ Color primaries corresponding to ITU-T H.273 value 22 (EBU Tech 3213-E).
@@ -62,7 +83,7 @@
9
- To be added.
+ Color primaries for ITU-R BT.2020 and BT.2100 wide-color-gamut content.
@@ -79,7 +100,7 @@
5
- To be added.
+ Color primaries for ITU-R BT.470 System B and G (European broadcast television).
@@ -96,7 +117,7 @@
4
- To be added.
+ Color primaries for ITU-R BT.470 System M (North American analog broadcast).
@@ -113,7 +134,7 @@
6
- To be added.
+ Color primaries for ITU-R BT.601 standard definition television.
@@ -130,7 +151,7 @@
1
- To be added.
+ Color primaries for ITU-R BT.709 high-definition television (sRGB primaries).
@@ -147,7 +168,7 @@
12
- To be added.
+ Color primaries for SMPTE EG 432-1 (P3-D65 display).
@@ -164,7 +185,7 @@
11
- To be added.
+ Color primaries for SMPTE RP 431-2 (P3-DCI theater projector).
@@ -181,7 +202,7 @@
7
- To be added.
+ Color primaries for SMPTE ST 240 (early HDTV standard).
@@ -198,7 +219,7 @@
10
- To be added.
+ Color primaries for SMPTE ST 428-1 (D-Cinema Distribution Master).
@@ -215,7 +236,7 @@
0
- To be added.
+ The color primaries are unspecified or not recognized.
diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml
index bddb849d..f6bcd940 100644
--- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml
@@ -10,8 +10,29 @@
System.Enum
- To be added.
- To be added.
+ Specifies the opto-electronic transfer function of a color space using CICP (Coding-Independent Code Points) codes as defined in ITU-T H.273.
+ when calling
+ to create an `SKColorSpace` from
+CICP metadata embedded in images (such as AVIF, HEIF, or JPEG XL).
+
+## Examples
+
+```csharp
+// Create an HDR10 color space using BT.2020 primaries and PQ transfer function
+var colorSpace = SKColorSpace.CreateCicp(
+ SKColorspacePrimariesCicp.Rec2020,
+ SKColorspaceTransferFnCicp.Pq);
+```
+]]>
@@ -28,7 +49,7 @@
18
- To be added.
+ Hybrid Log-Gamma (HLG) transfer function defined in ITU-R BT.2100, used for HDR broadcast.
@@ -45,7 +66,7 @@
13
- To be added.
+ Transfer function defined in IEC 61966-2-1 (sRGB).
@@ -62,7 +83,7 @@
11
- To be added.
+ Transfer function defined in IEC 61966-2-4 (xvYCC).
@@ -79,7 +100,7 @@
8
- To be added.
+ Linear transfer function (no gamma encoding).
@@ -96,7 +117,7 @@
16
- To be added.
+ Perceptual Quantizer (PQ/SMPTE ST 2084) transfer function, used for HDR10 and Dolby Vision.
@@ -113,7 +134,7 @@
14
- To be added.
+ Transfer function for ITU-R BT.2020 10-bit content.
@@ -130,7 +151,7 @@
15
- To be added.
+ Transfer function for ITU-R BT.2020 12-bit content.
@@ -147,7 +168,7 @@
5
- To be added.
+ Transfer function for ITU-R BT.470 System B and G (assumed display gamma).
@@ -164,7 +185,7 @@
4
- To be added.
+ Transfer function for ITU-R BT.470 System M (assumed display gamma).
@@ -181,7 +202,7 @@
6
- To be added.
+ Transfer function for ITU-R BT.601 standard definition television.
@@ -198,7 +219,7 @@
1
- To be added.
+ Transfer function for ITU-R BT.709 high-definition television.
@@ -215,7 +236,7 @@
7
- To be added.
+ Transfer function for SMPTE ST 240 (early HDTV standard).
@@ -232,7 +253,7 @@
17
- To be added.
+ Transfer function for SMPTE ST 428-1 (D-Cinema Distribution Master).
@@ -249,7 +270,7 @@
0
- To be added.
+ The transfer function is unspecified or not recognized.
diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml
index c6d5588e..af790552 100644
--- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml
@@ -15,8 +15,28 @@
- To be added.
- To be added.
+ Holds configuration options for creating an XPS document with SkiaSharp.
+ . Set the desired properties and pass the struct to
+the XPS document creation method.
+
+This is a value type; no disposal is required.
+
+## Examples
+
+```csharp
+var options = new SKDocumentXpsOptions
+{
+ Dpi = 300,
+ AllowNoPngs = false,
+};
+using var stream = File.OpenWrite("output.xps");
+using var doc = SKDocument.CreateXps(stream, options);
+```
+]]>
@@ -37,9 +57,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets or sets a value indicating whether the encoder is allowed to omit PNG image compression.
+ if the encoder is allowed to omit PNG encoding; otherwise, .
+
@@ -60,9 +80,9 @@
System.Single
- To be added.
- To be added.
- To be added.
+ Gets or sets the dots per inch (DPI) used when rasterizing content in the XPS document.
+ The resolution in dots per inch. A value of 0 uses the default resolution.
+
@@ -89,10 +109,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if the two instances are equal; otherwise, .
+
@@ -116,10 +136,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is an and is equal to the current instance; otherwise, .
+
@@ -141,9 +161,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -163,11 +183,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are equal.
+ if is equal to ; otherwise, .
+
@@ -187,11 +207,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are not equal.
+ if is not equal to ; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml
index 57ae755b..e7f5cf14 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml
@@ -19,8 +19,33 @@
- To be added.
- To be added.
+ Specifies the arguments used to customize a typeface, including variation positions, collection index, and palette settings.
+ via
+. It bundles variation design position,
+collection index, palette index, and per-entry palette color overrides into
+a single value.
+
+Because it is a `ref struct`, it cannot be stored on the heap or boxed.
+
+## Examples
+
+```csharp
+var args = new SKFontArguments
+{
+ CollectionIndex = 0,
+ PaletteIndex = 1,
+ VariationDesignPosition = new SKFontVariationPositionCoordinate[]
+ {
+ new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 },
+ },
+};
+using var boldTypeface = typeface.Clone(args);
+```
+]]>
@@ -41,9 +66,9 @@
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets or sets the zero-based index of the typeface within a font collection.
+ The zero-based index into a TTC font collection. Use 0 for non-collection fonts.
+
@@ -64,9 +89,9 @@
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets or sets the zero-based index of the CPAL color palette to use.
+ The zero-based index of the color palette defined in the font's CPAL table.
+
@@ -87,9 +112,9 @@
System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride>
- To be added.
- To be added.
- To be added.
+ Gets or sets the per-entry color overrides to apply to the selected palette.
+ A read-only span of values that replace specific palette color entries.
+
@@ -110,9 +135,9 @@
System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate>
- To be added.
- To be added.
- To be added.
+ Gets or sets the variation axis coordinates that define the desired design position.
+ A read-only span of values specifying the axis tag and value for each variation axis to set.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml
index 64ca610d..e0018b31 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml
@@ -15,8 +15,30 @@
- To be added.
- To be added.
+ Represents a single color entry override to apply to a font's CPAL color palette.
+ value (stored as an ARGB-packed `uint`). Provide
+an array of overrides via
+when calling to customize the colors of a
+color font without creating a completely new palette.
+
+This is a value type; no disposal is required.
+
+## Examples
+
+```csharp
+// Override the first palette entry to red
+var overrides = new SKFontPaletteOverride[]
+{
+ new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red },
+};
+var args = new SKFontArguments { PaletteOverrides = overrides };
+using var customTypeface = typeface.Clone(args);
+```
+]]>
@@ -37,9 +59,9 @@
System.UInt32
- To be added.
- To be added.
- To be added.
+ Gets or sets the replacement color for this palette entry, packed as an ARGB value.
+ An ARGB-packed value (0xAARRGGBB) to use instead of the font's built-in palette color.
+
@@ -66,10 +88,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if the two instances are equal; otherwise, .
+
@@ -93,10 +115,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is an and is equal to the current instance; otherwise, .
+
@@ -118,9 +140,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -141,9 +163,9 @@
System.UInt16
- To be added.
- To be added.
- To be added.
+ Gets or sets the zero-based index of the palette color entry to override.
+ The zero-based index into the font's CPAL palette that this override applies to.
+
@@ -163,11 +185,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are equal.
+ if is equal to ; otherwise, .
+
@@ -187,11 +209,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are not equal.
+ if is not equal to ; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml
index 8696fae6..92e0dec9 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml
@@ -15,8 +15,33 @@
- To be added.
- To be added.
+ Describes a single OpenType variable font axis, including its four-byte tag, name ID, value range, and default value.
+ or the
+ property.
+
+Each axis has a four-byte (such as
+`wght` for weight or `wdth` for width), a floating-point value range given by
+ and
+, and a
+ value.
+
+This is a value type; no disposal is required.
+
+## Examples
+
+```csharp
+var axes = typeface.VariationDesignParameters;
+foreach (var axis in axes)
+{
+ Console.WriteLine($"Axis: {axis.Tag}, Range: [{axis.Min}, {axis.Max}], Default: {axis.Default}");
+}
+```
+]]>
@@ -37,9 +62,9 @@
System.Single
- To be added.
- To be added.
- To be added.
+ Gets or sets the default design-space value for this variation axis.
+ The default floating-point value within the range defined by and .
+
@@ -66,10 +91,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if the two instances are equal; otherwise, .
+
@@ -93,10 +118,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is an and is equal to the current instance; otherwise, .
+
@@ -118,9 +143,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -141,9 +166,9 @@
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets or sets a value indicating whether this axis should be hidden from end-user interfaces.
+ if the axis is marked as hidden in the font's fvar table; otherwise, .
+
@@ -164,9 +189,9 @@
System.Single
- To be added.
- To be added.
- To be added.
+ Gets or sets the maximum design-space value for this variation axis.
+ The maximum floating-point value that this axis accepts.
+
@@ -187,9 +212,9 @@
System.Single
- To be added.
- To be added.
- To be added.
+ Gets or sets the minimum design-space value for this variation axis.
+ The minimum floating-point value that this axis accepts.
+
@@ -209,11 +234,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are equal.
+ if is equal to ; otherwise, .
+
@@ -233,11 +258,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are not equal.
+ if is not equal to ; otherwise, .
+
@@ -258,9 +283,9 @@
SkiaSharp.SKFourByteTag
- To be added.
- To be added.
- To be added.
+ Gets or sets the four-byte tag that identifies this variation axis.
+ An such as wght (weight) or wdth (width).
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml
index bdaf5a82..358d3334 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml
@@ -15,8 +15,30 @@
- To be added.
- To be added.
+ Represents a single axis tag and design-space value that together specify one dimension of a variable font's design position.
+
+to define the full position within a variable font's design space when calling
+.
+
+This is a value type; no disposal is required.
+
+## Examples
+
+```csharp
+var position = new SKFontVariationPositionCoordinate[]
+{
+ new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700f },
+ new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wdth"), Value = 75f },
+};
+var args = new SKFontArguments { VariationDesignPosition = position };
+using var customTypeface = typeface.Clone(args);
+```
+]]>
@@ -37,9 +59,9 @@
SkiaSharp.SKFourByteTag
- To be added.
- To be added.
- To be added.
+ Gets or sets the four-byte tag identifying the variation axis.
+ An such as wght (weight) or wdth (width).
+
@@ -66,10 +88,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if the two instances are equal; otherwise, .
+
@@ -93,10 +115,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is an and is equal to the current instance; otherwise, .
+
@@ -118,9 +140,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -140,11 +162,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are equal.
+ if is equal to ; otherwise, .
+
@@ -164,11 +186,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two instances are not equal.
+ if is not equal to ; otherwise, .
+
@@ -189,9 +211,9 @@
System.Single
- To be added.
- To be added.
- To be added.
+ Gets or sets the design-space value for the variation axis identified by .
+ A floating-point value within the range defined by the corresponding .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml
index 184c1aca..be65b4b1 100644
--- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml
@@ -20,8 +20,41 @@
- To be added.
- To be added.
+ Represents a packed four-byte (four-character) tag used in font tables, OpenType features, and Skia APIs.
+
@@ -37,9 +70,9 @@
- To be added.
- To be added.
- To be added.
+ The raw 32-bit value representing the packed four-byte tag.
+ Initializes a new instance of the struct from a raw unsigned integer value.
+
@@ -58,12 +91,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first character (most significant byte).
+ The second character.
+ The third character.
+ The fourth character (least significant byte).
+ Initializes a new instance of the struct from four individual characters.
+
@@ -85,10 +118,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to compare with the current instance.
+ Determines whether the specified is equal to the current instance.
+ if has the same value as the current instance; otherwise, .
+
@@ -112,10 +145,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The object to compare with the current instance.
+ Determines whether the specified object is equal to the current instance.
+ if the specified object is an with the same value; otherwise, .
+
@@ -132,9 +165,9 @@
- To be added.
- To be added.
- To be added.
+ Returns a hash code for the current instance.
+ A hash code for the current instance.
+
@@ -154,11 +187,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two values are equal.
+ if is equal to ; otherwise, .
+
@@ -177,10 +210,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The to convert.
+ Implicitly converts an to its underlying value.
+ The raw 32-bit unsigned integer representation of the tag.
+
@@ -199,10 +232,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The raw 32-bit unsigned integer to convert.
+ Implicitly converts a value to an .
+ An wrapping the specified unsigned integer value.
+
@@ -222,11 +255,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first to compare.
+ The second to compare.
+ Determines whether two values are not equal.
+ if is not equal to ; otherwise, .
+
@@ -250,10 +283,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The string to parse. Only the first four characters are used; shorter strings are padded with spaces.
+ Creates an from a string of up to four characters.
+ An whose bytes correspond to the first four characters of the string, padded with spaces if the string is shorter than four characters. Returns a zero-valued tag if the string is or empty.
+
@@ -275,9 +308,9 @@
- To be added.
- To be added.
- To be added.
+ Returns the four-character string representation of this tag.
+ A four-character string where each character corresponds to one byte of the packed tag value.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml
index 7c0d12f2..c24b20c9 100644
--- a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml
@@ -1571,9 +1571,9 @@
-
-
-
+
+
+
Method
SkiaSharp
@@ -1593,7 +1593,7 @@
-
+
The target matrix.
@@ -1603,9 +1603,9 @@
-
-
-
+
+
+
Method
SkiaSharp
@@ -1625,7 +1625,7 @@
-
+
The target matrix.
diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml
index 9ed1121c..c1ebfd84 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml
@@ -1446,11 +1446,11 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
@@ -1633,12 +1633,12 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ A transform matrix to apply to the source path before processing.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
@@ -1659,12 +1659,12 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ A bounding rectangle used to cull geometry outside the region of interest.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
@@ -1685,12 +1685,12 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ A scale factor that hints at the intended rendering resolution, used to adjust path effect precision.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
@@ -1844,13 +1844,13 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ A bounding rectangle used to cull geometry outside the region of interest.
+ A transform matrix to apply to the source path before processing.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
@@ -1872,13 +1872,13 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source path to process.
+ The that receives the filled path geometry.
+ A bounding rectangle used to cull geometry outside the region of interest.
+ A scale factor that hints at the intended rendering resolution, used to adjust path effect precision.
+ Applies the paint's stroke, path effect, and other geometry-affecting settings to the source path, writing the result into the destination builder.
+ if the resulting path is non-empty; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml
index 43a0842d..f194f64d 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPath.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml
@@ -1582,9 +1582,9 @@ the first point is automatically set to (0, 0).
System.IntPtr
- To be added.
- To be added.
- To be added.
+ Gets or sets the native handle of the underlying Skia path object.
+ The handle to the native SkPath object.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml
index 4b53c0fb..f41de8d1 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml
@@ -11,8 +11,32 @@
- To be added.
- To be added.
+ Builds an incrementally by accumulating path verbs (move, line, curve, arc, close) before producing the final path.
+
@@ -26,8 +50,8 @@
- To be added.
- To be added.
+ Initializes a new instance of the class, pre-populated with the contents of the specified path.
+
@@ -43,9 +67,9 @@
- To be added.
- To be added.
- To be added.
+ The existing path whose verbs and points are copied into the new builder.
+ Initializes a new instance of the class, pre-populated with the contents of the specified path.
+
@@ -66,11 +90,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The bounding rectangle of the oval that contains the arc.
+ The angle in degrees at which the arc begins, measured clockwise from the positive x-axis.
+ The sweep angle in degrees. Positive values sweep clockwise.
+ Appends an arc of the given oval as a new contour to the path.
+
@@ -92,12 +116,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the circle's center.
+ The y-coordinate of the circle's center.
+ The radius of the circle.
+ One of the enumeration values that specifies whether the circle is drawn clockwise or counter-clockwise.
+ Appends a circle as a new closed contour to the path.
+
@@ -117,10 +141,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The bounding rectangle of the oval.
+ One of the enumeration values that specifies whether the oval is drawn clockwise or counter-clockwise.
+ Appends an oval inscribed in the specified rectangle as a new closed contour to the path.
+
@@ -140,10 +164,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The path whose contours are appended.
+ One of the enumeration values that specifies how the path is appended.
+ Appends all contours from the specified path.
+
@@ -170,11 +194,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The path whose contours are appended.
+ The transform matrix to apply to each point of the appended path.
+ One of the enumeration values that specifies how the path is appended.
+ Appends all contours from the specified path, transformed by the given matrix.
+
@@ -196,12 +220,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The path whose contours are appended.
+ The horizontal translation offset.
+ The vertical translation offset.
+ One of the enumeration values that specifies how the path is appended.
+ Appends all contours from the specified path, translated by the given offset.
+
@@ -221,10 +245,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The vertices of the polygon.
+ to close the contour with a line back to the first point; otherwise, .
+ Appends a polygon defined by the given points as a new contour.
+
@@ -244,10 +268,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The vertices of the polygon.
+ to close the contour with a line back to the first point; otherwise, .
+ Appends a polygon defined by the given points as a new contour.
+
@@ -267,10 +291,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The rectangle to append.
+ One of the enumeration values that specifies whether the rectangle is drawn clockwise or counter-clockwise.
+ Appends a rectangle as a new closed contour to the path.
+
@@ -291,11 +315,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The rectangle to append.
+ One of the enumeration values that specifies whether the rectangle is drawn clockwise or counter-clockwise.
+ The zero-based corner index (0–3) at which the contour begins.
+ Appends a rectangle as a new closed contour, starting at the specified corner index.
+
@@ -315,10 +339,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The rounded rectangle to append.
+ One of the enumeration values that specifies whether the contour is drawn clockwise or counter-clockwise.
+ Appends a rounded rectangle as a new closed contour to the path.
+
@@ -339,11 +363,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The rounded rectangle to append.
+ One of the enumeration values that specifies whether the contour is drawn clockwise or counter-clockwise.
+ The zero-based index of the corner at which the contour begins.
+ Appends a rounded rectangle as a new closed contour, starting at the specified corner index.
+
@@ -365,12 +389,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The bounding rectangle.
+ The horizontal radius of the rounded corners.
+ The vertical radius of the rounded corners.
+ One of the enumeration values that specifies whether the contour is drawn clockwise or counter-clockwise.
+ Appends a rounded rectangle (with uniform corner radii) as a new closed contour to the path.
+
@@ -391,11 +415,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first tangent point.
+ The second tangent point and the end of the arc.
+ The radius of the arc.
+ Appends an arc tangent to the line from the current point to and from to , using the specified radius.
+
@@ -417,12 +441,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The bounding rectangle of the oval that contains the arc.
+ The starting angle of the arc in degrees, measured clockwise from the positive x-axis.
+ The sweep angle in degrees. Positive values sweep clockwise.
+ to begin a new contour at the arc's start point; otherwise, to connect from the current point.
+ Appends an arc of the given oval, optionally starting with a move-to at the arc's start point.
+
@@ -445,13 +469,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x and y radii of the arc's ellipse.
+ The rotation of the ellipse's x-axis in degrees.
+ One of the enumeration values that specifies whether the large or small arc is drawn.
+ One of the enumeration values that specifies the direction of the arc.
+ The endpoint of the arc.
+ Appends an SVG-style arc to the current contour using radii and endpoint parameters.
+
@@ -474,13 +498,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the first tangent point.
+ The y-coordinate of the first tangent point.
+ The x-coordinate of the second tangent point.
+ The y-coordinate of the second tangent point.
+ The radius of the arc.
+ Appends an arc tangent to the two lines defined by the given points, using the specified radius.
+
@@ -505,15 +529,15 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-radius of the arc's ellipse.
+ The y-radius of the arc's ellipse.
+ The rotation of the ellipse's x-axis in degrees.
+ One of the enumeration values that specifies whether the large or small arc is drawn.
+ One of the enumeration values that specifies the direction of the arc.
+ The x-coordinate of the arc endpoint.
+ The y-coordinate of the arc endpoint.
+ Appends an SVG-style arc to the current contour using individual radius and endpoint components.
+
@@ -530,8 +554,8 @@
- To be added.
- To be added.
+ Closes the current contour by appending a line to the start of the contour, if necessary.
+
@@ -552,11 +576,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The control point of the conic.
+ The end point of the conic.
+ The weight of the conic, which controls the curve's pull toward the control point.
+ Appends a conic (rational quadratic Bézier) curve to the current contour using point values.
+
@@ -579,13 +603,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the control point.
+ The y-coordinate of the control point.
+ The x-coordinate of the end point.
+ The y-coordinate of the end point.
+ The weight of the conic, which controls the curve's pull toward the control point.
+ Appends a conic (rational quadratic Bézier) curve to the current contour using scalar values.
+
@@ -606,11 +630,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The first control point.
+ The second control point.
+ The end point of the curve.
+ Appends a cubic Bézier curve to the current contour using point values.
+
@@ -634,14 +658,14 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the first control point.
+ The y-coordinate of the first control point.
+ The x-coordinate of the second control point.
+ The y-coordinate of the second control point.
+ The x-coordinate of the end point.
+ The y-coordinate of the end point.
+ Appends a cubic Bézier curve to the current contour using scalar values.
+
@@ -658,9 +682,9 @@
- To be added.
- To be added.
- To be added.
+ Transfers the built path to a new and resets this builder to an empty state.
+ A new containing all verbs accumulated since the last reset.
+
@@ -679,9 +703,9 @@
- To be added.
- To be added.
- To be added.
+ to release both managed and unmanaged resources; to release only unmanaged resources.
+ Called by the and methods to release the managed and unmanaged resources used by the current instance of the class.
+
@@ -698,8 +722,8 @@
- To be added.
- To be added.
+ Releases the native resources held by the current instance of the class.
+
@@ -715,9 +739,9 @@
SkiaSharp.SKPathFillType
- To be added.
- To be added.
- To be added.
+ Gets or sets the fill rule used to determine which regions are inside the path.
+ One of the values.
+
@@ -736,9 +760,9 @@
- To be added.
- To be added.
- To be added.
+ The end point of the line.
+ Appends a straight line from the current point to the specified point.
+
@@ -758,10 +782,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the end point.
+ The y-coordinate of the end point.
+ Appends a straight line from the current point to the specified coordinates.
+
@@ -780,9 +804,9 @@
- To be added.
- To be added.
- To be added.
+ The starting point of the new contour.
+ Begins a new contour at the specified point.
+
@@ -802,10 +826,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the starting point.
+ The y-coordinate of the starting point.
+ Begins a new contour at the specified coordinates.
+
@@ -825,10 +849,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The control point of the curve.
+ The end point of the curve.
+ Appends a quadratic Bézier curve to the current contour using point values.
+
@@ -850,12 +874,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-coordinate of the control point.
+ The y-coordinate of the control point.
+ The x-coordinate of the end point.
+ The y-coordinate of the end point.
+ Appends a quadratic Bézier curve to the current contour using scalar values.
+
@@ -878,13 +902,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x and y radii of the arc's ellipse.
+ The rotation of the ellipse's x-axis in degrees.
+ One of the enumeration values that specifies whether the large or small arc is drawn.
+ One of the enumeration values that specifies the direction of the arc.
+ The endpoint of the arc, relative to the current point.
+ Appends an SVG-style arc relative to the current point, using radii and endpoint parameters.
+
@@ -909,15 +933,15 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-radius of the arc's ellipse.
+ The y-radius of the arc's ellipse.
+ The rotation of the ellipse's x-axis in degrees.
+ One of the enumeration values that specifies whether the large or small arc is drawn.
+ One of the enumeration values that specifies the direction of the arc.
+ The x-component of the arc endpoint, relative to the current point.
+ The y-component of the arc endpoint, relative to the current point.
+ Appends an SVG-style arc relative to the current point using individual components.
+
@@ -938,11 +962,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The offset to the control point from the current point.
+ The offset to the end point from the current point.
+ The weight of the conic, which controls the curve's pull toward the control point.
+ Appends a conic curve relative to the current point, using point offsets.
+
@@ -965,13 +989,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-offset to the control point from the current point.
+ The y-offset to the control point from the current point.
+ The x-offset to the end point from the current point.
+ The y-offset to the end point from the current point.
+ The weight of the conic, which controls the curve's pull toward the control point.
+ Appends a conic curve relative to the current point, using scalar offsets.
+
@@ -992,11 +1016,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The offset to the first control point from the current point.
+ The offset to the second control point from the current point.
+ The offset to the end point from the current point.
+ Appends a cubic Bézier curve relative to the current point, using point offsets.
+
@@ -1020,14 +1044,14 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-offset to the first control point from the current point.
+ The y-offset to the first control point from the current point.
+ The x-offset to the second control point from the current point.
+ The y-offset to the second control point from the current point.
+ The x-offset to the end point from the current point.
+ The y-offset to the end point from the current point.
+ Appends a cubic Bézier curve relative to the current point, using scalar offsets.
+
@@ -1044,8 +1068,8 @@
- To be added.
- To be added.
+ Clears all verbs and points from the builder, returning it to an empty state.
+
@@ -1064,9 +1088,9 @@
- To be added.
- To be added.
- To be added.
+ The path whose contours are appended in reverse.
+ Appends all contours from the specified path in reverse order.
+
@@ -1085,9 +1109,9 @@
- To be added.
- To be added.
- To be added.
+ The offset from the current point to the end of the line.
+ Appends a line from the current point to a point offset by the given vector.
+
@@ -1107,10 +1131,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-offset from the current point.
+ The y-offset from the current point.
+ Appends a line from the current point to a point offset by the given deltas.
+
@@ -1129,9 +1153,9 @@
- To be added.
- To be added.
- To be added.
+ The offset from the current point to the start of the new contour.
+ Begins a new contour at a point offset from the current point by the given vector.
+
@@ -1151,10 +1175,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-offset from the current point.
+ The y-offset from the current point.
+ Begins a new contour at a point offset from the current point by the given deltas.
+
@@ -1174,10 +1198,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The offset to the control point from the current point.
+ The offset to the end point from the current point.
+ Appends a quadratic Bézier curve relative to the current point, using point offsets.
+
@@ -1199,12 +1223,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The x-offset to the control point from the current point.
+ The y-offset to the control point from the current point.
+ The x-offset to the end point from the current point.
+ The y-offset to the end point from the current point.
+ Appends a quadratic Bézier curve relative to the current point, using scalar offsets.
+
@@ -1221,9 +1245,9 @@
- To be added.
- To be added.
- To be added.
+ Creates a snapshot of the current path without resetting the builder.
+ A new containing all verbs accumulated so far. The builder continues to accumulate further verbs.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
index 6a11f5f7..1f680e80 100644
--- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml
@@ -345,13 +345,13 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The distance along the path at which the segment begins.
+ The distance along the path at which the segment ends.
+ The that receives the extracted path segment.
+ to prepend a move-to command at the start of the segment; otherwise, .
+ Extracts a segment of the path between the two specified distances and writes it into a path builder.
+ if the segment was successfully extracted; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml
index fc269d5a..5595b801 100644
--- a/SkiaSharpAPI/SkiaSharp/SKStream.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKStream.xml
@@ -33,9 +33,9 @@
- To be added.
- To be added.
- To be added.
+ Reads the entire contents of the stream and returns them as an object.
+ An containing all bytes from the stream, or if the stream does not support random access.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml
index 953c3d3b..0e11ea1a 100644
--- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml
@@ -2826,12 +2826,12 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The destination canvas to draw onto.
+ The point at which to position the top-left corner of the surface image.
+ The sampling options to use when scaling or filtering the surface image.
+ The paint to apply, or to draw without additional effects.
+ Draws this surface onto the specified canvas at the given point, using the specified sampling options.
+
@@ -2885,13 +2885,13 @@ The example above produces the following:
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The destination canvas to draw onto.
+ The x-coordinate of the top-left corner of the surface image.
+ The y-coordinate of the top-left corner of the surface image.
+ The sampling options to use when scaling or filtering the surface image.
+ The paint to apply, or to draw without additional effects.
+ Draws this surface onto the specified canvas at the given coordinates, using the specified sampling options.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml
index b0f4c2f3..2fbeb7eb 100644
--- a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml
@@ -118,10 +118,10 @@ Typeface objects are immutable, and so they can be shared between threads.
- To be added.
- To be added.
- To be added.
- To be added.
+ The font arguments specifying the variation design position, collection index, palette index, and palette color overrides.
+ Creates a new typeface cloned from this one, applying the specified font arguments.
+ A new configured with the variation position, collection index, palette index, and palette overrides specified in .
+
@@ -140,10 +140,10 @@ Typeface objects are immutable, and so they can be shared between threads.
- To be added.
- To be added.
- To be added.
- To be added.
+ The zero-based index of the CPAL color palette to use.
+ Creates a new typeface cloned from this one, using the specified CPAL color palette index.
+ A new configured to use the specified palette.
+
@@ -162,10 +162,10 @@ Typeface objects are immutable, and so they can be shared between threads.
- To be added.
- To be added.
- To be added.
- To be added.
+ The variation axis coordinates that define the desired design position.
+ Creates a new typeface cloned from this one, with the variation axes set to the specified design position.
+ A new positioned at the specified point in the variable font's design space.
+
@@ -686,9 +686,9 @@ Typeface objects are immutable, and so they can be shared between threads.
SkiaSharp.SKTypeface
- To be added.
- To be added.
- To be added.
+ Gets a typeface with no glyphs, used as a safe non-null placeholder.
+ A shared empty instance that contains no glyphs.
+
@@ -1745,10 +1745,10 @@ using (var surface = SKSurface.Create(info)) {
- To be added.
- To be added.
- To be added.
- To be added.
+ The span to receive the variation axis descriptors.
+ Fills the provided span with information about each variation axis supported by this typeface.
+ The number of axis entries written into .
+
@@ -1767,10 +1767,10 @@ using (var surface = SKSurface.Create(info)) {
- To be added.
- To be added.
- To be added.
- To be added.
+ The span to receive the variation axis coordinates.
+ Fills the provided span with the current variation axis coordinates for this typeface.
+ The number of coordinate entries written into .
+
@@ -1859,9 +1859,9 @@ A typeface is understood to be bold when the weight is greater than or equal to
System.Boolean
- To be added.
- To be added.
- To be added.
+ Gets a value indicating whether this typeface contains no glyphs.
+ if the typeface has no glyphs (glyph count is zero); otherwise, .
+
@@ -2219,9 +2219,9 @@ A typeface is understood to be italic when it has a slant of either
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets the number of variation axes supported by this typeface.
+ The number of variation axes, or 0 if the typeface is not a variable font.
+
@@ -2237,9 +2237,9 @@ A typeface is understood to be italic when it has a slant of either
SkiaSharp.SKFontVariationAxis[]
- To be added.
- To be added.
- To be added.
+ Gets an array describing all variation axes supported by this typeface.
+ An array of values, one per variation axis, or an empty array if the typeface is not variable.
+
@@ -2255,9 +2255,9 @@ A typeface is understood to be italic when it has a slant of either
SkiaSharp.SKFontVariationPositionCoordinate[]
- To be added.
- To be added.
- To be added.
+ Gets an array of the current variation axis coordinates for this typeface.
+ An array of values representing the current design position, or an empty array if the typeface is not variable.
+
@@ -2273,9 +2273,9 @@ A typeface is understood to be italic when it has a slant of either
System.Int32
- To be added.
- To be added.
- To be added.
+ Gets the number of variation axis coordinates for the current design position of this typeface.
+ The number of variation axis coordinates, or 0 if the typeface is not a variable font.
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml
index 7343b6e0..183b8ff5 100644
--- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml
@@ -11,8 +11,29 @@
- To be added.
- To be added.
+ Provides static methods for encoding images and animated sequences to WebP format.
+ , a , or return an
+ object directly.
+
+Use for single-frame images and
+ for animated WebP files.
+
+## Examples
+
+```csharp
+using var bitmap = SKBitmap.Decode("photo.png");
+using var pixmap = bitmap.PeekPixels();
+var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90);
+using var data = SKWebpEncoder.Encode(pixmap, options);
+if (data != null)
+ File.WriteAllBytes("photo.webp", data.ToArray());
+```
+]]>
@@ -42,11 +63,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The source pixel data to encode.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified pixmap to WebP format and returns the result as an object.
+ An containing the encoded WebP bytes, or if encoding fails.
+
@@ -72,12 +93,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The stream to write the encoded WebP data to.
+ The source pixel data to encode.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified pixmap to WebP format and writes the result to the given write stream.
+ if encoding succeeded; otherwise, .
+
@@ -103,12 +124,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The stream to write the encoded WebP data to.
+ The source pixel data to encode.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified pixmap to WebP format and writes the result to the given stream.
+ if encoding succeeded; otherwise, .
+
@@ -133,11 +154,11 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The frames to include in the animated WebP.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified frames as an animated WebP and returns the result as an object.
+ An containing the encoded animated WebP bytes, or if encoding fails.
+
@@ -164,12 +185,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The stream to write the encoded animated WebP data to.
+ The frames to include in the animated WebP.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified frames as an animated WebP and writes the result to the given write stream.
+ if encoding succeeded; otherwise, .
+
@@ -196,12 +217,12 @@
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
- To be added.
+ The stream to write the encoded animated WebP data to.
+ The frames to include in the animated WebP.
+ The WebP encoding options, including compression mode and quality.
+ Encodes the specified frames as an animated WebP and writes the result to the given stream.
+ if encoding succeeded; otherwise, .
+
diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml
index ed712a08..555901c7 100644
--- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml
+++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml
@@ -11,8 +11,37 @@
- To be added.
- To be added.
+ Represents a single frame in an animated WebP sequence, combining pixel data with a display duration.
+ with a
+ duration for use with
+. Convenience constructors accept
+an or an and extract or
+create the required pixmap automatically.
+
+This is a value type; no disposal is required. However, the source bitmap or
+image used to construct the frame must remain alive for the duration of the
+encoding call.
+
+## Examples
+
+```csharp
+using var bitmap1 = SKBitmap.Decode("frame1.png");
+using var bitmap2 = SKBitmap.Decode("frame2.png");
+
+var frames = new SKWebpEncoderFrame[]
+{
+ new SKWebpEncoderFrame(bitmap1, TimeSpan.FromMilliseconds(100)),
+ new SKWebpEncoderFrame(bitmap2, TimeSpan.FromMilliseconds(100)),
+};
+var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90);
+using var data = SKWebpEncoder.EncodeAnimated(frames, options);
+if (data != null)
+ File.WriteAllBytes("animated.webp", data.ToArray());
+```
+]]>
@@ -29,10 +58,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The bitmap providing the pixel data for this frame.
+ The length of time this frame is displayed.
+ Initializes a new instance of the struct from a bitmap and a display duration.
+
@@ -49,10 +78,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The image providing the pixel data for this frame.
+ The length of time this frame is displayed.
+ Initializes a new instance of the struct from an image and a display duration.
+
@@ -69,10 +98,10 @@
- To be added.
- To be added.
- To be added.
- To be added.
+ The pixmap providing the pixel data for this frame.
+ The length of time this frame is displayed.
+ Initializes a new instance of the struct from a pixmap and a display duration.
+
@@ -93,9 +122,9 @@
System.TimeSpan
- To be added.
- To be added.
- To be added.
+ Gets or sets the length of time this frame is displayed in the animation.
+ The display duration for this frame.
+
@@ -116,9 +145,9 @@
SkiaSharp.SKPixmap
- To be added.
- To be added.
- To be added.
+ Gets or sets the pixel data for this frame.
+ The that holds the pixel data to encode for this frame.
+
diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml
index f8686330..6fcc1ca5 100644
--- a/SkiaSharpAPI/index.xml
+++ b/SkiaSharpAPI/index.xml
@@ -750,12 +750,12 @@
System.Void
-
-
-
-
-
-
+
+
+
+
+
+
The canvas to draw on.
@@ -812,13 +812,13 @@
System.Void
-
-
-
-
-
-
-
+
+
+
+
+
+
+
The canvas to draw on.
@@ -846,13 +846,13 @@
System.Void
-
-
-
-
-
-
-
+
+
+
+
+
+
+
The canvas to draw on.
@@ -912,14 +912,14 @@
System.Void
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
The canvas to draw on.
@@ -948,11 +948,11 @@
System.Void
-
-
-
-
-
+
+
+
+
+
The canvas to draw on.
@@ -1006,12 +1006,12 @@
System.Void
-
-
-
-
-
-
+
+
+
+
+
+
The canvas to draw on.
@@ -1038,12 +1038,12 @@
System.Void
-
-
-
-
-
-
+
+
+
+
+
+
The canvas to draw on.
@@ -1100,13 +1100,13 @@
System.Void
-
-
-
-
-
-
-
+
+
+
+
+
+
+
The canvas to draw on.
@@ -1204,7 +1204,7 @@
System.Int32
-
+
The color type to query.
@@ -1556,7 +1556,7 @@
SkiaSharp.SKSamplingOptions
-
+
The filter quality to convert.
@@ -3124,7 +3124,7 @@
ExtensionMethod
-
+
To be added.
@@ -3146,7 +3146,7 @@
ExtensionMethod
-
+
To be added.
@@ -3168,7 +3168,7 @@
ExtensionMethod
-
+
To be added.
@@ -3190,7 +3190,7 @@
ExtensionMethod
-
+
To be added.
@@ -3212,7 +3212,7 @@
ExtensionMethod
-
+
To be added.
@@ -3234,7 +3234,7 @@
ExtensionMethod
-
+
To be added.
@@ -3256,7 +3256,7 @@
ExtensionMethod
-
+
To be added.
@@ -3478,7 +3478,7 @@
ExtensionMethod
-
+
To be added.
@@ -3500,7 +3500,7 @@
ExtensionMethod
-
+
To be added.
@@ -3568,7 +3568,7 @@
ExtensionMethod
-
+
To be added.
@@ -3590,7 +3590,7 @@
ExtensionMethod
-
+
To be added.
@@ -3634,7 +3634,7 @@
ExtensionMethod
-
+
To be added.
@@ -3678,7 +3678,7 @@
ExtensionMethod
-
+
To be added.
@@ -4860,9 +4860,9 @@
UIKit.UIImage
-
-
-
+
+
+
The SkiaSharp bitmap.
@@ -4960,10 +4960,10 @@
UIKit.UIImage
-
-
-
-
+
+
+
+
The SkiaSharp picture.
@@ -5036,9 +5036,9 @@
UIKit.UIImage
-
-
-
+
+
+
The SkiaSharp pixmap.
@@ -6276,12 +6276,12 @@
-
-
-
+
+
+
ExtensionMethod
- Microsoft.Maui.Hosting.MauiAppBuilder
+ Microsoft.Maui.Hosting.MauiAppBuilder
@@ -6992,7 +6992,7 @@
SkiaSharp.SKColorF
-
+
The Tizen NUI color.
@@ -7036,7 +7036,7 @@
SkiaSharp.SKPoint
-
+
The Tizen NUI position.
@@ -7080,7 +7080,7 @@
SkiaSharp.SKPointI
-
+
The Tizen NUI 2D position.
@@ -7124,7 +7124,7 @@
SkiaSharp.SKRect
-
+
The Tizen NUI rectangle.
@@ -7168,7 +7168,7 @@
SkiaSharp.SKRectI
-
+
The Tizen NUI rectangle.
@@ -7212,7 +7212,7 @@
SkiaSharp.SKSize
-
+
The Tizen NUI size.
@@ -7256,7 +7256,7 @@
SkiaSharp.SKSizeI
-
+
The Tizen NUI 2D size.
@@ -8414,9 +8414,9 @@
UIKit.UIImage
-
-
-
+
+
+
The SkiaSharp bitmap.
@@ -8514,10 +8514,10 @@
UIKit.UIImage
-
-
-
-
+
+
+
+
The SkiaSharp picture.
@@ -8590,9 +8590,9 @@
UIKit.UIImage
-
-
-
+
+
+
The SkiaSharp pixmap.