diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..eca56f0b 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 instance. + An array of design coordinate values 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 fill with the design coordinate values. + Gets the design coordinates for the specified named instance into the provided span. + 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 instance. + The number of design coordinate axes 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 instance. + The of the PostScript name for 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 instance. + The of the subfamily name for 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 within the palette. + Gets the name identifier for the specified palette color. + The of the color 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 all colors in the specified palette. + An array of ARGB color values in 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 palette. + The span to fill with ARGB color values. + Gets colors from the specified palette into the provided span. + The number of colors 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 enumeration values that indicates the palette type (usable for light or dark backgrounds). + @@ -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 of the palette name. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + The span to fill with variation axis information. + Gets information about all variation axes into the provided span. + The number of variation axes written to . + @@ -428,9 +428,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the face contains color layer data (COLR table). + + if the face has color layer data; otherwise, . + @@ -446,9 +447,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the face contains color PNG glyph data (CBDT/CBLC table). + + if the face has embedded PNG images; otherwise, . + @@ -464,9 +466,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the face contains SVG color glyph data (SVG table). + + if the face has SVG glyph descriptions; otherwise, . + @@ -482,9 +485,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the face contains color palette data (CPAL table). + + if the face has color palettes; otherwise, . + @@ -500,9 +504,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the face contains variable font data (fvar table). + + if the face is a variable font; otherwise, . + @@ -573,9 +578,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of named instances in the variable font. + The number of named instances, or 0 if the face is not a variable font. + @@ -591,9 +596,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes in the face. + The number of palettes defined in the CPAL table, or 0 if none. + @@ -653,11 +658,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte tag identifying the variation axis. + 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 +697,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes in the face. + The number of variation axes, or 0 if the face is not a variable font. + @@ -709,9 +715,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets an array of information about each variation axis in the face. + An array of values, or an empty array if the face has no variation axes. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..c731a00f 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 fill with the normalized coordinate values in the range [-1.0, 1.0] represented as 2.14 fixed-point integers. + Gets the current normalized variation coordinates into the provided span. + The number of coordinates written to . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + The design-space coordinate values, one per variation axis. + Sets the variation coordinates using design-space values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + The normalized coordinate values in 2.14 fixed-point format, one per variation axis. + 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 face. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + A span of values specifying the axis tag and value for each axis to set. + Sets one or more variation axis values by tag. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates. + An array of normalized coordinate values in 2.14 fixed-point format, 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..73afa56c 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 SkiaSharp integer rectangle to convert. + Converts a to a . + A with the same bounds. + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp color to convert. + Converts a to a . + A with the same color values. + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp floating-point color to convert. + Converts a to a . + A with the same color values. + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp point to convert. + Converts a to a . + A with the same coordinates. + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp 3D point to convert. + Converts a to a . + A with the same coordinates. + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp rectangle to convert. + Converts a to a . + A with the same bounds. + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp size to convert. + Converts a to a . + A with the same dimensions. + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The GDK color to convert. + Converts a to a . + An with the same color values. + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The GDK color to convert. + Converts a to a . + An with the same floating-point color values. + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene point to convert. + Converts a to a . + An with the same coordinates. + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene 3D point to convert. + Converts a to a . + An with the same coordinates. + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene rectangle to convert. + Converts a to a . + An with the same bounds. + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene size to convert. + Converts a to a . + An with the same dimensions. + 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..e5d1783c 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,31 @@ - To be added. - To be added. + Specifies the component swizzle mapping for a Vulkan YCbCr sampler conversion. + + + @@ -37,9 +60,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle value for the alpha channel. + A Vulkan component swizzle value indicating the source component for the alpha channel. + @@ -60,9 +83,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle value for the blue channel. + A Vulkan component swizzle value indicating the source component for the blue channel. + @@ -89,10 +112,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -116,10 +140,11 @@ - 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 +165,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle value for the green channel. + A Vulkan component swizzle value indicating the source component for the green channel. + @@ -164,9 +189,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current instance. + @@ -186,11 +211,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -210,11 +236,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + @@ -235,9 +262,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle value for the red channel. + A Vulkan component swizzle value indicating the source component for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..12e36ec9 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 used during YCbCr conversion. + A that specifies the swizzle for each color channel. + @@ -351,9 +351,10 @@ 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 and chroma filter must be identical; otherwise, . + @@ -374,9 +375,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether linear filtering is supported for chroma reconstruction. + + if linear filtering can be used for the YCbCr chroma samples; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..0c33e893 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 whose contents are drawn. + The point at which the top-left corner of the surface is placed. + The sampling options used when scaling or transforming the surface pixels. + The paint to apply, or to use default settings. + Draws the contents of a surface onto this canvas at the specified point. + @@ -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 whose contents are drawn. + The x-coordinate at which the left edge of the surface is placed. + The y-coordinate at which the top edge of the surface is placed. + The sampling options used when scaling or transforming the surface pixels. + The paint to apply, or to use default settings. + Draws the contents of a surface onto this canvas at the specified coordinates. + @@ -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..d29fd4ea 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 specifying the color primaries. + One of the enumeration values specifying the electro-optical transfer function. + Creates a color space defined by CICP (Coding-Independent Code Points) primaries and transfer characteristics. + A new , or if the combination is not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..dd6302e0 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + Each pixel uses 40 bits: 10 bits for blue, 10 for green, 10 for red, and 10 for alpha, in extended-range BGRA order. @@ -234,7 +234,7 @@ 27 - To be added. + Each pixel uses 16 bits for a single red channel as an unsigned normalized value. @@ -519,7 +519,7 @@ 26 - To be added. + Each pixel uses 48 bits: 16-bit half-float for red, green, and blue channels with no alpha (padding to align). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..c4a29c93 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,25 @@ System.Enum - To be added. - To be added. + Specifies the color primaries of a color space using CICP (Coding-Independent Code Points) identifiers as defined in ITU-T H.273. + + to create a color +space using standardized primaries. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> + @@ -28,7 +45,7 @@ 8 - To be added. + Generic film color primaries based on the CIE 1931 equal-energy illuminant (CICP value 8). @@ -45,7 +62,7 @@ 22 - To be added. + ITU-T H.273 value 22 color primaries, used for EBU Tech 3213-E (CICP value 22). @@ -62,7 +79,7 @@ 9 - To be added. + ITU-R BT.2020 and BT.2100 color primaries, used for ultra-high-definition and HDR content (CICP value 9). @@ -79,7 +96,7 @@ 5 - To be added. + ITU-R BT.470 System B, G (PAL/SECAM) color primaries (CICP value 5). @@ -96,7 +113,7 @@ 4 - To be added. + ITU-R BT.470 System M (NTSC) color primaries (CICP value 4). @@ -113,7 +130,7 @@ 6 - To be added. + ITU-R BT.601 color primaries, used for standard-definition television (CICP value 6). @@ -130,7 +147,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for HDTV and sRGB (CICP value 1). @@ -147,7 +164,7 @@ 12 - To be added. + SMPTE EG 432-1 (Display P3) color primaries used for wide-gamut displays (CICP value 12). @@ -164,7 +181,7 @@ 11 - To be added. + SMPTE RP 431-2 (DCI-P3 with DCI white point) color primaries used for digital cinema projection (CICP value 11). @@ -181,7 +198,7 @@ 7 - To be added. + SMPTE ST 240 (formerly SMPTE 240M) color primaries (CICP value 7). @@ -198,7 +215,7 @@ 10 - To be added. + SMPTE ST 428-1 (D65 white point) color primaries used for digital cinema (CICP value 10). @@ -215,7 +232,7 @@ 0 - To be added. + Unknown or unspecified color primaries (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index bddb849d..9598c7e5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,28 @@ System.Enum - To be added. - To be added. + Specifies the electro-optical transfer function of a color space using CICP (Coding-Independent Code Points) identifiers as defined in ITU-T H.273. + + alongside + to create a fully defined color space. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> + @@ -28,7 +48,7 @@ 18 - To be added. + ARIB STD-B67 (HLG) Hybrid Log-Gamma transfer function for HDR broadcast (CICP value 18). @@ -45,7 +65,7 @@ 13 - To be added. + IEC 61966-2-1 transfer characteristics, which defines the standard sRGB curve (CICP value 13). @@ -62,7 +82,7 @@ 11 - To be added. + IEC 61966-2-4 transfer characteristics (xvYCC) (CICP value 11). @@ -79,7 +99,7 @@ 8 - To be added. + Linear transfer characteristics with no gamma encoding (CICP value 8). @@ -96,7 +116,7 @@ 16 - To be added. + SMPTE ST 2084 (PQ) perceptual quantizer transfer function for HDR10 content (CICP value 16). @@ -113,7 +133,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer characteristics (CICP value 14). @@ -130,7 +150,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer characteristics (CICP value 15). @@ -147,7 +167,7 @@ 5 - To be added. + ITU-R BT.470 System B, G (PAL/SECAM) gamma 2.8 transfer characteristics (CICP value 5). @@ -164,7 +184,7 @@ 4 - To be added. + ITU-R BT.470 System M (NTSC) gamma 2.2 transfer characteristics (CICP value 4). @@ -181,7 +201,7 @@ 6 - To be added. + ITU-R BT.601 transfer characteristics for standard-definition television (CICP value 6). @@ -198,7 +218,7 @@ 1 - To be added. + ITU-R BT.709 transfer characteristics, also used by sRGB (CICP value 1). @@ -215,7 +235,7 @@ 7 - To be added. + SMPTE ST 240 transfer characteristics (CICP value 7). @@ -232,7 +252,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer characteristics for digital cinema (CICP value 17). @@ -249,7 +269,7 @@ 0 - To be added. + Unknown or unspecified transfer characteristics (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..c8cd0d5a 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,28 @@ - To be added. - To be added. + Specifies options for creating an XPS document. + + + @@ -37,9 +57,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the document can omit PNG images when a lossless alternative is unavailable. + + to allow omitting PNG images; otherwise, . + @@ -60,9 +81,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the dots-per-inch resolution for rasterized content in the document. + The resolution in dots per inch. + @@ -89,10 +110,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -116,10 +138,11 @@ - 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 +164,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current instance. + @@ -163,11 +186,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -187,11 +211,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 57ae755b..f088efa3 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,34 @@ - To be added. - To be added. + Specifies arguments used to create or clone a typeface with specific font variation and palette settings. + + +when creating a variant of an existing typeface. Use it to select a named instance +from a font collection, apply a specific color palette, override individual palette +colors, or set variation axis positions. + +This is a value type — no disposal is required. + +## 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 +67,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 index of the desired typeface in a TTC (TrueType Collection) or similar multi-face file. Use 0 for single-face files. + @@ -64,9 +90,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 color palette as defined in the CPAL table of the font. + @@ -87,9 +113,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the palette color overrides to apply when creating the typeface. + A span of values that replace specific palette entries by index. + @@ -110,9 +136,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation axis positions used when creating the typeface. + A span of values specifying the axis tag and design-space value for each axis to set. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..9e2f9950 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,29 @@ - To be added. - To be added. + Represents an override for a single color entry in a font color palette. + + +to customize individual palette entries when cloning a typeface. + +This is a value type — no disposal is required. + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = 0xFF_FF0000u }, // override index 0 with red +}; +var args = new SKFontArguments { PaletteOverrides = overrides }; +using var colorTypeface = typeface.Clone(args); +``` +]]> + @@ -37,9 +58,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement ARGB color value for the palette entry. + A packed 32-bit ARGB color value to use instead of the palette's default color at . + @@ -66,10 +87,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -93,10 +115,11 @@ - 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 +141,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +164,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 within the font's color palette that this override replaces. + @@ -163,11 +186,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -187,11 +211,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 8696fae6..4a166bfd 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 of a variable font. + + +or . + +This is a value type — no disposal is required. + +## Examples + +```csharp +foreach (var axis in typeface.VariationDesignParameters) +{ + Console.WriteLine($"{axis.Tag}: [{axis.Min}, {axis.Max}], default={axis.Default}"); +} +``` +]]> + @@ -37,9 +59,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 value used when this axis is not explicitly set. + @@ -66,10 +88,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -93,10 +116,11 @@ - 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 the hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +165,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this axis should be hidden from user-facing controls. + + if the axis is marked as hidden in the font; 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 upper bound of the design-space range. + @@ -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 lower bound of the design-space range. + @@ -209,11 +234,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -233,11 +259,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + @@ -258,9 +285,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 identifying the axis (for example, 'wght' for weight or 'wdth' for width). + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..f755f881 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,31 @@ - To be added. - To be added. + Specifies a single variation axis value used when creating or cloning a variable-font typeface. + + to position the typeface +along specific axes when calling . + +This is a value type — no disposal is required. + +## Examples + +```csharp +var position = new SKFontVariationPositionCoordinate[] +{ + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("ital"), Value = 1 }, +}; +var args = new SKFontArguments { VariationDesignPosition = position }; +using var styledTypeface = typeface.Clone(args); +``` +]]> + @@ -37,9 +60,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag identifying the variation axis. + An that identifies the axis to set (for example, 'wght' for weight). + @@ -66,10 +89,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -93,10 +117,11 @@ - 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 +143,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current instance. + @@ -140,11 +165,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -164,11 +190,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + @@ -189,9 +216,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for this variation axis. + The design-space value to apply to the axis identified by . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..f4731710 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 commonly used to identify font features, variation axes, and color palette entries. + + . +Implicit conversions to and from `uint` are also provided. + +This is a value type — no disposal is required. + +## Examples + +```csharp +var wght = SKFourByteTag.Parse("wght"); // weight axis +var italic = new SKFourByteTag('i', 't', 'a', 'l'); +uint raw = wght; // implicit conversion to uint +Console.WriteLine(wght.ToString()); // "wght" +``` +]]> + @@ -37,9 +61,9 @@ - To be added. - To be added. - To be added. + The raw 32-bit tag value. + Initializes a new instance of the struct with the specified raw 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 (most significant byte). + The second character. + The third character. + The fourth character (least significant byte). + Initializes a new instance of the struct with the specified four characters. + @@ -85,10 +109,11 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + + if the specified value is equal to the current instance; otherwise, . + @@ -112,10 +137,11 @@ - 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, . + @@ -132,9 +158,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current instance. + @@ -154,11 +180,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are equal. + + if the two values are equal; otherwise, . + @@ -177,10 +204,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Converts an to its underlying 32-bit unsigned integer value. + The underlying 32-bit unsigned integer value of the tag. + @@ -199,10 +226,10 @@ - To be added. - To be added. - To be added. - To be added. + The 32-bit unsigned integer value. + Converts a 32-bit unsigned integer to an . + An wrapping the specified value. + @@ -222,11 +249,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Determines whether two values are not equal. + + if the two values are not equal; otherwise, . + @@ -250,10 +278,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. A or empty string returns a zero tag. + Creates an from a string of up to four characters. + An representing the four-byte encoding of the string. + @@ -275,9 +303,9 @@ - To be added. - To be added. - To be added. + Returns the four-character string representation of this tag. + A four-character string formed from the four bytes of the tag value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 9ed1121c..c4b59a1f 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml @@ -1446,11 +1446,12 @@ 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 path builder that receives the resulting filled path. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + @@ -1633,12 +1634,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. + The source path to process. + The path builder that receives the resulting filled path. + A matrix applied to the source path before computing the fill. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + @@ -1659,12 +1661,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. + The source path to process. + The path builder that receives the resulting filled path. + A rectangle used to clip the output; path elements outside this rectangle may be omitted. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + @@ -1685,12 +1688,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. + The source path to process. + The path builder that receives the resulting filled path. + A scale factor used to control the precision of curve approximations. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + @@ -1844,13 +1848,14 @@ 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 path builder that receives the resulting filled path. + A rectangle used to clip the output; path elements outside this rectangle may be omitted. + A matrix applied to the source path before computing the fill. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + @@ -1872,13 +1877,14 @@ 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 path builder that receives the resulting filled path. + A rectangle used to clip the output; path elements outside this rectangle may be omitted. + A scale factor used to control the precision of curve approximations. + Computes the filled path that results from applying this paint's stroke and path effects to the source path. + + if the result is non-empty; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..b834ccf6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPath.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml @@ -189,8 +189,8 @@ The path containing the elements to be added to the current path. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path, using the specified extension mode. + One of the enumeration values that specifies whether the added path is appended or extended from the last point. + Adds the elements of another path to this path. @@ -230,9 +230,9 @@ The path containing the elements to be added to the current path. - Transformation matrix applied to the path. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path, by applying the specified transformation matrix, using the specified extension mode. + A matrix to apply to the points of before adding them. + One of the enumeration values that specifies whether the added path is appended or extended from the last point. + Adds the elements of another path to this path. @@ -265,10 +265,10 @@ The path containing the elements to be added to the current path. - The amount to translate the path in X as it is added. - The amount to translate the path in Y as it is added. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path offset by (, ), using the specified extension mode. + The horizontal offset applied to before adding. + The vertical offset applied to before adding. + One of the enumeration values that specifies whether the added path is appended or extended from the last point. + Adds the elements of another path to this path. @@ -298,7 +298,7 @@ The path containing the elements to be added to the current path. - Extends the current path with the path elements from another path in reverse order. + Adds the elements of another path to this path in reverse order. @@ -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 the native handle to the underlying Skia path object. + A pointer to the underlying native path object. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..5bcf5e6b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,32 @@ - To be added. - To be added. + Provides a mutable builder for constructing objects incrementally. + + +to get an immutable `SKPath` snapshot (the builder retains its state) or + to transfer ownership and reset the builder. + +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()`. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(0, 0); +builder.LineTo(100, 0); +builder.LineTo(100, 100); +builder.Close(); +using var path = builder.Snapshot(); +canvas.DrawPath(path, paint); +``` +]]> + @@ -26,8 +50,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + @@ -43,9 +67,9 @@ - To be added. - To be added. - To be added. + The path to copy into this builder. + Initializes a new instance of the class by copying an existing 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. + The start angle of the arc in degrees, measured clockwise from the positive x-axis. + The sweep angle of the arc in degrees. + Adds an arc of an 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 center. + The y-coordinate of the center. + The radius of the circle. + One of the enumeration values that specifies the winding direction of the contour. + Adds a circle 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 the winding direction of the contour. + Adds an oval (ellipse) contour to the path. + @@ -140,10 +164,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose elements are added. + One of the enumeration values that specifies how the path is added. + Adds the elements of another path to this builder. + @@ -170,11 +194,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose elements are added. + A matrix applied to the added path's points. + One of the enumeration values that specifies how the path is added. + Adds the elements of another path, transformed by the specified 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 elements are added. + The horizontal offset applied to the added path's points. + The vertical offset applied to the added path's points. + One of the enumeration values that specifies how the path is added. + Adds the elements of another path, offset by the specified amount. + @@ -221,10 +245,11 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + + to close the contour; otherwise, . + Adds a polygon contour to the path. + @@ -244,10 +269,11 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + + to close the contour; otherwise, . + Adds a polygon contour to the path. + @@ -267,10 +293,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 contour. + Adds a rectangle contour to the path. + @@ -291,11 +317,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 of the contour. + The zero-based index (0–3) of the corner at which to start the contour. + Adds a rectangle contour starting at a specified corner. + @@ -315,10 +341,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 contour. + Adds a rounded rectangle contour to the path. + @@ -339,11 +365,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 of the contour. + The zero-based index of the corner at which to start the contour. + Adds a rounded rectangle contour starting at a specified corner. + @@ -365,12 +391,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle. + The x-radius of the rounded corners. + The y-radius of the rounded corners. + One of the enumeration values that specifies the winding direction of the contour. + Adds a rounded rectangle contour with uniform corner radii to the path. + @@ -391,11 +417,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The end point of the first tangent line (starting from the last path point). + The end point of the second tangent line. + The radius of the arc. + Adds a tangent arc that connects two lines through a specified radius. + @@ -417,12 +443,13 @@ - 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 start angle of the arc in degrees, measured clockwise from the positive x-axis. + The sweep angle of the arc in degrees. + + to start a new contour at the arc start; to connect from the last point with a line. + Adds an arc of an oval to the path. + @@ -445,13 +472,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 ellipse. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values indicating whether to use the large or small arc. + One of the enumeration values indicating the arc direction. + The end point of the arc. + Adds an SVG-style arc segment to the path using absolute coordinates. + @@ -474,13 +501,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 end of the first tangent line. + The y-coordinate of the end of the first tangent line. + The x-coordinate of the end of the second tangent line. + The y-coordinate of the end of the second tangent line. + The radius of the arc. + Adds a tangent arc that connects two lines through a specified radius. + @@ -505,15 +532,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 ellipse. + The y-radius of the ellipse. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values indicating whether to use the large or small arc. + One of the enumeration values indicating the arc direction. + The x-coordinate of the end point. + The y-coordinate of the end point. + Adds an SVG-style arc segment to the path using absolute coordinates. + @@ -530,8 +557,8 @@ - To be added. - To be added. + Closes the current contour by drawing a line back to the starting point. + @@ -552,11 +579,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point. + The end point of the curve. + The weight of the control point, controlling the curve's shape. + Adds a conic (rational quadratic Bézier) curve segment using absolute coordinates. + @@ -579,13 +606,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 control point. + Adds a conic (rational quadratic Bézier) curve segment using absolute coordinates. + @@ -606,11 +633,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. + Adds a cubic Bézier curve segment using absolute coordinates. + @@ -634,14 +661,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. + Adds a cubic Bézier curve segment using absolute coordinates. + @@ -658,9 +685,9 @@ - To be added. - To be added. - To be added. + Detaches and returns the current path, resetting the builder to an empty state. + The accumulated . The caller takes ownership and is responsible for disposing it. + @@ -679,9 +706,10 @@ - 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 +726,8 @@ - To be added. - To be added. + Releases the native resources used by the current instance of the class. + @@ -715,9 +743,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type used by the paths produced by this builder. + One of the enumeration values that specifies how overlapping regions are filled. + @@ -736,9 +764,9 @@ - To be added. - To be added. - To be added. + The end point of the line. + Adds a straight line segment from the last point to the specified point. + @@ -758,10 +786,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. + Adds a straight line segment from the last point to the specified coordinates. + @@ -780,9 +808,9 @@ - To be added. - To be added. - To be added. + The starting point of the new contour. + Starts a new contour at the specified point. + @@ -802,10 +830,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. + Starts a new contour at the specified coordinates. + @@ -825,10 +853,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point. + The end point of the curve. + Adds a quadratic Bézier curve segment using absolute coordinates. + @@ -850,12 +878,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. + Adds a quadratic Bézier curve segment using absolute coordinates. + @@ -878,13 +906,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 ellipse. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values indicating whether to use the large or small arc. + One of the enumeration values indicating the arc direction. + The offset from the last point to the end point of the arc. + Adds an SVG-style arc segment using offsets relative to the last point. + @@ -909,15 +937,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 ellipse. + The y-radius of the ellipse. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values indicating whether to use the large or small arc. + One of the enumeration values indicating the arc direction. + The horizontal offset from the last point to the end point. + The vertical offset from the last point to the end point. + Adds an SVG-style arc segment using offsets relative to the last point. + @@ -938,11 +966,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the last point to the control point. + The offset from the last point to the end point. + The weight of the control point. + Adds a conic curve segment using offsets relative to the last point. + @@ -965,13 +993,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The horizontal offset to the control point. + The vertical offset to the control point. + The horizontal offset to the end point. + The vertical offset to the end point. + The weight of the control point. + Adds a conic curve segment using offsets relative to the last point. + @@ -992,11 +1020,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the last point to the first control point. + The offset from the last point to the second control point. + The offset from the last point to the end point. + Adds a cubic Bézier curve segment using offsets relative to the last point. + @@ -1020,14 +1048,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 horizontal offset to the first control point. + The vertical offset to the first control point. + The horizontal offset to the second control point. + The vertical offset to the second control point. + The horizontal offset to the end point. + The vertical offset to the end point. + Adds a cubic Bézier curve segment using offsets relative to the last point. + @@ -1044,8 +1072,8 @@ - To be added. - To be added. + Resets the builder to an empty state, discarding all accumulated path data. + @@ -1064,9 +1092,9 @@ - To be added. - To be added. - To be added. + The path whose elements are added in reverse. + Adds the elements of another path to this builder in reverse order. + @@ -1085,9 +1113,9 @@ - To be added. - To be added. - To be added. + The offset from the last point to the end of the line. + Adds a straight line segment from the last point to the specified offset. + @@ -1107,10 +1135,10 @@ - To be added. - To be added. - To be added. - To be added. + The horizontal offset from the last point. + The vertical offset from the last point. + Adds a straight line segment from the last point to the specified offset. + @@ -1129,9 +1157,9 @@ - To be added. - To be added. - To be added. + The offset from the last point to the new contour start. + Starts a new contour at the specified offset relative to the last point. + @@ -1151,10 +1179,10 @@ - To be added. - To be added. - To be added. - To be added. + The horizontal offset from the last point. + The vertical offset from the last point. + Starts a new contour at the specified offset relative to the last point. + @@ -1174,10 +1202,10 @@ - To be added. - To be added. - To be added. - To be added. + The offset from the last point to the control point. + The offset from the last point to the end point. + Adds a quadratic Bézier curve segment using offsets relative to the last point. + @@ -1199,12 +1227,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The horizontal offset from the last point to the control point. + The vertical offset from the last point to the control point. + The horizontal offset from the last point to the end point. + The vertical offset from the last point to the end point. + Adds a quadratic Bézier curve segment using offsets relative to the last point. + @@ -1221,9 +1249,9 @@ - To be added. - To be added. - To be added. + Returns a snapshot of the current path without resetting the builder. + A new containing the current path data. The caller takes ownership and is responsible for disposing it. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..60200d2a 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -345,13 +345,15 @@ - 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 path builder that receives the extracted segment. + + to begin the segment with a move-to command; otherwise, . + Extracts a segment of the path between two distances into a path builder. + + if a segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..bb5cea2f 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 entire contents of the stream as an object. + An containing all the bytes in the stream, or if not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..96482544 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 point at which the top-left corner of this surface is placed. + The sampling options used when scaling or transforming the surface pixels. + The paint to apply, or to use default settings. + Draws this surface's contents onto the specified canvas at the given point. + @@ -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 x-coordinate at which the left edge of this surface is placed. + The y-coordinate at which the top edge of this surface is placed. + The sampling options used when scaling or transforming the surface pixels. + The paint to apply, or to use default settings. + Draws this surface's contents onto the specified canvas at the given coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index b0f4c2f3..237a7dbb 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 variation positions, palette index, palette overrides, and collection index. + Creates a new typeface by applying the specified font arguments to this typeface. + A new with the specified 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 color palette to select. + Creates a new typeface using the specified color palette index. + A new 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. + A span of variation axis coordinates specifying the desired position along each axis. + Creates a new typeface by applying the specified variation axis positions. + A new positioned at the specified variation design 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 shared empty typeface that contains no glyphs. + A shared 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 fill with variation axis information. + Gets the variation axis metadata for this typeface into the provided span. + The total number of variation axes available; may be larger than the number written if is smaller. + @@ -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 fill with variation position coordinates. + Gets the current variation axis positions for this typeface into the provided span. + The total number of coordinates available; may be larger than the number written if is smaller. + @@ -1859,9 +1859,10 @@ 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 +2220,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 by this typeface. + The number of variation axes, or 0 if the typeface is not a variable font. + @@ -2237,9 +2238,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 the variation axis metadata for all axes of this typeface. + An array of values, or an empty array if the typeface has no variation axes. + @@ -2255,9 +2256,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 the current variation axis positions for this typeface. + An array of values representing the current position along each axis. + @@ -2273,9 +2274,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 positions set on this typeface. + The number of active variation axis coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..b7d48dce 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 the WebP format. + + source and write to a stream or return +an . Animated methods accept a span of + values with per-frame durations. + +This is a static class — no instantiation or disposal is required. + +## Examples + +```csharp +using var bitmap = SKBitmap.Decode("photo.png"); +using var pixmap = bitmap.PeekPixels(); +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80); +using var data = SKWebpEncoder.Encode(pixmap, options); +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 pixel data to encode. + The encoding options, including quality and compression mode. + Encodes a single image to the WebP format. + An containing the encoded WebP data, or if encoding failed. + @@ -72,12 +93,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream that receives the encoded WebP data. + The pixel data to encode. + The encoding options, including quality and compression mode. + Encodes a single image to the WebP format. + + if encoding succeeded; otherwise, . + @@ -103,12 +125,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream that receives the encoded WebP data. + The pixel data to encode. + The encoding options, including quality and compression mode. + Encodes a single image to the WebP format. + + if encoding succeeded; otherwise, . + @@ -133,11 +156,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The frames to encode, each with pixel data and a display duration. + The encoding options applied to all frames. + Encodes a sequence of frames as an animated WebP image. + An containing the animated WebP data, or if encoding failed. + @@ -164,12 +187,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream that receives the animated WebP data. + The frames to encode, each with pixel data and a display duration. + The encoding options applied to all frames. + Encodes a sequence of frames as an animated WebP image. + + if encoding succeeded; otherwise, . + @@ -196,12 +220,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream that receives the animated WebP data. + The frames to encode, each with pixel data and a display duration. + The encoding options applied to all frames. + Encodes a sequence of frames as an animated WebP image. + + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..4dad258b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,33 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence, combining pixel data with a display duration. + + , , or , +then pass a span of frames to +. + +This is a value type — no disposal is required, but the referenced + must remain valid for the duration of the encoding call. + +## Examples + +```csharp +var frames = new SKWebpEncoderFrame[] +{ + new SKWebpEncoderFrame(bitmap1, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(bitmap2, TimeSpan.FromMilliseconds(100)), +}; +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80); +using var data = SKWebpEncoder.EncodeAnimated(frames, options); +``` +]]> + @@ -29,10 +54,10 @@ - To be added. - To be added. - To be added. - To be added. + The bitmap providing the pixel data for this frame. + The duration for which this frame is displayed. + Initializes a new instance of the struct from a bitmap. + @@ -49,10 +74,10 @@ - To be added. - To be added. - To be added. - To be added. + The raster-backed image providing the pixel data for this frame. + The duration for which this frame is displayed. + Initializes a new instance of the struct from a raster-backed image. + @@ -69,10 +94,10 @@ - To be added. - To be added. - To be added. - To be added. + The pixmap providing the pixel data for this frame. + The duration for which this frame is displayed. + Initializes a new instance of the struct from a pixmap. + @@ -93,9 +118,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the duration for which this frame is displayed. + The display duration of this frame. + @@ -116,9 +141,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixel data for this frame. + The containing the pixel data. Must remain valid for the duration of any encoding call that references this frame. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..8c57ce92 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,13 +3124,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp integer rectangle to convert. + Converts a to a . + A with the same bounds. + @@ -3146,13 +3146,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp color to convert. + Converts a to a . + A with the same color values. + @@ -3168,13 +3168,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp floating-point color to convert. + Converts a to a . + A with the same color values. + @@ -3190,13 +3190,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp point to convert. + Converts a to a . + A with the same coordinates. + @@ -3212,13 +3212,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp 3D point to convert. + Converts a to a . + A with the same coordinates. + @@ -3234,13 +3234,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp rectangle to convert. + Converts a to a . + A with the same bounds. + @@ -3256,13 +3256,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp size to convert. + Converts a to a . + A with the same dimensions. + @@ -3478,13 +3478,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The GDK color to convert. + Converts a to a . + An with the same color values. + @@ -3500,13 +3500,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The GDK color to convert. + Converts a to a . + An with the same floating-point color values. + @@ -3568,13 +3568,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The Graphene point to convert. + Converts a to a . + An with the same coordinates. + @@ -3590,13 +3590,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The Graphene 3D point to convert. + Converts a to a . + An with the same coordinates. + @@ -3634,13 +3634,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The Graphene rectangle to convert. + Converts a to a . + An with the same bounds. + @@ -3678,13 +3678,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The Graphene size to convert. + Converts a to a . + An with the same dimensions. + @@ -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.