From 1ecdde325da40c4412ac5f3287438bec77bfb83e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 17:32:47 +0000 Subject: [PATCH] Fill API documentation placeholders Automated AI-generated documentation for XML API docs with 'To be added.' 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 | 90 ++-- .../SkiaSharp/GrVkYcbcrConversionInfo.xml | 18 +- SkiaSharpAPI/SkiaSharp/SKCanvas.xml | 68 +-- SkiaSharpAPI/SkiaSharp/SKColorSpace.xml | 10 +- SkiaSharpAPI/SkiaSharp/SKColorType.xml | 6 +- .../SkiaSharp/SKColorspacePrimariesCicp.xml | 43 +- .../SkiaSharp/SKColorspaceTransferFnCicp.xml | 48 +- .../SkiaSharp/SKDocumentXpsOptions.xml | 82 ++- SkiaSharpAPI/SkiaSharp/SKFontArguments.xml | 48 +- .../SkiaSharp/SKFontPaletteOverride.xml | 84 ++- .../SkiaSharp/SKFontVariationAxis.xml | 98 ++-- .../SKFontVariationPositionCoordinate.xml | 82 ++- SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | 118 +++-- SkiaSharpAPI/SkiaSharp/SKMatrix.xml | 16 +- SkiaSharpAPI/SkiaSharp/SKPaint.xml | 74 +-- SkiaSharpAPI/SkiaSharp/SKPath.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml | 499 +++++++++--------- SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 14 +- SkiaSharpAPI/SkiaSharp/SKStream.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKSurface.xml | 26 +- SkiaSharpAPI/SkiaSharp/SKTypeface.xml | 76 +-- SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml | 94 ++-- SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml | 67 ++- SkiaSharpAPI/index.xml | 196 +++---- 29 files changed, 1232 insertions(+), 969 deletions(-) diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..24d913f1 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. + Gets the design coordinates for the specified named variation instance. + An array of design coordinates 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 coordinates. + Fills a span with the design coordinates for the specified named variation instance. + The number of design coordinates written to . + @@ -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 coordinates for the specified named variation instance. + The number of design coordinates 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 PostScript name identifier for the specified named variation instance. + The for 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 subfamily name identifier for the specified named variation instance. + The for 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. + Gets the name identifier for the specified color entry within any palette. + The for the color entry name. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the colors of the specified palette. + An array of packed color values (BGRA byte order: blue in the high byte, alpha in the low byte) for the specified 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 palette. + The span to receive the packed color values (BGRA byte order: blue in the high byte, alpha in the low byte). + Fills a span with the colors of the specified palette. + The number of color values written to . + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the flags for the specified palette. + One of the values that describes the palette. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the name identifier for the specified palette. + The for the palette name. + @@ -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 a span with information about the variation axes of the font face. + The number of axes written to . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains color layers (COLR table). + if the font 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 font face contains PNG color glyphs (CBDT/CBLC tables). + if the font face has embedded PNG color glyphs; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains SVG color glyphs (SVG table). + if the font face has an SVG color glyph table; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains color palettes (CPAL table). + if the font 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 font face contains OpenType variation data (fvar/gvar tables). + if the font 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 variation instances defined in the font face. + The number of named instances in the font's fvar table. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes in the font face. + The number of palettes in the font's 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 to find. + When this method returns, contains the axis information if 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 face. + The number of variation axes in the font's fvar table. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets an array containing information about all variation axes in the font face. + An array of values, one per variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..1d0bbcef 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 coordinates. + Fills a span with the current variation coordinates in normalized form. + The number of coordinates written to . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + The design-space variation coordinates, one per variation axis in fvar order. + Sets the variation coordinates using design-space values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + The normalized variation coordinates in the range [-1.0, 1.0], one per axis in fvar order. + Sets the variation coordinates using normalized 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 variation to a named instance defined in the font face. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + The variation axis and value pairs to apply. + Sets the font variation using a span of axis–value pairs. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current variation coordinates in normalized form. + An array of normalized variation coordinates in the range [-1.0, 1.0], one per 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..baf0b735 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 rectangle to convert. + Converts an to a . + A equivalent to the specified . + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The color to convert. + Converts an to a . + A equivalent to the specified . + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The color to convert. + Converts an to a . + A equivalent to the specified . + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The point to convert. + Converts an to a . + A equivalent to the specified . + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The 3D point to convert. + Converts an to a . + A equivalent to the specified . + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The rectangle to convert. + Converts an to a . + A equivalent to the specified . + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The size to convert. + Converts an to a . + A equivalent to the specified . + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The color to convert. + Converts a to an . + An equivalent to the specified . + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The color to convert. + Converts a to an . + An equivalent to the specified . + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The point to convert. + Converts a to an . + An equivalent to the specified . + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The 3D point to convert. + Converts a to an . + An equivalent to the specified . + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The rectangle to convert. + Converts a to an . + An equivalent to the specified . + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The size to convert. + Converts a to an . + An equivalent to the specified . + 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..a173ec1d 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,28 @@ - To be added. - To be added. + Specifies the bit-width mapping for each color channel used in a Vulkan YCbCr conversion. + @@ -37,9 +57,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the bit width of the alpha channel. + The number of bits used for the alpha channel. + @@ -60,9 +80,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the bit width of the blue channel. + The number of bits used for the blue channel. + @@ -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 specified instance is equal to the current instance; 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 a equal to the current instance; otherwise, . + @@ -140,9 +160,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the bit width of the green channel. + The number of bits used for the green channel. + @@ -164,9 +184,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 +206,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances are equal; otherwise, . + @@ -210,11 +230,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances are not equal; otherwise, . + @@ -235,9 +255,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the bit width of the red channel. + The number of bits used for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..a6f87ce4 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 per-channel bit-width mapping for the YCbCr conversion. + A that describes the bit width of each color channel. + @@ -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 linear filtering is supported for this YCbCr conversion. + if linear filtering is supported; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..82e95e40 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 draw the top-left corner of the surface. + The sampling options used when drawing the surface. + The paint to apply, or to draw with default settings. + Draws the surface at the specified point using the given sampling options and optional paint. + @@ -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 at which to draw the left edge of the surface. + The y-coordinate at which to draw the top edge of the surface. + The sampling options used when drawing the surface. + The paint to apply, or to draw with default settings. + Draws the surface at the specified coordinates using the given sampling options and optional paint. + @@ -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..2f887d40 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 specifies the color primaries. + One of the enumeration values that specifies the transfer characteristics. + Creates a color space from CICP (Coding-Independent Code Points) color primaries and transfer characteristics. + A new corresponding 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..6e345ec2 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + BGRA format with 10 bits each for blue, green, red, and alpha channels, stored in an extended-range representation (8 bytes per pixel) [Bgra10101010XR] @@ -234,7 +234,7 @@ 27 - To be added. + Single-channel red format with 16-bit unsigned normalized value (2 bytes per pixel) [R16Unorm] @@ -519,7 +519,7 @@ 26 - To be added. + RGB format with three 16-bit floating-point channels and a padding channel (8 bytes per pixel, alpha is unused) [RgbF16F16F16x] diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..1cefe739 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,23 @@ System.Enum - To be added. - To be added. + Specifies the color primaries as defined by the CICP (Coding-Independent Code Points) standard. + +to construct a color space from CICP descriptors embedded in image or video streams. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> @@ -28,7 +43,7 @@ 8 - To be added. + Color primaries representing a generic film color space (CICP value 8). @@ -45,7 +60,7 @@ 22 - To be added. + Color primaries as defined by ITU-T H.273, value 22, used for EBU Tech 3213-E displays (CICP value 22). @@ -62,7 +77,7 @@ 9 - To be added. + Color primaries as defined by ITU-R BT.2020, used for ultra-high-definition television (CICP value 9). @@ -79,7 +94,7 @@ 5 - To be added. + Color primaries as defined by ITU-R BT.470 System B/G, used for PAL and SECAM (CICP value 5). @@ -96,7 +111,7 @@ 4 - To be added. + Color primaries as defined by ITU-R BT.470 System M, used for NTSC (CICP value 4). @@ -113,7 +128,7 @@ 6 - To be added. + Color primaries as defined by ITU-R BT.601, used for standard-definition television (CICP value 6). @@ -130,7 +145,7 @@ 1 - To be added. + Color primaries as defined by ITU-R BT.709, used for HDTV (CICP value 1). @@ -147,7 +162,7 @@ 12 - To be added. + Color primaries as defined by SMPTE EG 432-1, used for the P3-D65 display color space (CICP value 12). @@ -164,7 +179,7 @@ 11 - To be added. + Color primaries as defined by SMPTE RP 431-2, used for DCI-P3 digital cinema projectors (CICP value 11). @@ -181,7 +196,7 @@ 7 - To be added. + Color primaries as defined by SMPTE ST 240, used for early HDTV production (CICP value 7). @@ -198,7 +213,7 @@ 10 - To be added. + Color primaries as defined by SMPTE ST 428-1 (CIE 1931 XYZ), used for digital cinema (CICP value 10). @@ -215,7 +230,7 @@ 0 - To be added. + The color primaries are unspecified or unknown (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index bddb849d..5285c3b7 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,24 @@ System.Enum - To be added. - To be added. + Specifies the opto-electronic transfer characteristics as defined by the CICP (Coding-Independent Code Points) standard. + +to construct a color space from CICP descriptors embedded in image or video streams. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +44,7 @@ 18 - To be added. + Hybrid Log-Gamma (HLG) transfer characteristics as defined by ARIB STD-B67, used for HDR broadcasting (CICP value 18). @@ -45,7 +61,7 @@ 13 - To be added. + Transfer characteristics as defined by IEC 61966-2-1, used for sRGB and sYCC (CICP value 13). @@ -62,7 +78,7 @@ 11 - To be added. + Transfer characteristics as defined by IEC 61966-2-4, used for xvYCC (CICP value 11). @@ -79,7 +95,7 @@ 8 - To be added. + Linear transfer characteristics with no gamma correction applied (CICP value 8). @@ -96,7 +112,7 @@ 16 - To be added. + Perceptual Quantizer (PQ) transfer characteristics as defined by SMPTE ST 2084, used for HDR10 content (CICP value 16). @@ -113,7 +129,7 @@ 14 - To be added. + Transfer characteristics as defined by ITU-R BT.2020 for 10-bit systems (CICP value 14). @@ -130,7 +146,7 @@ 15 - To be added. + Transfer characteristics as defined by ITU-R BT.2020 for 12-bit systems (CICP value 15). @@ -147,7 +163,7 @@ 5 - To be added. + Transfer characteristics as defined by ITU-R BT.470 System B/G, with assumed display gamma (CICP value 5). @@ -164,7 +180,7 @@ 4 - To be added. + Transfer characteristics as defined by ITU-R BT.470 System M, with assumed display gamma (CICP value 4). @@ -181,7 +197,7 @@ 6 - To be added. + Transfer characteristics as defined by ITU-R BT.601 for standard-definition television (CICP value 6). @@ -198,7 +214,7 @@ 1 - To be added. + Transfer characteristics as defined by ITU-R BT.709 (CICP value 1). @@ -215,7 +231,7 @@ 7 - To be added. + Transfer characteristics as defined by SMPTE ST 240, used for early HDTV production (CICP value 7). @@ -232,7 +248,7 @@ 17 - To be added. + Transfer characteristics as defined by SMPTE ST 428-1, used for digital cinema (CICP value 17). @@ -249,7 +265,7 @@ 0 - To be added. + The transfer characteristics are unspecified or unknown (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..23379ef8 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,32 @@ - To be added. - To be added. + Holds the options used when creating an XPS document. + +when creating an XPS document. + +This is a value type and requires no disposal. + +## Examples + +```csharp +var options = new SKDocumentXpsOptions +{ + DPI = 300, + AllowNoPngs = false, +}; +using var stream = File.OpenWrite("output.xps"); +using var document = SKDocument.CreateXps(stream, options); +using var canvas = document.BeginPage(595, 842); +canvas.DrawColor(SKColors.White); +document.EndPage(); +``` +]]> @@ -37,9 +61,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether raster images may be encoded without PNG when a more suitable format is available. + if non-PNG raster image encodings are allowed; otherwise, . + @@ -60,9 +84,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the target DPI (dots per inch) for raster content in the XPS document. + The DPI value used for raster content rendering. + @@ -89,10 +113,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 specified instance is equal to the current instance; otherwise, . + @@ -116,10 +140,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 equal to the current instance; otherwise, . + @@ -141,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. + @@ -163,11 +187,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances are equal; otherwise, . + @@ -187,11 +211,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 57ae755b..b6b011e6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,28 @@ - To be added. - To be added. + Holds font selection arguments including variation position, palette selection, and collection index. + . It can specify a +variation design position, a color palette index, per-entry palette color overrides, and +a font collection index. + +This is a value type and requires no disposal. + +## Examples + +```csharp +var args = new SKFontArguments +{ + CollectionIndex = 0, + PaletteIndex = 1, +}; +using var cloned = typeface.Clone(args); +``` +]]> @@ -41,9 +61,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the face within a font collection. + The index of the font face within the collection. Use 0 for single-face fonts. + @@ -64,9 +84,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the color palette to use. + The index of the CPAL color palette to use for color font rendering. + @@ -87,9 +107,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-entry color overrides to apply on top of the selected palette. + A span of entries that override individual palette colors. + @@ -110,9 +130,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation design position as a set of axis–value coordinate pairs. + A span of pairs that specify the position on each variation axis. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..59297c51 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,34 @@ - To be added. - To be added. + Represents an override for a single color entry within a font color palette. + to selectively replace colors when +cloning a typeface. + +The `Color` field is an `SKColor` (ARGB packed as `0xAARRGGBB`). + +This is a value type and requires no disposal. + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red }, +}; +var args = new SKFontArguments +{ + PaletteIndex = 0, + PaletteOverrides = overrides, +}; +using var cloned = typeface.Clone(args); +``` +]]> @@ -37,9 +63,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color for the palette entry, as a packed ARGB value. + A packed value in ARGB byte order (0xAARRGGBB). + @@ -66,10 +92,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 specified instance is equal to the current instance; otherwise, . + @@ -93,10 +119,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 equal to the current instance; otherwise, . + @@ -118,9 +144,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 +167,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 index of the color entry within the CPAL palette to replace. + @@ -163,11 +189,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances are equal; otherwise, . + @@ -187,11 +213,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 8696fae6..f0528b12 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,30 @@ - To be added. - To be added. + Describes a single variation axis in an OpenType variable font. + or + +to retrieve the axes for a given typeface. + +This is a value type and requires no disposal. + +## Examples + +```csharp +var axes = typeface.VariationDesignParameters; +foreach (var axis in axes) +{ + Console.WriteLine($"{axis.Tag}: min={axis.Min}, default={axis.Default}, max={axis.Max}"); +} +``` +]]> @@ -37,9 +59,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default design value for this variation axis. + The default design-space value for this axis. + @@ -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 specified instance is equal to the current instance; 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 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.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this variation axis should be hidden from user interfaces. + if the axis is marked as hidden in the font; otherwise, . + @@ -164,9 +186,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum design value for this variation axis. + The maximum design-space value allowed for this axis. + @@ -187,9 +209,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum design value for this variation axis. + The minimum design-space value allowed for this axis. + @@ -209,11 +231,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances are equal; otherwise, . + @@ -233,11 +255,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances are not equal; otherwise, . + @@ -258,9 +280,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 that identifies the axis (for example, 'wght' for weight). + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..afae5eba 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,32 @@ - To be added. - To be added. + Represents a single axis–value coordinate used to specify a position in a variable font's design space. + or pass them directly to + +to create a typeface with the desired variation settings. + +This is a value type and requires no disposal. + +## Examples + +```csharp +var coords = new SKFontVariationPositionCoordinate[] +{ + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("ital"), Value = 1 }, +}; +using var cloned = typeface.Clone(coords); +``` +]]> @@ -37,9 +61,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag that identifies the variation axis. + An that identifies the axis (for example, 'wght' for weight). + @@ -66,10 +90,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 specified instance is equal to the current instance; otherwise, . + @@ -93,10 +117,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 equal to the current instance; otherwise, . + @@ -118,9 +142,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 +164,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances are equal; otherwise, . + @@ -164,11 +188,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances are not equal; otherwise, . + @@ -189,9 +213,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the specified axis. + The design-space position on the axis identified by . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..c928ec51 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,32 @@ - To be added. - To be added. + Represents a four-byte (32-bit) tag used to identify OpenType tables, variation axes, and other font resources. + @@ -37,9 +61,9 @@ - To be added. - To be added. - To be added. + The packed 32-bit value where the high byte is the first character and the low byte is the fourth character. + Initializes a new instance of the struct from a packed 32-bit value. + @@ -58,12 +82,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The first character (placed in the high byte). + The second character. + The third character. + The fourth character (placed in the low byte). + Initializes a new instance of the struct from four ASCII characters. + @@ -85,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 specified instance has the same value; otherwise, . + @@ -112,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 with the same value; otherwise, . + @@ -132,9 +156,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 +178,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if the two instances have the same value; otherwise, . + @@ -177,10 +201,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Implicitly converts an to its underlying value. + The packed 32-bit value of the tag. + @@ -199,10 +223,10 @@ - To be added. - To be added. - To be added. - To be added. + The packed 32-bit value to convert. + Implicitly converts a to an . + A new wrapping the specified value. + @@ -222,11 +246,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if the two instances have different values; otherwise, . + @@ -250,10 +274,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. If shorter than four characters, it is right-padded with spaces. If or empty, returns a tag with value zero. + Creates an from a string of up to four characters. + A new whose bytes correspond to the (potentially padded) characters of the string. + @@ -275,9 +299,9 @@ - To be added. - To be added. - To be added. + Returns the four-character string representation of the tag. + A four-character string where each character corresponds to one byte of the packed 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..821af395 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 fill. + The to receive the resulting fill path. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; 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 fill. + The to receive the resulting fill path. + The transformation matrix applied when computing the fill path. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; 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 fill. + The to receive the resulting fill path. + The bounding rectangle used to limit path segment precision. Segments outside this rectangle may be simplified. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; 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 fill. + The to receive the resulting fill path. + The resolution scale, where 1.0 is the default. Larger values increase precision for curved segments. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; 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 fill. + The to receive the resulting fill path. + The bounding rectangle used to limit path segment precision. Segments outside this rectangle may be simplified. + The transformation matrix applied when computing the fill path. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; 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 fill. + The to receive the resulting fill path. + The bounding rectangle used to limit path segment precision. Segments outside this rectangle may be simplified. + The resolution scale, where 1.0 is the default. Larger values increase precision for curved segments. + Applies the paint to the source path and writes the resulting filled geometry to the destination path builder. + if the fill path was successfully computed; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..68ca05f8 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 for this path, flushing any pending builder state before returning. + The native pointer to the underlying Skia path object. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..5f56e22b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,31 @@ - To be added. - To be added. + Provides a mutable builder for constructing objects incrementally. + . Use + to get a snapshot of the path without resetting +the builder, or to consume the path and reset the +builder in one step. + +This type wraps a native Skia resource and implements `IDisposable`. Always dispose of it +when done, either with a `using` statement or by calling `Dispose()` directly. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(10, 10); +builder.LineTo(100, 10); +builder.LineTo(100, 100); +builder.Close(); +using var path = builder.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +49,8 @@ - To be added. - To be added. + Initializes a new instance of the class copying the contours of an existing path. + @@ -43,9 +66,9 @@ - To be added. - To be added. - To be added. + The path whose contours are copied into the new builder. + Initializes a new instance of the class copying the contours of an existing path. + @@ -66,11 +89,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval that defines the arc. + The angle in degrees at which the arc begins, measured clockwise from the positive x-axis. + The sweep angle in degrees, measured clockwise from . + Adds an arc of an oval to the path as a new contour. + @@ -92,12 +115,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 the winding direction of the circle contour. + Adds a closed circle contour to the path. + @@ -117,10 +140,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 the winding direction of the oval contour. + Adds a closed oval contour bounded by the specified rectangle. + @@ -140,10 +163,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose contours to add. + One of the enumeration values that specifies how the path is appended. + Adds the contours of another path to this builder. + @@ -170,11 +193,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours to add. + The transformation matrix to apply to the added contours. + One of the enumeration values that specifies how the path is appended. + Adds the contours of another path to this builder, transformed by a matrix. + @@ -196,12 +219,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours to add. + The horizontal offset to apply to the added contours. + The vertical offset to apply to the added contours. + One of the enumeration values that specifies how the path is appended. + Adds the contours of another path to this builder, offset by the specified translation. + @@ -221,10 +244,10 @@ - To be added. - To be added. - To be added. - To be added. + The points of the polygon. + to close the contour by connecting the last point to the first; otherwise, . + Adds a polygon defined by an array of points as a new contour. + @@ -244,10 +267,10 @@ - To be added. - To be added. - To be added. - To be added. + The points of the polygon. + to close the contour by connecting the last point to the first; otherwise, . + Adds a polygon defined by a span of points as a new contour. + @@ -267,10 +290,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction of the rectangle contour. + Adds a closed rectangle contour to the path. + @@ -291,11 +314,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction. + The zero-based index of the rectangle corner at which the contour begins (0 = top-left, 1 = top-right, 2 = bottom-right, 3 = bottom-left). + Adds a closed rectangle contour beginning at the specified corner index. + @@ -315,10 +338,10 @@ - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add. + One of the enumeration values that specifies the winding direction of the rounded rectangle contour. + Adds a closed rounded rectangle contour to the path. + @@ -339,11 +362,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add. + One of the enumeration values that specifies the winding direction. + The zero-based index of the corner at which the contour begins. + Adds a closed rounded rectangle contour beginning at the specified corner index. + @@ -365,12 +388,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the rounded rectangle. + The x-axis radius of the corner ellipses. + The y-axis radius of the corner ellipses. + One of the enumeration values that specifies the winding direction. + Adds a closed rounded rectangle contour with the specified corner radii. + @@ -391,11 +414,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point. + The second tangent point. + The radius of the arc. + Appends an arc tangent to lines from the current point to and from to . + @@ -417,12 +440,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. + The angle in degrees at which the arc begins. + The sweep angle in degrees. + to begin a new contour at the arc start; otherwise, to connect from the current point. + Appends an arc of an oval to the current contour. + @@ -445,13 +468,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The radii of the arc ellipse. + The rotation of the ellipse 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 arc drawing direction. + The end point of the arc. + Appends an SVG-style arc to the current contour using point parameters. + @@ -474,13 +497,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 lines from the current point to (, ) and to (, ). + @@ -505,15 +528,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-axis radius of the arc ellipse. + The y-axis radius of the arc ellipse. + The rotation of the ellipse 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 arc drawing direction. + The x-coordinate of the arc end point. + The y-coordinate of the arc end point. + Appends an SVG-style arc to the current contour using scalar parameters. + @@ -530,8 +553,8 @@ - To be added. - To be added. + Closes the current contour by appending a line back to the start point of the contour. + @@ -552,11 +575,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic curve. + The end point of the conic curve. + The weight of the conic curve, where 1.0 produces a quadratic Bézier. + Appends a conic curve to the current contour using point parameters. + @@ -579,13 +602,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 curve, where 1.0 produces a quadratic Bézier. + Appends a conic curve to the current contour using scalar parameters. + @@ -606,11 +629,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point of the cubic curve. + The second control point of the cubic curve. + The end point of the cubic curve. + Appends a cubic Bézier curve to the current contour using point parameters. + @@ -634,14 +657,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 parameters. + @@ -658,9 +681,9 @@ - To be added. - To be added. - To be added. + Produces a snapshot of the current path and resets the builder. + A new containing the accumulated contours. The builder is reset after this call. + @@ -679,9 +702,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 +721,8 @@ - To be added. - To be added. + Releases the native resources held by the current instance. + @@ -715,9 +738,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type rule used to determine the interior of the path. + One of the values that specifies how overlapping contours are filled. + @@ -736,9 +759,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 +781,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 +803,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 +825,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 +848,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point of the quadratic curve. + The end point of the quadratic curve. + Appends a quadratic Bézier curve to the current contour using point parameters. + @@ -850,12 +873,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 parameters. + @@ -878,13 +901,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The radii of the arc ellipse. + The rotation of the ellipse 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 arc drawing direction. + The end point of the arc, relative to the current point. + Appends a relative SVG-style arc to the current contour using point parameters. + @@ -909,15 +932,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-axis radius of the arc ellipse. + The y-axis radius of the arc ellipse. + The rotation of the ellipse 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 arc drawing direction. + The x-offset of the arc end point relative to the current point. + The y-offset of the arc end point relative to the current point. + Appends a relative SVG-style arc to the current contour using scalar parameters. + @@ -938,11 +961,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point offset, relative to the current point. + The end point offset, relative to the current point. + The weight of the conic curve, where 1.0 produces a quadratic Bézier. + Appends a relative conic curve to the current contour using point parameters. + @@ -965,13 +988,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 of the control point, relative to the current point. + The y-offset of the control point, relative to the current point. + The x-offset of the end point, relative to the current point. + The y-offset of the end point, relative to the current point. + The weight of the conic curve, where 1.0 produces a quadratic Bézier. + Appends a relative conic curve to the current contour using scalar parameters. + @@ -992,11 +1015,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point offset, relative to the current point. + The second control point offset, relative to the current point. + The end point offset, relative to the current point. + Appends a relative cubic Bézier curve to the current contour using point parameters. + @@ -1020,14 +1043,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 of the first control point, relative to the current point. + The y-offset of the first control point, relative to the current point. + The x-offset of the second control point, relative to the current point. + The y-offset of the second control point, relative to the current point. + The x-offset of the end point, relative to the current point. + The y-offset of the end point, relative to the current point. + Appends a relative cubic Bézier curve to the current contour using scalar parameters. + @@ -1044,8 +1067,8 @@ - To be added. - To be added. + Resets the builder to its empty initial state, discarding all accumulated contours. + @@ -1064,9 +1087,9 @@ - To be added. - To be added. - To be added. + The path whose contours are added in reverse. + Adds the contours of another path to this builder in reverse order. + @@ -1085,9 +1108,9 @@ - To be added. - To be added. - To be added. + The offset of the end point, relative to the current point. + Appends a relative straight line from the current point. + @@ -1107,10 +1130,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-offset of the end point, relative to the current point. + The y-offset of the end point, relative to the current point. + Appends a relative straight line from the current point. + @@ -1129,9 +1152,9 @@ - To be added. - To be added. - To be added. + The offset from the current point at which to begin the new contour. + Begins a new contour at a point offset from the current point. + @@ -1151,10 +1174,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. + @@ -1174,10 +1197,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point offset, relative to the current point. + The end point offset, relative to the current point. + Appends a relative quadratic Bézier curve to the current contour using point parameters. + @@ -1199,12 +1222,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset of the control point, relative to the current point. + The y-offset of the control point, relative to the current point. + The x-offset of the end point, relative to the current point. + The y-offset of the end point, relative to the current point. + Appends a relative quadratic Bézier curve to the current contour using scalar parameters. + @@ -1221,9 +1244,9 @@ - To be added. - To be added. - To be added. + Produces a snapshot of the current path without resetting the builder. + A new containing a copy of the accumulated contours. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..a37c0d07 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 to receive the extracted segment. + to prepend a move-to command at the start of the segment; otherwise, . + Extracts a segment of the path between two distance values and appends it to a path builder. + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..d69cc282 100644 --- a/SkiaSharpAPI/SkiaSharp/SKStream.xml +++ b/SkiaSharpAPI/SkiaSharp/SKStream.xml @@ -33,9 +33,9 @@ - To be added. - To be added. - To be added. + Returns the contents of the stream as an object. + A new containing the stream's bytes, or if the stream does not support this operation. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..c64b58b1 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 canvas on which to draw the surface. + The point at which to draw the top-left corner of the surface. + The sampling options used when drawing the surface. + The paint to apply, or to draw with default settings. + 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 canvas on which to draw the surface. + The x-coordinate at which to draw the left edge of the surface. + The y-coordinate at which to draw the top edge of the surface. + The sampling options used when drawing the surface. + The paint to apply, or to draw with default settings. + 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..8f39ac80 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, palette index, palette overrides, and collection index for the new typeface. + Creates a clone of this typeface applying the font arguments specified by . + A new instance with the specified font arguments applied. + @@ -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 in the new typeface. + Creates a clone of this typeface with the specified color palette index. + A new instance using 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–value coordinate pairs that define the desired design position. + Creates a clone of this typeface with the specified variation design position. + A new instance positioned at the specified design-space coordinates. + @@ -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 that contains no glyphs. + A singleton empty whose glyph count is zero. + @@ -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 information. + Fills a span with information about the variation axes supported by this typeface. + The number of axes written to . + @@ -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 design position coordinates. + Fills a span with the current variation design position coordinates. + The number of coordinates written to . + @@ -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 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 defined in this typeface. + The number of axes in the font's fvar table. + @@ -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 containing information about all variation axes in this typeface. + An array of values, one per variation axis. + @@ -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 design position coordinates. + An array of values representing the current design position. + @@ -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 design position coordinates for this typeface. + The number of variation axes for which design position coordinates are available. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..cafdd3d5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,30 @@ - To be added. - To be added. + Provides static methods to encode images and animated sequences in the WebP format. + to control lossy or +lossless compression and quality. + +For single-frame encoding, use one of the `Encode` overloads. For multi-frame animation, +use one of the `EncodeAnimated` overloads and supply a span of + values. + +## Examples + +```csharp +using var bitmap = SKBitmap.Decode("input.png"); +using var pixmap = bitmap.PeekPixels(); +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90); +using var data = SKWebpEncoder.Encode(pixmap, options); +if (data is null) + throw new InvalidOperationException("Encoding failed."); +File.WriteAllBytes("output.webp", data.ToArray()); +``` +]]> @@ -42,11 +64,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The pixmap to encode. + The encoding options controlling compression type and quality. + Encodes the pixmap to WebP and returns the result as an object. + A new containing the WebP-encoded bytes, or if encoding fails. + @@ -72,12 +94,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the WebP-encoded data to. + The pixmap to encode. + The encoding options controlling compression type and quality. + Encodes the pixmap to WebP and writes the result to an . + if encoding succeeded; otherwise, . + @@ -103,12 +125,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the WebP-encoded data to. + The pixmap to encode. + The encoding options controlling compression type and quality. + Encodes the pixmap to WebP and writes the result to a . + if encoding succeeded; otherwise, . + @@ -133,11 +155,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The frames of the animation, each including a pixmap and display duration. + The encoding options controlling compression type and quality. + Encodes a sequence of frames as an animated WebP and returns the result as an object. + A new containing the animated WebP bytes, or if encoding fails. + @@ -164,12 +186,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the animated WebP data to. + The frames of the animation, each including a pixmap and display duration. + The encoding options controlling compression type and quality. + Encodes a sequence of frames as an animated WebP and writes the result to an . + if encoding succeeded; otherwise, . + @@ -196,12 +218,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the animated WebP data to. + The frames of the animation, each including a pixmap and display duration. + The encoding options controlling compression type and quality. + Encodes a sequence of frames as an animated WebP and writes the result to a . + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..3bec4f8b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,35 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence, consisting of a pixmap and a display duration. + , +, or together with a + duration. Pass a span of these frames to +. + +This is a value type and requires no disposal (though the underlying pixel sources may be disposable). + +## Examples + +```csharp +using var frame1 = SKBitmap.Decode("frame1.png"); +using var frame2 = SKBitmap.Decode("frame2.png"); +var frames = new[] +{ + new SKWebpEncoderFrame(frame1, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(frame2, TimeSpan.FromMilliseconds(100)), +}; +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90); +using var data = SKWebpEncoder.EncodeAnimated(frames, options); +if (data is null) + throw new InvalidOperationException("Encoding failed."); +File.WriteAllBytes("animation.webp", data.ToArray()); +``` +]]> @@ -29,10 +56,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 +76,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 +96,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 +120,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the length of time this frame is displayed during animation playback. + A representing the display duration of this frame. + @@ -116,9 +143,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixel data for this animation frame. + The containing the pixel data 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.