diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..be12b64c 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-space coordinates for the specified named font instance. + An array of design-space coordinates for the specified 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. + A span to receive the design-space coordinate values. Only the first elements are written. + Gets the design-space coordinates for the specified named font instance into a caller-supplied buffer. + The number of coordinates written into . + @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Gets the number of design-space coordinates for the specified named font instance. + The total number of design-space coordinates for the specified 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 OpenType name ID of the PostScript name for the specified named font instance. + The OpenType name ID of the PostScript name for the specified 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 OpenType name ID of the subfamily name for the specified named font instance. + The OpenType name ID of the subfamily name for the specified named instance. + @@ -279,10 +279,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color entry. + Gets the OpenType name ID for the specified color entry in the font's CPAL color table. + The OpenType name ID associated with the specified palette color entry. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets all color entries in the specified font palette. + An array of packed color values in hb_color_t (BGRA, blue in the high byte, alpha in the low byte) format for all entries in the specified palette. + @@ -324,11 +324,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + A span to receive the packed color values in hb_color_t (BGRA) format. + Gets color entries in the specified font palette into a caller-supplied buffer. + The number of color entries written into . + @@ -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 font palette. + A bitwise combination of values describing the intended use of the palette. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the OpenType name ID for the specified font palette. + The OpenType name ID for the specified palette. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + A span to receive the variation axis information. Only the first elements are written. + Gets information about the variation axes of a variable font into a caller-supplied buffer. + The number of axis info entries written into . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains COLR color layers. + if the font contains COLR color layers; otherwise, . + @@ -446,9 +446,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains color glyphs encoded as PNG images. + if the font contains PNG color glyphs; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains color glyphs encoded as SVG images. + if the font contains SVG color glyphs; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains a CPAL color palette table. + if the font has color palettes; otherwise, . + @@ -500,9 +500,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains OpenType variable font data. + if the font has variation axis data; otherwise, . + @@ -573,9 +573,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of named instances defined in the font's variation data. + The number of named instances, or 0 if the font is not a variable font. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes in the font's CPAL table. + The total number of palettes, or 0 if the font has no CPAL table. + @@ -653,11 +653,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte OpenType tag identifying the variation axis (for example, wght for weight). + When this method returns, contains the axis information if the axis was found. This parameter is treated as uninitialized. + Attempts to find information about the variation axis identified by the specified tag. + if a variation axis matching was found; otherwise, . + @@ -691,9 +691,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes defined in the font. + The total number of variation axes, or 0 if the font is not a variable font. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets information about all variation axes defined in the font. + An array of values, one per axis. Returns an empty array if the font has no variation data. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..4ca3c3fb 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. + A span to receive the normalized variation coordinate values. Each value is a 2.14 fixed-point integer in the range [-16384, 16384], one per axis. + Gets the current normalized variation coordinates of the font into a caller-supplied buffer. + The number of normalized coordinate values written into . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + A read-only span of design-space coordinate values, one per variation axis, in the order returned by the face's variation axis list. + Sets the variation axes of the font using design-space coordinate values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + A read-only span of normalized variation coordinate values. Each value is a 2.14 fixed-point integer in the range [-16384, 16384], one per axis. + Sets the variation axes of the font using normalized coordinate values. + @@ -621,9 +621,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the named instance defined in the face's variation data. + Sets the font's variation to the named instance at the specified index. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + A read-only span of values specifying the axis tag and desired value for each axis to set. + Sets the variation axes of the font using the specified values. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates of the font. + An array of normalized variation coordinate values, one per axis. Each value is a 2.14 fixed-point integer in the range [-16384, 16384]. Returns an empty array if no variation coordinates are set. + 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..f432bd9e 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -70,13 +70,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Gdk.Rectangle. + A Gdk.Rectangle with the same position and dimensions as . + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Gdk.RGBA. + A Gdk.RGBA with the normalized (0–1) red, green, blue, and alpha components of . + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Gdk.RGBA. + A Gdk.RGBA with the floating-point red, green, blue, and alpha components of . + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene.Point. + A Graphene.Point with the same X and Y coordinates as . + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene.Point3D. + A Graphene.Point3D with the same X, Y, and Z coordinates as . + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene.Rect. + A Graphene.Rect with the same origin and dimensions as . + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene.Size. + A Graphene.Size with the same width and height as . + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Gdk.RGBA to convert. + Converts a Gdk.RGBA to an . + An equivalent to . + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Gdk.RGBA to convert. + Converts a Gdk.RGBA to an . + An equivalent to . + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Point to convert. + Converts a Graphene.Point to an . + An with the same X and Y coordinates as . + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Point3D to convert. + Converts a Graphene.Point3D to an . + An with the same X, Y, and Z coordinates as . + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Rect to convert. + Converts a Graphene.Rect to an . + An with the same origin and dimensions as . + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Size to convert. + Converts a Graphene.Size to an . + An with the same width and height as . + 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..057eb06f 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,29 @@ - To be added. - To be added. + Specifies the swizzle component assignments for a Vulkan YCbCr image sampler conversion. + @@ -37,9 +58,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle component assigned to the alpha channel. + A representing a VkComponentSwizzle value for the alpha channel. + @@ -60,9 +81,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle component assigned to the blue channel. + A representing a VkComponentSwizzle value for the blue channel. + @@ -89,10 +110,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if is a with the same component values; otherwise, . + @@ -116,10 +137,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with the same component values; otherwise, . + @@ -140,9 +161,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle component assigned to the green channel. + A representing a VkComponentSwizzle value for the green channel. + @@ -164,9 +185,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -186,11 +207,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and have equal component values; otherwise, . + @@ -210,11 +231,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and differ in at least one component; otherwise, . + @@ -235,9 +256,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle component assigned to the red channel. + A representing a VkComponentSwizzle value for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..d6c3cffb 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 channel swizzle components for the YCbCr sampler conversion. + A describing the component swizzle mapping. + @@ -351,9 +351,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the sampler filter must match the chroma filter for the YCbCr conversion. + if the sampler filter must match the chroma reconstruction filter; otherwise, . + @@ -374,9 +374,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the YCbCr conversion supports linear filtering. + if linear filtering is supported for this conversion; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..0c384812 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 surface. + The paint to apply, or to use the default paint. + Draws the surface at the specified point using the given sampling options and optional paint. + @@ -3059,13 +3059,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The x-coordinate at which to draw the left edge of the surface. + The y-coordinate at which to draw the top edge of the surface. + The sampling options to use when drawing the surface. + The paint to apply, or to use the default paint. + Draws the surface at the specified coordinates using the given sampling options and optional paint. + @@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use - - - + + + Method SkiaSharp - 3.116.0.0 - 3.119.0.0 - 4.147.0.0 + 2.80.0.0 + 2.88.0.0 System.Void - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - + - The matrix to set as the current transformation matrix. + The matrix that will be copied into the current matrix. Replaces the current matrix with a copy of the specified matrix. - - - + + + Method SkiaSharp - 2.80.0.0 - 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 System.Void - + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + - The matrix that will be copied into the current matrix. + The matrix to set as the current transformation matrix. Replaces the current matrix with a copy of the specified matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index 9e7e0d87..2725cb3f 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 ITU-T H.273 CICP color primaries and transfer function codes. + A new matching the given CICP primaries and transfer characteristics, or if the combination is not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..23513651 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + 64-bit extended-range format with four 10-bit channels (B, G, R, A) packed as 10+10+10+10 bits, supporting values outside the [0, 1] range. [Extended Range] @@ -234,7 +234,7 @@ 27 - To be added. + 16-bit single-channel format storing one unsigned normalized value in the red channel. @@ -519,7 +519,7 @@ 26 - To be added. + 64-bit format with three 16-bit half-precision floating-point channels (R, G, B) and one unused padding channel. [Opaque] diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..bb0bff4a 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 ITU-T H.273 CICP (Coding-Independent Code Points) identifiers. + +to create an `SKColorSpace` from a CICP description. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> @@ -28,7 +45,7 @@ 8 - To be added. + Generic film primaries (CICP value 8). @@ -45,7 +62,7 @@ 22 - To be added. + Primaries defined by ITU-T H.273 for value 22, corresponding to EBU Tech 3213-E. @@ -62,7 +79,7 @@ 9 - To be added. + ITU-R BT.2020 / BT.2100 primaries for wide color gamut (CICP value 9). @@ -79,7 +96,7 @@ 5 - To be added. + ITU-R BT.470 System B/G primaries (CICP value 5). @@ -96,7 +113,7 @@ 4 - To be added. + ITU-R BT.470 System M primaries (CICP value 4). @@ -113,7 +130,7 @@ 6 - To be added. + ITU-R BT.601 primaries used for standard-definition video (CICP value 6). @@ -130,7 +147,7 @@ 1 - To be added. + ITU-R BT.709 primaries used for HDTV and sRGB (CICP value 1). @@ -147,7 +164,7 @@ 12 - To be added. + SMPTE EG 432-1 (DCI-P3 D65) primaries (CICP value 12). @@ -164,7 +181,7 @@ 11 - To be added. + SMPTE RP 431-2 (DCI-P3 D60) primaries (CICP value 11). @@ -181,7 +198,7 @@ 7 - To be added. + SMPTE ST 240 primaries for 1035i HDTV (CICP value 7). @@ -198,7 +215,7 @@ 10 - To be added. + SMPTE ST 428-1 (DCDM XYZ) primaries (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..d7bf8dee 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,25 @@ System.Enum - To be added. - To be added. + Specifies the electro-optical transfer function (EOTF/OETF) of a color space using ITU-T H.273 CICP identifiers. + +to create an `SKColorSpace` from a CICP description. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +45,7 @@ 18 - To be added. + Hybrid Log-Gamma (HLG) transfer function defined in ITU-R BT.2100 (CICP value 18). @@ -45,7 +62,7 @@ 13 - To be added. + IEC 61966-2-1 sRGB transfer function (CICP value 13). @@ -62,7 +79,7 @@ 11 - To be added. + IEC 61966-2-4 xvYCC transfer function (CICP value 11). @@ -79,7 +96,7 @@ 8 - To be added. + Linear transfer function with no gamma encoding (CICP value 8). @@ -96,7 +113,7 @@ 16 - To be added. + SMPTE ST 2084 Perceptual Quantizer (PQ) transfer function defined in ITU-R BT.2100 (CICP value 16). @@ -113,7 +130,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer function (CICP value 14). @@ -130,7 +147,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer function (CICP value 15). @@ -147,7 +164,7 @@ 5 - To be added. + ITU-R BT.470 System B/G assumed gamma 2.2 transfer function (CICP value 5). @@ -164,7 +181,7 @@ 4 - To be added. + ITU-R BT.470 System M assumed gamma 2.2 transfer function (CICP value 4). @@ -181,7 +198,7 @@ 6 - To be added. + ITU-R BT.601 transfer function for standard-definition video (CICP value 6). @@ -198,7 +215,7 @@ 1 - To be added. + ITU-R BT.709 transfer function for HDTV (CICP value 1). @@ -215,7 +232,7 @@ 7 - To be added. + SMPTE ST 240 transfer function for 1035i HDTV (CICP value 7). @@ -232,7 +249,7 @@ 17 - To be added. + SMPTE ST 428-1 (DCDM) transfer function (CICP value 17). @@ -249,7 +266,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..17cad2fa 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,27 @@ - To be added. - To be added. + Specifies rendering options for XPS document output. + . It exposes the DPI resolution and +optional settings such as whether PNG images may be omitted. + +This is a value type and does not require disposal. + +## Examples + +```csharp +var options = new SKDocumentXpsOptions +{ + Dpi = 300, + AllowNoPngs = false, +}; +using var doc = SKDocument.CreateXps(stream, options); +``` +]]> @@ -37,9 +56,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the document may omit PNG images when an alternative representation is available. + if the encoder is allowed to skip PNG images; otherwise, . + @@ -60,9 +79,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the output resolution of the XPS document in dots per inch. + The resolution in DPI. + @@ -89,10 +108,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if is equal to the current instance; otherwise, . + @@ -116,10 +135,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a equal to the current instance; otherwise, . + @@ -141,9 +160,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -163,11 +182,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and are equal; otherwise, . + @@ -187,11 +206,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 57ae755b..40fad141 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,32 @@ - To be added. - To be added. + Specifies arguments for requesting a customized version of a typeface. + to produce a derived typeface with specific +variable font axes, a palette index, and optional per-color palette overrides. + +Because `SKFontArguments` is a `ref struct`, it must be used on the stack and +cannot be stored in fields, arrays, or boxed. + +## Examples + +```csharp +ReadOnlySpan coords = stackalloc[] +{ + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, +}; +var args = new SKFontArguments +{ + VariationDesignPosition = coords, + PaletteIndex = 0, +}; +using var bold = typeface.Clone(args); +``` +]]> @@ -41,9 +65,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the face within a font collection. + The collection index. The default value is 0. + @@ -64,9 +88,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 from the font's CPAL table. + The palette index. The default value is 0. + @@ -87,9 +111,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-color overrides applied on top of the selected palette. + A read-only span of values, each specifying a color index and its replacement color. + @@ -110,9 +134,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variable font axis positions to use. + A read-only span of values, each specifying an axis tag and its desired value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..34401a9e 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,34 @@ - To be added. - To be added. + Represents an override for a single color entry in a font's CPAL color palette. + +to selectively replace individual palette entries when cloning a typeface. + +The `Color` field stores an `sk_color_t` value, which is in ARGB format (`0xAARRGGBB`), +the same format as . + +This is a value type and does not require disposal. + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red }, +}; +var args = new SKFontArguments +{ + PaletteIndex = 0, + PaletteOverrides = overrides, +}; +using var typeface = original.Clone(args); +``` +]]> @@ -37,9 +63,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color for the palette entry. + A packed ARGB color value (0xAARRGGBB), equivalent to an cast to . + @@ -66,10 +92,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if is equal to the current instance; otherwise, . + @@ -93,10 +119,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a equal to the current instance; otherwise, . + @@ -118,9 +144,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +167,9 @@ System.UInt16 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the palette color entry to override. + The palette color index. + @@ -163,11 +189,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and are equal; otherwise, . + @@ -187,11 +213,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 8696fae6..22f2626b 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 defined in a variable font. + or + +to retrieve the axes available on a variable typeface. + +This is a value type and does not require disposal. + +## Examples + +```csharp +foreach (var axis in typeface.VariationDesignParameters) +{ + Console.WriteLine( + $"Axis: {axis.Tag}, Min: {axis.Min}, Default: {axis.Default}, Max: {axis.Max}"); +} +``` +]]> @@ -37,9 +59,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default value for this variation axis. + The default axis value, within the range [, ]. + @@ -66,10 +88,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if is equal to the current instance; otherwise, . + @@ -93,10 +115,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a equal to the current instance; otherwise, . + @@ -118,9 +140,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +163,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this axis should be hidden from end-user interfaces. + if the axis is designated hidden by the font; otherwise, . + @@ -164,9 +186,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum allowable value for this variation axis. + The maximum axis value. + @@ -187,9 +209,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum allowable value for this variation axis. + The minimum axis value. + @@ -209,11 +231,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and are equal; otherwise, . + @@ -233,11 +255,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and are not equal; otherwise, . + @@ -258,9 +280,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte OpenType tag that identifies this variation axis. + An such as wght for weight or wdth for width. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..c31e8cd5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,32 @@ - To be added. - To be added. + Represents a design-space position for a single variation axis. + or pass them directly to + +to create a typeface instance at a specific point in the variation design space. + +This is a value type and does not require disposal. + +## Examples + +```csharp +ReadOnlySpan coords = stackalloc[] +{ + new SKFontVariationPositionCoordinate + { + Axis = SKFourByteTag.Parse("wght"), + Value = 700, + }, +}; +using var boldTypeface = typeface.Clone(coords); +``` +]]> @@ -37,9 +61,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte OpenType tag identifying the variation axis. + An such as wght for weight or wdth for width. + @@ -66,10 +90,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if is equal to the current instance; otherwise, . + @@ -93,10 +117,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a equal to the current instance; otherwise, . + @@ -118,9 +142,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -140,11 +164,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and are equal; otherwise, . + @@ -164,11 +188,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and are not equal; otherwise, . + @@ -189,9 +213,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the variation axis. + The axis value in design space. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..ea637cfd 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,36 @@ - To be added. - To be added. + Represents a four-byte OpenType or FreeType tag packed into a single unsigned integer. + . +Strings shorter than four characters are right-padded with spaces; strings longer +than four characters are truncated. + +This is a value type and does not require disposal. It supports implicit +conversion to and from . + +## Examples + +```csharp +// Construct from characters +var wght = new SKFourByteTag('w', 'g', 'h', 't'); // characters for "wght" +var wght2 = SKFourByteTag.Parse("wght"); + +// Round-trip through uint +uint raw = wght2; +SKFourByteTag restored = raw; + +Console.WriteLine(wght2.ToString()); // prints "wght" +``` +]]> @@ -37,9 +65,9 @@ - To be added. - To be added. - To be added. + The packed four-byte tag as an unsigned integer, with the first character in the most significant byte. + Initializes a new instance of the struct from a packed integer value. + @@ -58,12 +86,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The first (most significant) character of the tag. + The second character of the tag. + The third character of the tag. + The fourth (least significant) character of the tag. + Initializes a new instance of the struct from four characters. + @@ -85,10 +113,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if represents the same tag value; otherwise, . + @@ -112,10 +140,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with the same value; otherwise, . + @@ -132,9 +160,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -154,11 +182,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are equal. + if and represent the same tag; otherwise, . + @@ -177,10 +205,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Converts a to its packed representation. + The packed integer value of the tag. + @@ -199,10 +227,10 @@ - To be added. - To be added. - To be added. - To be added. + The packed integer to convert. + Converts a packed value to a . + A wrapping the specified packed integer value. + @@ -222,11 +250,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances are not equal. + if and represent different tags; 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 right-padded with spaces. or empty returns a zero tag. + Parses a string into an . + An parsed from the string, right-padded with spaces if the string is shorter than four characters. + @@ -275,9 +303,9 @@ - To be added. - To be added. - To be added. + Returns a string representation of the four-byte tag. + A four-character string representing the tag, with each byte decoded as an ASCII character. + diff --git a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml index 7c0d12f2..c24b20c9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml +++ b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml @@ -1571,9 +1571,9 @@ - - - + + + Method SkiaSharp @@ -1593,7 +1593,7 @@ - + The target matrix. @@ -1603,9 +1603,9 @@ - - - + + + Method SkiaSharp @@ -1625,7 +1625,7 @@ - + The target matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 9ed1121c..b718c4c4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml @@ -1446,11 +1446,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + Computes the filled path of the source path using the current paint settings and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + @@ -1633,12 +1633,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + The transform matrix to apply during path computation. + Computes the filled path of the source path using the current paint settings scaled by a resolution factor and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + @@ -1659,12 +1659,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + The bounding rectangle used to cull path segments outside the region of interest. + Computes the filled path of the source path clipped to the specified rectangle and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + @@ -1685,12 +1685,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + The resolution scale factor. Larger values produce more accurate curves at higher computational cost. + Computes the filled path of the source path scaled by a resolution factor and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + @@ -1844,13 +1844,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + The bounding rectangle used to cull path segments outside the region of interest. + The transform matrix to apply during path computation. + Computes the filled path of the source path, clipped to the specified rectangle and transformed by the given matrix, and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + @@ -1872,13 +1872,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path whose filled shape is to be computed. + The that receives the filled path geometry. + The bounding rectangle used to cull path segments outside the region of interest. + The resolution scale factor. Larger values produce more accurate curves at higher computational cost. + Computes the filled path of the source path, clipped to the specified rectangle and scaled by a resolution factor, and writes the result into the destination builder. + if the fill path was computed successfully; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..80ef0ead 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 how the path is added. + Appends all contours of another path to the current 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. + The transformation matrix to apply to the appended path. + One of the enumeration values that specifies how the path is added. + Appends all contours of another path to the current path, transformed by the specified matrix. @@ -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 to apply to the appended path. + The vertical offset to apply to the appended path. + One of the enumeration values that specifies how the path is added. + Appends all contours of another path to the current path, translated by the specified offset. @@ -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. + Appends all contours of another path to the current 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 native handle for the underlying Skia path object. + The native pointer to the underlying sk_path_t object. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..ce87616b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,31 @@ - To be added. - To be added. + Builds an incrementally by appending contours and path verbs. + objects. Add lines, curves, arcs, and closed +contours via the individual verb methods, then call +to produce a read-only `SKPath` (without resetting the builder) or + to transfer ownership and reset the builder. + +This type wraps a native Skia resource and implements `IDisposable`. Always +dispose of it when done. + +## 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.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +49,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + @@ -43,9 +66,9 @@ - To be added. - To be added. - To be added. + The whose geometry and fill type are copied into the builder. + Initializes a new instance of the class pre-populated with the contents of the specified path. + @@ -66,11 +89,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The oval that defines the arc's shape. + The starting angle of the arc in degrees, measured clockwise from the positive x-axis. + The sweep of the arc in degrees. Positive values sweep clockwise. + Appends an arc of the specified oval to the current contour. + @@ -92,12 +115,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the circle's center. + The y-coordinate of the circle's center. + The radius of the circle. + One of the enumeration values that specifies the winding direction of the contour. + Adds a closed circle contour to the path. + @@ -117,10 +140,10 @@ - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + One of the enumeration values that specifies the winding direction of the contour. + Adds a closed oval contour to the path. + @@ -140,10 +163,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose geometry is appended. + One of the enumeration values that specifies how the path is appended. + Appends the geometry of the specified path to this builder. + @@ -170,11 +193,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose geometry is appended. + The matrix to apply to the path before appending. + One of the enumeration values that specifies how the path is appended. + Appends the geometry of the specified path, transformed by the given matrix, to this builder. + @@ -196,12 +219,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose geometry is appended. + The offset to apply along the x-axis. + The offset to apply along the y-axis. + One of the enumeration values that specifies how the path is appended. + Appends the geometry of the specified path, offset by the given amounts, to this builder. + @@ -221,10 +244,10 @@ - To be added. - To be added. - To be added. - To be added. + An array of points defining the polygon vertices. + to close the polygon with a line back to the first point; otherwise, . + Adds a closed polygon contour defined by the specified array of points. + @@ -244,10 +267,10 @@ - To be added. - To be added. - To be added. - To be added. + A read-only span of points defining the polygon vertices. + to close the polygon with a line back to the first point; otherwise, . + Adds a closed polygon contour defined by the specified span of points. + @@ -267,10 +290,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + Adds a closed rectangle contour to the path. + @@ -291,11 +314,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + The zero-based index (0–3) of the corner vertex at which the contour begins. + Adds a closed rectangle contour to the path, starting at the specified vertex index. + @@ -315,10 +338,10 @@ - To be added. - To be added. - To be added. - To be added. + The describing the rounded rectangle. + One of the enumeration values that specifies the winding direction of the contour. + Adds a closed rounded rectangle contour to the path. + @@ -339,11 +362,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The describing the rounded rectangle. + One of the enumeration values that specifies the winding direction of the contour. + The zero-based index of the corner vertex at which the contour begins. + Adds a closed rounded rectangle contour to the path, starting at the specified vertex index. + @@ -365,12 +388,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the rounded rectangle. + The x-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 closed rounded rectangle contour to the path with uniform x and y radii. + @@ -391,11 +414,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 current point. + The end point of the second tangent line. + The radius of the arc. + Appends a tangent arc defined by two tangent lines and a radius to the current contour. + @@ -417,12 +440,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The oval that defines the arc's shape. + The starting angle of the arc in degrees, measured clockwise from the positive x-axis. + The sweep angle of the arc in degrees. Positive values sweep clockwise. + to begin a new contour at the arc start; to connect from the current point with a line. + Appends an arc of the specified oval to the current contour. + @@ -445,13 +468,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x and y radii 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 sweep direction. + The end point of the arc. + Appends an SVG-style elliptical arc to the current contour. + @@ -474,13 +497,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the end point of the first tangent line. + The y-coordinate of the end point of the first tangent line. + The x-coordinate of the end point of the second tangent line. + The y-coordinate of the end point of the second tangent line. + The radius of the arc. + Appends a tangent arc defined by two tangent lines and a radius to the current contour. + @@ -505,15 +528,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-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 sweep direction. + The x-coordinate of the end point of the arc. + The y-coordinate of the end point of the arc. + Appends an SVG-style elliptical arc to the current contour. + @@ -530,8 +553,8 @@ - To be added. - To be added. + Closes the current contour by appending a straight line back to the start of the contour. + @@ -552,11 +575,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic. + The end point of the conic. + The weight of the conic. A value of 1 produces a quadratic Bézier; values above 1 pull the curve toward the control point. + Appends a conic (rational quadratic Bézier) curve to the current contour. + @@ -579,13 +602,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + The weight of the conic. + Appends a conic (rational quadratic Bézier) curve to the current contour. + @@ -606,11 +629,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point. + The second control point. + The end point of the curve. + Appends a cubic Bézier curve to the current contour. + @@ -634,14 +657,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first control point. + The y-coordinate of the first control point. + The x-coordinate of the second control point. + The y-coordinate of the second control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a cubic Bézier curve to the current contour. + @@ -658,9 +681,9 @@ - To be added. - To be added. - To be added. + Creates a new from the accumulated geometry and resets the builder. + A new containing the accumulated geometry. The builder is reset after calling this method. + @@ -679,9 +702,9 @@ - To be added. - To be added. - To be added. + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the resources used by the current instance of the class. + @@ -698,8 +721,8 @@ - To be added. - To be added. + Releases the native resources held by this instance. + @@ -715,9 +738,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill rule used to determine the interior of the path. + One of the enumeration values. + @@ -736,9 +759,9 @@ - To be added. - To be added. - To be added. + The end point of the line segment. + Appends a straight line from the current point to the specified point. + @@ -758,10 +781,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a straight line from the current point to the specified coordinates. + @@ -780,9 +803,9 @@ - To be added. - To be added. - To be added. + The starting point of the new contour. + Begins a new contour at the specified point. + @@ -802,10 +825,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the starting point. + The y-coordinate of the starting point. + Begins a new contour at the specified coordinates. + @@ -825,10 +848,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point of the curve. + The end point of the curve. + Appends a quadratic Bézier curve to the current contour. + @@ -850,12 +873,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a quadratic Bézier curve to the current contour. + @@ -878,13 +901,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x and y radii 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 sweep direction. + The end point of the arc, relative to the current point. + Appends an SVG-style elliptical arc relative to the current point. + @@ -909,15 +932,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-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 sweep direction. + The x offset to the end point, relative to the current point. + The y offset to the end point, relative to the current point. + Appends an SVG-style elliptical arc relative to the current point. + @@ -938,11 +961,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point offset, relative to the current point. + The end point offset, relative to the current point. + The weight of the conic. + Appends a conic (rational quadratic Bézier) curve relative to the current point. + @@ -965,13 +988,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the control point. + The y offset to the control point. + The x offset to the end point. + The y offset to the end point. + The weight of the conic. + Appends a conic (rational quadratic Bézier) curve relative to the current point. + @@ -992,11 +1015,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point offset, relative to the current point. + The second control point offset, relative to the current point. + The end point offset, relative to the current point. + Appends a cubic Bézier curve relative to the current point. + @@ -1020,14 +1043,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the first control point. + The y offset to the first control point. + The x offset to the second control point. + The y offset to the second control point. + The x offset to the end point. + The y offset to the end point. + Appends a cubic Bézier curve relative to the current point. + @@ -1044,8 +1067,8 @@ - To be added. - To be added. + Clears all accumulated geometry from the builder, resetting it to an empty state. + @@ -1064,9 +1087,9 @@ - To be added. - To be added. - To be added. + The path whose geometry is appended in reverse. + Appends the geometry of the specified path in reverse order to the current contour. + @@ -1085,9 +1108,9 @@ - To be added. - To be added. - To be added. + The offset to the end point, relative to the current point. + Appends a line segment relative to the current point. + @@ -1107,10 +1130,10 @@ - To be added. - To be added. - To be added. - To be added. + The x offset to the end point. + The y offset to the end point. + Appends a line segment relative to the current point. + @@ -1129,9 +1152,9 @@ - To be added. - To be added. - To be added. + The offset to the starting point, relative to the current point. + Begins a new contour at a point offset from the current point. + @@ -1151,10 +1174,10 @@ - To be added. - To be added. - To be added. - To be added. + The x offset from the current point. + The y offset from the current point. + Begins a new contour at a point offset from the current point. + @@ -1174,10 +1197,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point offset, relative to the current point. + The end point offset, relative to the current point. + Appends a quadratic Bézier curve relative to the current point. + @@ -1199,12 +1222,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the control point. + The y offset to the control point. + The x offset to the end point. + The y offset to the end point. + Appends a quadratic Bézier curve relative to the current point. + @@ -1221,9 +1244,9 @@ - To be added. - To be added. - To be added. + Creates a snapshot of the accumulated path geometry without resetting the builder. + A new representing the current state of the builder. The builder retains all accumulated geometry. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..423f8e64 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -345,13 +345,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The distance along the path at which the segment begins. + The distance along the path at which the segment ends. + The that receives the extracted path segment. + to begin the segment with a move-to command; otherwise, . + Extracts the path segment between the specified distances and appends it to the destination builder. + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..1eba1c24 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 without copying, if supported by the stream implementation. + An instance containing the stream's contents, or if the stream does not support this operation. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..00797316 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -2826,12 +2826,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas on which to draw the surface. + The point at which to place the top-left corner of the surface. + The sampling options to use when drawing the surface. + The paint to apply, or to use the default paint. + Draws the surface onto the specified canvas at the given point using the specified sampling options and optional paint. + @@ -2885,13 +2885,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas on which to draw the surface. + The x-coordinate at which to draw the left edge of the surface. + The y-coordinate at which to draw the top edge of the surface. + The sampling options to use when drawing the surface. + The paint to apply, or to use the default paint. + Draws the surface onto the specified canvas at the given coordinates using the specified sampling options and optional paint. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index b0f4c2f3..918fc81d 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 describing the desired variation design position, palette index, and palette overrides. + Creates a new typeface derived from the current one using the specified font arguments. + A new instance customized according to , or if the typeface does not support the requested configuration. + @@ -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 from the font's CPAL table. + Creates a new typeface derived from the current one with the specified color palette index. + A new instance using the specified palette, or if the palette index is not valid. + @@ -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 read-only span of values specifying the desired axis values. + Creates a new typeface derived from the current one with the specified variation design-space position. + A new instance at the specified variation design position, or if the variation data is not supported. + @@ -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 that contains no glyphs. + A singleton empty instance. + @@ -1745,10 +1745,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span to receive the values. Only the first elements are written. + Gets the variation axis descriptions for this typeface into a caller-supplied buffer. + The number of axis descriptions written into . + @@ -1767,10 +1767,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span to receive the values. Only the first elements are written. + Gets the current variation design-space position of this typeface into a caller-supplied buffer. + The number of coordinate values written into . + @@ -1859,9 +1859,9 @@ A typeface is understood to be bold when the weight is greater than or equal to System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this typeface contains no glyphs. + if the typeface has a glyph count of zero; otherwise, . + @@ -2219,9 +2219,9 @@ A typeface is understood to be italic when it has a slant of either System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes available in this typeface. + The total number of variation axes, or 0 if the typeface is not a variable font. + @@ -2237,9 +2237,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationAxis[] - To be added. - To be added. - To be added. + Gets the variation axis descriptions for all axes in this typeface. + An array of values describing each variation axis. Returns an empty array if the typeface has no variation data. + @@ -2255,9 +2255,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationPositionCoordinate[] - To be added. - To be added. - To be added. + Gets the current variation design-space position of this typeface. + An array of values, one per axis, representing the current axis values. Returns an empty array if no variation position is set. + @@ -2273,9 +2273,9 @@ A typeface is understood to be italic when it has a slant of either System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes for which this typeface has a current design position. + The number of coordinates in the variation design position, or 0 if no position is set. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..cfad54a3 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,31 @@ - To be added. - To be added. + Provides methods for encoding images and animated sequences in the WebP format. + into WebP +format, or assembles multiple frames into an animated WebP. Encoding options such as quality +and compression type are supplied through an struct. + +Output can be written to an , a , or captured +into an buffer. + +## Examples + +```csharp +using var bitmap = new SKBitmap(200, 200); +using var canvas = new SKCanvas(bitmap); +canvas.Clear(SKColors.CornflowerBlue); + +using var pixmap = bitmap.PeekPixels(); +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90); +using var data = SKWebpEncoder.Encode(pixmap, options); +if (data is not null) + File.WriteAllBytes("output.webp", data.ToArray()); +``` +]]> @@ -42,11 +65,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The pixmap containing the source image pixels. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and returns the result as an buffer. + An containing the encoded WebP image, or if encoding failed. + @@ -72,12 +95,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to receive the encoded WebP data. + The pixmap containing the source image pixels. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and writes the result to the destination stream. + if encoding succeeded; otherwise, . + @@ -103,12 +126,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to receive the encoded WebP data. + The pixmap containing the source image pixels. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and writes the result to the destination stream. + if encoding succeeded; otherwise, . + @@ -133,11 +156,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of values describing the pixel data and display duration of each frame. + The encoding options applied to each frame. + Encodes the specified frames into an animated WebP and returns the result as an buffer. + An containing the encoded animated WebP, or if encoding failed. + @@ -164,12 +187,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to receive the encoded animated WebP data. + A read-only span of values describing the pixel data and display duration of each frame. + The encoding options applied to each frame. + Encodes the specified frames into an animated WebP and writes the result to the destination stream. + if encoding succeeded; otherwise, . + @@ -196,12 +219,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to receive the encoded animated WebP data. + A read-only span of values describing the pixel data and display duration of each frame. + The encoding options applied to each frame. + Encodes the specified frames into an animated WebP and writes the result to the destination stream. + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..b3ed51b5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,30 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence. + . Construct a frame from an +, , or ; +the constructors that accept a bitmap or image convert the source to an internal +`SKPixmap` automatically. + +This is a value type and does not require disposal. + +## Examples + +```csharp +var frames = new SKWebpEncoderFrame[] +{ + new SKWebpEncoderFrame(frame1Bitmap, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(frame2Bitmap, TimeSpan.FromMilliseconds(100)), +}; +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80); +using var data = SKWebpEncoder.EncodeAnimated(frames, options); +``` +]]> @@ -29,10 +51,10 @@ - To be added. - To be added. - To be added. - To be added. + The source bitmap whose pixels will be used for this frame. + The length of time this frame is displayed during animation playback. + Initializes a new instance of the struct from a bitmap. + @@ -49,10 +71,10 @@ - To be added. - To be added. - To be added. - To be added. + The source image whose pixels will be used for this frame. + The length of time this frame is displayed during animation playback. + Initializes a new instance of the struct from an image. + @@ -69,10 +91,10 @@ - To be added. - To be added. - To be added. - To be added. + The source pixmap providing direct access to the frame's pixels. + The length of time this frame is displayed during animation playback. + Initializes a new instance of the struct from a pixmap. + @@ -93,9 +115,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the length of time this frame is displayed during animation playback. + A representing the frame display duration. + @@ -116,9 +138,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixmap providing access to this frame's pixel data. + The for this frame's pixels. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..6fcc1ca5 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -750,12 +750,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -812,13 +812,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -846,13 +846,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -912,14 +912,14 @@ System.Void - - - - - - - - + + + + + + + + The canvas to draw on. @@ -948,11 +948,11 @@ System.Void - - - - - + + + + + The canvas to draw on. @@ -1006,12 +1006,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1038,12 +1038,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1100,13 +1100,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -1204,7 +1204,7 @@ System.Int32 - + The color type to query. @@ -1556,7 +1556,7 @@ SkiaSharp.SKSamplingOptions - + The filter quality to convert. @@ -3124,7 +3124,7 @@ ExtensionMethod - + To be added. @@ -3146,7 +3146,7 @@ ExtensionMethod - + To be added. @@ -3168,7 +3168,7 @@ ExtensionMethod - + To be added. @@ -3190,7 +3190,7 @@ ExtensionMethod - + To be added. @@ -3212,7 +3212,7 @@ ExtensionMethod - + To be added. @@ -3234,7 +3234,7 @@ ExtensionMethod - + To be added. @@ -3256,7 +3256,7 @@ ExtensionMethod - + To be added. @@ -3478,7 +3478,7 @@ ExtensionMethod - + To be added. @@ -3500,7 +3500,7 @@ ExtensionMethod - + To be added. @@ -3568,7 +3568,7 @@ ExtensionMethod - + To be added. @@ -3590,7 +3590,7 @@ ExtensionMethod - + To be added. @@ -3634,7 +3634,7 @@ ExtensionMethod - + To be added. @@ -3678,7 +3678,7 @@ ExtensionMethod - + To be added. @@ -4860,9 +4860,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -4960,10 +4960,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -5036,9 +5036,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap. @@ -6276,12 +6276,12 @@ - - - + + + ExtensionMethod - Microsoft.Maui.Hosting.MauiAppBuilder + Microsoft.Maui.Hosting.MauiAppBuilder @@ -6992,7 +6992,7 @@ SkiaSharp.SKColorF - + The Tizen NUI color. @@ -7036,7 +7036,7 @@ SkiaSharp.SKPoint - + The Tizen NUI position. @@ -7080,7 +7080,7 @@ SkiaSharp.SKPointI - + The Tizen NUI 2D position. @@ -7124,7 +7124,7 @@ SkiaSharp.SKRect - + The Tizen NUI rectangle. @@ -7168,7 +7168,7 @@ SkiaSharp.SKRectI - + The Tizen NUI rectangle. @@ -7212,7 +7212,7 @@ SkiaSharp.SKSize - + The Tizen NUI size. @@ -7256,7 +7256,7 @@ SkiaSharp.SKSizeI - + The Tizen NUI 2D size. @@ -8414,9 +8414,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -8514,10 +8514,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -8590,9 +8590,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap.