diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..e1abf9dd 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. + Returns 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 design coordinate values. + Fills the specified span with the design coordinates for the given named instance. + The number of coordinates written to the span. + @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the number of design coordinates for the specified named instance. + The number of design coordinates. + @@ -235,10 +235,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the name ID of the PostScript name for the specified named instance. + The of the PostScript name. + @@ -257,10 +257,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the name ID of the subfamily name for the specified named instance. + The of the subfamily name. + @@ -279,10 +279,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette color entry. + Returns the name ID for the color at the specified index across all palettes. + The of the color entry. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the ARGB color values for the specified palette. + An array of packed ARGB color values. + @@ -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 packed ARGB color values. + Fills the specified span with the ARGB color values for the given palette. + The number of colors written to the span. + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the flags for the specified color palette. + A bitwise combination of values describing the palette. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the name ID for the specified color palette. + The of the palette. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + The span to fill with variation axis information. + Fills the specified span with variation axis information for this face. + The number of variation axes written to the span. + @@ -428,9 +428,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this face contains color layer data (COLR table). + + if the face has color layers; otherwise, . + @@ -446,9 +447,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this face contains PNG-based color glyphs. + + if the face has PNG color glyphs; otherwise, . + @@ -464,9 +466,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this face contains SVG-based color glyphs. + + if the face has SVG color glyphs; otherwise, . + @@ -482,9 +485,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this face contains color palettes (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 this face contains variable font data. + + 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 variation instances defined in this face. + The number of named instances. + @@ -591,9 +596,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes defined in this face. + The number of color palettes. + @@ -653,11 +658,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The tag of the variation axis to find. + When this method returns, contains the axis information if found. This parameter is treated as uninitialized. + Searches for a variation axis by its 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 defined in this face. + The number of variation axes. + @@ -709,9 +715,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets the variation axis information for all axes defined in this face. + An array of describing each variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..de346bd5 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 normalized variation coordinate values. + Fills the specified span with the current normalized variation coordinates for this font. + The number of coordinates written to the span. + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + The design coordinate values, one per variation axis. + Sets the variation design coordinates for this font. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + The normalized coordinate values in the range [-1, 1], one per variation axis. + Sets the normalized variation coordinates for this font. + @@ -621,9 +621,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the named instance to activate. + Sets the variation coordinates to match the specified named instance. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + The tag-value pairs specifying the variation axis values to apply. + Sets the variation axis values for this font. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates for this font. + An array of normalized variation coordinate values in the range [-1, 1]. + 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..708fc59b 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -70,13 +70,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same bounds. + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with equivalent color values. + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with equivalent color values. + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same coordinates. + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same coordinates. + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same bounds. + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same dimensions. + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with equivalent color values. + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with equivalent color values. + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same coordinates. + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same coordinates. + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same bounds. + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + 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..3a44ddaa 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,22 @@ - To be added. - To be added. + Specifies the component swizzle mapping for a Vulkan YCbCr sampler conversion. + + . + +## Examples + +```csharp +var components = new GRVkYcbcrComponents { R = 0, G = 1, B = 2, A = 3 }; +``` +]]> + @@ -37,9 +51,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the source component index that maps to the alpha channel. + The index of the source component for the alpha channel. + @@ -60,9 +74,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the source component index that maps to the blue channel. + The index of the source component for the blue channel. + @@ -89,10 +103,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -116,10 +131,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 and is equal to the current instance; otherwise, . + @@ -140,9 +156,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the source component index that maps to the green channel. + The index of the source component for the green channel. + @@ -164,9 +180,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -186,11 +202,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -210,11 +227,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 instances are not equal. + + if the two values are not equal; otherwise, . + @@ -235,9 +253,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the source component index that maps to the red channel. + The index of the source component for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..6fbccb64 100644 --- a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml @@ -68,9 +68,9 @@ SkiaSharp.GRVkYcbcrComponents - To be added. - To be added. - To be added. + Gets or sets the component swizzle mapping for the YCbCr conversion. + The component swizzle mapping. + @@ -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 must match the chroma filter; 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 the chroma samples. + + if linear filtering is supported; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..09279ded 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 to use when drawing. + The paint to use when drawing, or to use the default paint. + Draws a surface at the specified point using the given sampling options. + @@ -3059,13 +3059,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The x-coordinate at which to draw the top-left corner of the surface. + The y-coordinate at which to draw the top-left corner of the surface. + The sampling options to use when drawing. + The paint to use when drawing, or to use the default paint. + Draws a surface at the specified coordinates using the given sampling options. + @@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use - - - + + + Method SkiaSharp - 3.116.0.0 - 3.119.0.0 - 4.147.0.0 + 2.80.0.0 + 2.88.0.0 System.Void - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - + - The matrix to set as the current transformation matrix. + The matrix that will be copied into the current matrix. Replaces the current matrix with a copy of the specified matrix. - - - + + + Method SkiaSharp - 2.80.0.0 - 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 System.Void - + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + - The matrix that will be copied into the current matrix. + The matrix to set as the current transformation matrix. Replaces the current matrix with a copy of the specified matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index 9e7e0d87..37daef93 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 function. + Creates a color space from CICP (Coding-independent Code Points) primaries and transfer function values. + A new , or if the CICP values are not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..e003aba5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + BGRA format with 10 bits per channel in extended range (XR), stored as a 32-bit unsigned integer. @@ -234,7 +234,7 @@ 27 - To be added. + Single red channel with 16-bit unsigned normalized value. @@ -519,7 +519,7 @@ 26 - To be added. + RGB format with 16-bit float per channel and an unused padding channel. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..d19bee71 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,24 @@ System.Enum - To be added. - To be added. + Specifies the color primaries component of a CICP (Coding-independent Code Points) color space descriptor. + + to create a color space from CICP values. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> + @@ -28,7 +44,7 @@ 8 - To be added. + Generic film color primaries (CICP value 8). @@ -45,7 +61,7 @@ 22 - To be added. + ITU-T H.273 value 22 color primaries, used for EBU Tech 3213-E (CICP value 22). @@ -62,7 +78,7 @@ 9 - To be added. + ITU-R BT.2020 color primaries, used for ultra-high-definition television (CICP value 9). @@ -79,7 +95,7 @@ 5 - To be added. + ITU-R BT.470 System B/G color primaries, used for analog PAL/SECAM (CICP value 5). @@ -96,7 +112,7 @@ 4 - To be added. + ITU-R BT.470 System M color primaries, used for analog NTSC (CICP value 4). @@ -113,7 +129,7 @@ 6 - To be added. + ITU-R BT.601 color primaries, used for standard-definition television (CICP value 6). @@ -130,7 +146,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for standard HDTV (CICP value 1). @@ -147,7 +163,7 @@ 12 - To be added. + SMPTE EG 432-1 color primaries (P3-D65), used for Display P3 (CICP value 12). @@ -164,7 +180,7 @@ 11 - To be added. + SMPTE RP 431-2 color primaries (P3-DCI), used for digital cinema projectors (CICP value 11). @@ -181,7 +197,7 @@ 7 - To be added. + SMPTE ST 240 color primaries, used for early 1080i HDTV (CICP value 7). @@ -198,7 +214,7 @@ 10 - To be added. + SMPTE ST 428-1 color primaries, used for digital cinema (CICP value 10). @@ -215,7 +231,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..22fe155d 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 transfer function component of a CICP (Coding-independent Code Points) color space descriptor. + + to create a color space from CICP values. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> + @@ -28,7 +44,7 @@ 18 - To be added. + Hybrid Log-Gamma (HLG) transfer function for HDR broadcasting (CICP value 18). @@ -45,7 +61,7 @@ 13 - To be added. + IEC 61966-2-1 transfer function, used for sRGB and sYCC (CICP value 13). @@ -62,7 +78,7 @@ 11 - To be added. + IEC 61966-2-4 transfer function, used for xvYCC (CICP value 11). @@ -79,7 +95,7 @@ 8 - To be added. + Linear transfer function with no gamma encoding (CICP value 8). @@ -96,7 +112,7 @@ 16 - To be added. + SMPTE ST 2084 (PQ) perceptual quantizer transfer function for HDR content (CICP value 16). @@ -113,7 +129,7 @@ 14 - To be added. + ITU-R BT.2020 transfer function for 10-bit systems (CICP value 14). @@ -130,7 +146,7 @@ 15 - To be added. + ITU-R BT.2020 transfer function for 12-bit systems (CICP value 15). @@ -147,7 +163,7 @@ 5 - To be added. + ITU-R BT.470 System B/G transfer function, assumed gamma 2.8 (CICP value 5). @@ -164,7 +180,7 @@ 4 - To be added. + ITU-R BT.470 System M transfer function, assumed gamma 2.2 (CICP value 4). @@ -181,7 +197,7 @@ 6 - To be added. + ITU-R BT.601 transfer function, used for standard-definition television (CICP value 6). @@ -198,7 +214,7 @@ 1 - To be added. + ITU-R BT.709 transfer function, used for standard HDTV (CICP value 1). @@ -215,7 +231,7 @@ 7 - To be added. + SMPTE ST 240 transfer function, used for early 1080i HDTV (CICP value 7). @@ -232,7 +248,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer function, used for digital cinema (CICP value 17). @@ -249,7 +265,7 @@ 0 - To be added. + Unknown or unspecified transfer function (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..39fe0680 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,22 @@ - To be added. - To be added. + Specifies options for creating an XPS document. + + + @@ -37,9 +51,10 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the document can be created without PNG image support. + + if PNG images may be omitted; otherwise, . + @@ -60,9 +75,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the dots per inch (DPI) resolution for the XPS document. + The resolution in dots per inch. + @@ -89,10 +104,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -116,10 +132,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 and is equal to the current instance; otherwise, . + @@ -141,9 +158,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -163,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -187,11 +205,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 instances 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..af5b0817 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,28 @@ - To be added. - To be added. + Specifies font arguments used when cloning a typeface with custom variation and palette settings. + + . + +## Examples + +```csharp +var args = new SKFontArguments +{ + VariationDesignPosition = new SKFontVariationPositionCoordinate[] + { + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 } + }, + PaletteIndex = 0 +}; +using var typeface = original.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 font to use within a font collection. + The index of the font within the collection. + @@ -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 color palette. + @@ -87,9 +107,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the color overrides for individual entries in the selected palette. + A span of palette color overrides. + @@ -110,9 +130,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the axis coordinates for variable font design positions. + A span of axis-value coordinate pairs. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..e9401bda 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,23 @@ - To be added. - To be added. + Specifies a color override for a single entry in a font color palette. + + . + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = 0xFFFF0000 } +}; +``` +]]> + @@ -37,9 +52,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement ARGB color value for the palette entry. + The ARGB color value as a packed 32-bit unsigned integer. + @@ -66,10 +81,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -93,10 +109,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 and is equal to the current instance; otherwise, . + @@ -118,9 +135,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -141,9 +158,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 palette entry. + @@ -163,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -187,11 +205,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 instances 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..35ae0d7c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,24 @@ - To be added. - To be added. + Describes a single axis in a variable font's variation design space. + + . + +## Examples + +```csharp +var axes = typeface.VariationDesignParameters; +foreach (var axis in axes) +{ + Console.WriteLine($"{axis.Tag}: {axis.Min}..{axis.Default}..{axis.Max}"); +} +``` +]]> + @@ -37,9 +53,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default value for this variation axis. + The default axis value. + @@ -66,10 +82,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -93,10 +110,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 and is equal to the current instance; otherwise, . + @@ -118,9 +136,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -141,9 +159,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 the user interface. + + if the axis is hidden; otherwise, . + @@ -164,9 +183,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum value for this variation axis. + The maximum axis value. + @@ -187,9 +206,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum value for this variation axis. + The minimum axis value. + @@ -209,11 +228,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -233,11 +253,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 instances are not equal. + + if the two values are not equal; otherwise, . + @@ -258,9 +279,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-character tag that identifies this variation axis. + The axis tag as an . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..e4e2ab3e 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,24 @@ - To be added. - To be added. + Specifies a coordinate on a single axis in a variable font's design position. + + . + +## Examples + +```csharp +var coords = new SKFontVariationPositionCoordinate[] +{ + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wdth"), Value = 100 } +}; +``` +]]> + @@ -37,9 +53,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-character tag identifying the variation axis. + The axis tag as an . + @@ -66,10 +82,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -93,10 +110,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 and is equal to the current instance; otherwise, . + @@ -118,9 +136,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -140,11 +158,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -164,11 +183,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 instances are not equal. + + if the two values are not equal; otherwise, . + @@ -189,9 +209,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the value for the variation axis. + The axis value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..52c487c4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,27 @@ - To be added. - To be added. + Represents a four-character code (FourCC) identifier used to tag font features, variation axes, and other typed values. + + + @@ -37,9 +56,9 @@ - To be added. - To be added. - To be added. + The 32-bit unsigned integer representing the four-byte tag. + Initializes a new instance of the struct with the specified packed value. + @@ -58,12 +77,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The first character. + The second character. + The third character. + The fourth character. + Initializes a new instance of the struct from four characters. + @@ -85,10 +104,11 @@ - 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 value is equal to the current instance; otherwise, . + @@ -112,10 +132,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 with the same value; otherwise, . + @@ -132,9 +153,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -154,11 +175,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 instances are equal. + + if the two values are equal; otherwise, . + @@ -177,10 +199,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Implicitly converts an to a 32-bit unsigned integer. + The packed 32-bit unsigned integer value of the tag. + @@ -199,10 +221,10 @@ - To be added. - To be added. - To be added. - To be added. + The 32-bit unsigned integer to convert. + Implicitly converts a 32-bit unsigned integer to an . + An with the specified packed value. + @@ -222,11 +244,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 instances are not equal. + + if the two values are not equal; otherwise, . + @@ -250,10 +273,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. If the string is shorter than four characters, it is padded with spaces. If or empty, returns a zero-valued tag. + Parses a string of up to four characters into an . + An representing the first four characters of the string. + @@ -275,9 +298,9 @@ - To be added. - To be added. - To be added. + Returns the string representation of this four-byte tag. + A four-character string where each character corresponds to one byte of the tag value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 9ed1121c..5c7f9718 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 compute the fill for. + The path builder that receives the computed fill path. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; 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 compute the fill for. + The path builder that receives the computed fill path. + The matrix to apply to the source path before computing the fill. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; 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 compute the fill for. + The path builder that receives the computed fill path. + A rectangle used to cull path elements outside the visible area. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; 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 compute the fill for. + The path builder that receives the computed fill path. + The resolution scale factor applied when computing the fill. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; 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 compute the fill for. + The path builder that receives the computed fill path. + A rectangle used to cull path elements outside the visible area. + The matrix to apply to the source path before computing the fill. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; 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 compute the fill for. + The path builder that receives the computed fill path. + A rectangle used to cull path elements outside the visible area. + The resolution scale factor applied when computing the fill. + Attempts to compute the fill path from the source path using the current paint settings. + + if the fill path was successfully computed; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..1550d643 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPath.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml @@ -188,9 +188,9 @@ - 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. + The path to add. + One of the enumeration values that specifies how the path is added. + Appends the specified path to this path. @@ -229,10 +229,10 @@ - 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. + The path to add. + The transformation matrix to apply to the path before adding. + One of the enumeration values that specifies how the path is added. + Appends the specified path to this path after applying a transformation matrix. @@ -264,11 +264,11 @@ - 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 path to add. + The horizontal offset to apply before adding. + The vertical offset to apply before adding. + One of the enumeration values that specifies how the path is added. + Appends the specified path to this path, offset by the given translation. @@ -297,8 +297,8 @@ - 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. + The path to add in reverse. + Appends the specified 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 or sets the handle to the underlying native object. + The native handle. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..f5880a60 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,25 @@ - To be added. - To be added. + Provides a mutable builder for constructing objects incrementally. + + to transfer ownership of the path to a new , or to get a read-only copy while keeping the builder intact. + +Always dispose of the builder when finished: + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(0, 0); +builder.LineTo(100, 0); +builder.LineTo(100, 100); +builder.Close(); +using var path = builder.Detach(); +``` +]]> + @@ -26,8 +43,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + @@ -43,9 +60,9 @@ - To be added. - To be added. - To be added. + The path whose contents to copy into the builder. + Initializes a new instance of the class with the contents of the specified path. + @@ -66,11 +83,11 @@ - 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 starts. + The sweep angle in degrees. + Adds an arc of an oval inscribed within the specified rectangle. + @@ -92,12 +109,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. + Adds a closed circle contour centered at the specified coordinates. + @@ -117,10 +134,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. + Adds a closed oval contour inscribed within the specified rectangle. + @@ -140,10 +157,10 @@ - To be added. - To be added. - To be added. - To be added. + The path to add. + One of the enumeration values that specifies how the path is added. + Appends the specified path to the path being built. + @@ -170,11 +187,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path to add. + The transformation matrix to apply to the path. + One of the enumeration values that specifies how the path is added. + Appends the specified path to the path being built after applying a transformation matrix. + @@ -196,12 +213,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The path to add. + The horizontal offset to apply. + The vertical offset to apply. + One of the enumeration values that specifies how the path is added. + Appends the specified path to the path being built, offset by the given translation. + @@ -221,10 +238,11 @@ - To be added. - To be added. - To be added. - To be added. + The array of points defining the polygon vertices. + + to close the polygon; otherwise, . + Adds a polygon contour defined by the specified array of points. + @@ -244,10 +262,11 @@ - To be added. - To be added. - To be added. - To be added. + The span of points defining the polygon vertices. + + to close the polygon; otherwise, . + Adds a polygon contour defined by the specified span of points. + @@ -267,10 +286,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. + Adds a closed rectangle contour to the path. + @@ -291,11 +310,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 index of the starting corner (0–3). + Adds a closed rectangle contour to the path starting at the specified corner index. + @@ -315,10 +334,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. + Adds a closed rounded rectangle contour to the path. + @@ -339,11 +358,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 index of the starting corner. + Adds a closed rounded rectangle contour to the path starting at the specified corner index. + @@ -365,12 +384,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounds of the rounded rectangle. + The x-radius of the corners. + The y-radius of the corners. + One of the enumeration values that specifies the winding direction. + Adds a closed rounded rectangle contour with uniform corner radii. + @@ -391,11 +410,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point. + The second tangent point (and end point of the arc). + The radius of the circular arc. + Adds a tangent arc connecting the current point to the specified end point via a tangent through two points. + @@ -417,12 +436,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounds of the oval that defines the arc. + The angle in degrees at which to start the arc. + The sweep angle in degrees. + + to start a new contour at the beginning of the arc; otherwise, to connect from the current point. + Adds an arc to the path within the specified oval, starting at the given angle. + @@ -445,13 +465,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 along the x and y axes. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values that specifies whether to use the large or small arc. + One of the enumeration values that specifies the direction of the arc. + The end point of the arc. + Adds an elliptical arc from the current point to the specified end point. + @@ -474,13 +494,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 circular arc. + Adds a tangent arc at the specified coordinates with the given radius. + @@ -505,15 +525,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 that specifies whether to use the large or small arc. + One of the enumeration values that specifies the direction of the arc. + The x-coordinate of the end point. + The y-coordinate of the end point. + Adds an elliptical arc from the current point to the specified coordinates. + @@ -530,8 +550,8 @@ - To be added. - To be added. + Closes the current contour by adding a line back to the start point. + @@ -552,11 +572,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point. + The end point. + The weight of the conic curve. + Adds a conic curve from the current point using a control point, end point, and weight. + @@ -579,13 +599,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. + Adds a conic curve using the specified control coordinates, end coordinates, and weight. + @@ -606,11 +626,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. + Adds a cubic Bézier curve from the current point using two control points and an end point. + @@ -634,14 +654,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 using the specified control and end coordinates. + @@ -658,9 +678,9 @@ - To be added. - To be added. - To be added. + Detaches and returns the constructed path, resetting the builder to an empty state. + A new containing the path built so far. + @@ -679,9 +699,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 +719,8 @@ - To be added. - To be added. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + @@ -715,9 +736,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type for the path being built. + One of the enumeration values that specifies how the interior of the path is determined. + @@ -736,9 +757,9 @@ - To be added. - To be added. - To be added. + The end point of the line. + Adds a straight line from the current point to the specified point. + @@ -758,10 +779,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 from the current point to the specified coordinates. + @@ -780,9 +801,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 +823,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 +846,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 from the current point to the specified end point using a control point. + @@ -850,12 +871,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 from the current point using the specified control and end coordinates. + @@ -878,13 +899,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 along the x and y axes. + The rotation of the ellipse's x-axis in degrees. + One of the enumeration values that specifies whether to use the large or small arc. + One of the enumeration values that specifies the direction of the arc. + The offset from the current point to the end point. + Adds an elliptical arc using radii, rotation, arc size, and direction, with end point relative to the current position. + @@ -909,15 +930,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 that specifies whether to use the large or small arc. + One of the enumeration values that specifies the direction of the arc. + The horizontal offset from the current point to the end point. + The vertical offset from the current point to the end point. + Adds an elliptical arc using relative coordinates for the end point. + @@ -938,11 +959,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point offset. + The end point offset. + The weight of the conic curve. + Adds a conic curve using control and end points relative to the current point. + @@ -965,13 +986,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 for the control point. + The vertical offset for the control point. + The horizontal offset for the end point. + The vertical offset for the end point. + The weight of the conic curve. + Adds a conic curve using relative control and end coordinates. + @@ -992,11 +1013,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point offset. + The second control point offset. + The end point offset. + Adds a cubic Bézier curve using control and end points relative to the current point. + @@ -1020,14 +1041,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 for the first control point. + The vertical offset for the first control point. + The horizontal offset for the second control point. + The vertical offset for the second control point. + The horizontal offset for the end point. + The vertical offset for the end point. + Adds a cubic Bézier curve using relative control and end coordinates. + @@ -1044,8 +1065,8 @@ - To be added. - To be added. + Resets the builder to an empty state, discarding all previously added contours. + @@ -1064,9 +1085,9 @@ - To be added. - To be added. - To be added. + The path to add in reverse. + Appends the specified path to the path being built in reverse order. + @@ -1085,9 +1106,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the end point. + Adds a straight line from the current point to a point offset by the specified amount. + @@ -1107,10 +1128,10 @@ - To be added. - To be added. - To be added. - To be added. + The horizontal offset from the current point. + The vertical offset from the current point. + Adds a straight line from the current point to a point offset by the specified coordinates. + @@ -1129,9 +1150,9 @@ - To be added. - To be added. - To be added. + The offset from the last point to the new starting point. + Begins a new contour at a point relative to the last point. + @@ -1151,10 +1172,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. + Begins a new contour at coordinates relative to the last point. + @@ -1174,10 +1195,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point offset. + The end point offset. + Adds a quadratic Bézier curve using control and end points relative to the current point. + @@ -1199,12 +1220,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The horizontal offset for the control point. + The vertical offset for the control point. + The horizontal offset for the end point. + The vertical offset for the end point. + Adds a quadratic Bézier curve using relative control and end coordinates. + @@ -1221,9 +1242,9 @@ - To be added. - To be added. - To be added. + Returns a snapshot of the currently constructed path without resetting the builder. + A new containing a copy of the path built so far. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..32f8af25 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 starts. + 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 operation; otherwise, . + Extracts a segment of the measured path between two distances into the specified path builder. + + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..a784508e 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 data associated with the stream as an object. + An containing the stream's data, or if the stream does not support direct data access. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..f89eb5b2 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 to draw the surface onto. + The point at which to draw the top-left corner of the surface. + The sampling options to use when drawing. + The paint to use when drawing, or to use the default paint. + Draws the 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 to draw the surface onto. + The x-coordinate at which to draw the top-left corner of the surface. + The y-coordinate at which to draw the top-left corner of the surface. + The sampling options to use when drawing. + The paint to use when drawing, or to use the default paint. + Draws the 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..4242c832 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml @@ -118,10 +118,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The font arguments specifying the variation design position, collection index, palette index, and palette overrides. + Creates a new typeface with the variation, palette, and collection settings specified by the given font arguments. + A new with the specified settings, or if the clone could not be created. + @@ -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 use. + Creates a new typeface using the specified palette index. + A new with the specified palette, or if the clone could not be created. + @@ -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 axis-value coordinate pairs that define the variation design position. + Creates a new typeface with the specified variation design position. + A new at the given design position, or if the clone could not be created. + @@ -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 an empty typeface with no glyphs. + An empty instance. + @@ -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. + Fills the specified span with the variation axis parameters for this typeface. + The number of variation axes written to the span. + @@ -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 axis-value coordinate pairs. + Fills the specified span with the current variation design position for this typeface. + The number of coordinates written to the span. + @@ -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 typeface has no glyphs; 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 design parameters. + @@ -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 parameters for this typeface. + An array of describing each variation axis. + @@ -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 design position of this typeface. + An array of representing the current position on 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 axes at which this typeface is currently positioned. + The number of variation design position coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..bc8efda8 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,25 @@ - To be added. - To be added. + Provides methods for encoding images into WebP format, including animated WebP sequences. + + + @@ -42,11 +59,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The source pixmap to encode. + The WebP encoder options. + Encodes the specified pixmap into WebP format and returns the result as . + A new containing the encoded WebP data, or if encoding failed. + @@ -72,12 +89,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the encoded WebP data to. + The source pixmap to encode. + The WebP encoder options. + Encodes the specified pixmap into WebP format and writes the result to the given stream. + + if encoding succeeded; otherwise, . + @@ -103,12 +121,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The .NET stream to write the encoded WebP data to. + The source pixmap to encode. + The WebP encoder options. + Encodes the specified pixmap into WebP format and writes the result to the given .NET stream. + + if encoding succeeded; otherwise, . + @@ -133,11 +152,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The frames to encode, each containing a pixmap and duration. + The WebP encoder options. + Encodes the specified frames into an animated WebP and returns the result as . + A new containing the encoded animated WebP data, or if encoding failed. + @@ -164,12 +183,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write the encoded animated WebP data to. + The frames to encode. + The WebP encoder options. + Encodes the specified frames into an animated WebP and writes the result to the given stream. + + if encoding succeeded; otherwise, . + @@ -196,12 +216,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The .NET stream to write the encoded animated WebP data to. + The frames to encode. + The WebP encoder options. + Encodes the specified frames into an animated WebP and writes the result to the given .NET stream. + + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..1bc9eb5e 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,24 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence. + + . + +## Examples + +```csharp +var frames = new SKWebpEncoderFrame[] +{ + new SKWebpEncoderFrame(bitmap1.PeekPixels(), TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(bitmap2.PeekPixels(), TimeSpan.FromMilliseconds(100)) +}; +``` +]]> + @@ -29,10 +45,10 @@ - To be added. - To be added. - To be added. - To be added. + The bitmap providing the pixel data for this frame. + The display duration of this frame. + Initializes a new instance of the struct from a bitmap and duration. + @@ -49,10 +65,10 @@ - To be added. - To be added. - To be added. - To be added. + The image providing the pixel data for this frame. + The display duration of this frame. + Initializes a new instance of the struct from an image and duration. + @@ -69,10 +85,10 @@ - To be added. - To be added. - To be added. - To be added. + The pixmap providing the pixel data for this frame. + The display duration of this frame. + Initializes a new instance of the struct from a pixmap and duration. + @@ -93,9 +109,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the display duration of this frame. + The duration for which this frame is displayed. + @@ -116,9 +132,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixmap containing the pixel data for this frame. + The pixel data for this frame. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..19afde3e 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 to convert. + Converts an 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 to convert. + Converts an to a . + A with equivalent color values. + @@ -3168,13 +3168,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with equivalent color values. + @@ -3190,13 +3190,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an 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 to convert. + Converts an 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 to convert. + Converts an 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 to convert. + Converts an 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 to convert. + Converts a to an . + An with equivalent color values. + @@ -3500,13 +3500,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with equivalent color values. + @@ -3568,13 +3568,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same coordinates. + @@ -3590,13 +3590,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same coordinates. + @@ -3634,13 +3634,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same bounds. + @@ -3678,13 +3678,13 @@ ExtensionMethod - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + 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.