diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..1fd62f88 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 coordinates for the named instance. + @@ -190,11 +190,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + The span to fill with design coordinate values. + Fills the provided span with the design coordinates for the specified named instance. + The number of design 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. + Returns the number of design coordinates for the specified named instance. + The number of design coordinates for the named instance. + @@ -235,10 +235,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name identifier for the PostScript name of the specified named instance. + The of the PostScript name for the named instance. + @@ -257,10 +257,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name identifier for the subfamily name of the specified named instance. + The of the subfamily name for the named instance. + @@ -279,10 +279,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color entry within the font's color palettes. + Returns the OpenType name identifier for the name of the specified palette color entry. + The of the palette color entry's name. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns all color values in the specified color palette. + An array of hb_color_t values (packed as BGRA in a ) for the palette. + @@ -324,11 +324,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + The span to fill with hb_color_t color values. + Fills the provided span with the color values in the specified color palette. + The number of color values written into . + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns the flags describing the usage of the specified color palette. + A value indicating whether the palette is suitable for light or dark backgrounds. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns the OpenType name identifier for the name of the specified color palette. + The of the palette's name. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + The span to fill with variation axis information. + Fills the provided span with information about the font's variation axes. + The number of variation axis entries written into . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this font face contains color layer data (COLR table). + if the font contains a COLR color layers table; otherwise, . + @@ -446,9 +446,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this font face contains embedded PNG color glyphs (sbix table). + if the font contains embedded PNG images; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this font face contains embedded SVG color glyphs (SVG table). + if the font contains embedded SVG images; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this font face contains color palette data (CPAL table). + if the font contains a CPAL color palettes table; otherwise, . + @@ -500,9 +500,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this font face contains OpenType variable font data. + if the font contains variable font axes (fvar table); otherwise, . + @@ -573,9 +573,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of named instances defined in this variable font face. + The total number of named instances in the font's fvar table. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes defined in this font face. + The total number of color palettes in the font's CPAL table. + @@ -653,11 +653,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte tag identifying the variation axis to find. + When this method returns, contains the axis information if found. This parameter is treated as uninitialized. + Attempts to find the variation axis with the specified tag. + if the axis was found; otherwise, . + @@ -691,9 +691,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes defined in this variable font face. + The total number of variation axes in the font's fvar table. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets an array describing all variation axes defined in this variable font face. + An array of structs, one per axis, or an empty array if the font has no variation data. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..e3bdb92d 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 provided span with the current normalized variation coordinates of this font. + The number of coordinates written into . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + The design-space variation coordinate values, one per variation axis in the order defined by the font. + Sets the variation coordinates for this font using design-space values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + The normalized variation coordinate values, one per variation axis. + Sets the variation coordinates for this font using normalized values. + @@ -621,9 +621,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the named instance to apply. + Sets the variation of this font to the specified named instance. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + The variation axis tag-value pairs to apply. + Sets multiple variation axis values on this font using tag/value pairs. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets an array containing the current normalized variation coordinates of this font. + An array of normalized variation coordinate values, one per axis, or 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..e627ab95 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -70,13 +70,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp integer rectangle to convert. + Converts an to a . + A with the same position and size as the source rectangle. + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp color to convert. + Converts an to a . + A with component values normalised to the [0, 1] range. + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp floating-point color to convert. + Converts an to a . + A with the same floating-point component values. + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp 2D point to convert. + Converts an to a . + A with the same X and Y coordinates. + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp 3D point to convert. + Converts an to a . + A with the same X, Y, and Z coordinates. + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp floating-point rectangle to convert. + Converts an to a . + A with the same origin and size. + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The SkiaSharp size to convert. + Converts an to a . + A with the same width and height. + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The GTK RGBA color to convert. + Converts a to an . + An with component values scaled to the [0, 255] range. + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The GTK RGBA color to convert. + Converts a to an . + An with the same floating-point component values. + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene 2D point to convert. + Converts a to an . + An with the same X and Y coordinates. + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene 3D point to convert. + Converts a to an . + An with the same X, Y, and Z coordinates. + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene rectangle to convert. + Converts a to an . + An with the same origin and size. + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The Graphene size to convert. + Converts a to an . + An with the same width and height. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml index e23eec26..71da7d9e 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 . + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml index c216be8c..0eea7917 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,31 @@ - To be added. - To be added. + Describes the per-component swizzle mapping used in a Vulkan YCbCr conversion. + . + +This is a value type and does not require disposal. + +## Examples + +```csharp +// VK_COMPONENT_SWIZZLE_IDENTITY = 0 +var components = new GRVkYcbcrComponents +{ + R = 0, + G = 0, + B = 0, + A = 0, +}; +``` +]]> @@ -37,9 +60,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle applied to the alpha component. + A VkComponentSwizzle value specifying the source for the alpha channel. + @@ -60,9 +83,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle applied to the blue component. + A VkComponentSwizzle value specifying the source for the blue channel. + @@ -89,10 +112,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all component swizzle values are equal; otherwise, . + @@ -116,10 +139,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 equal component values; otherwise, . + @@ -140,9 +163,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle applied to the green component. + A VkComponentSwizzle value specifying the source for the green channel. + @@ -164,9 +187,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code based on all four component swizzle values. + @@ -186,11 +209,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and are equal; otherwise, . + @@ -210,11 +233,11 @@ - 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. + Returns a value indicating whether two instances are not equal. + if and are not equal; otherwise, . + @@ -235,9 +258,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle applied to the red component. + A VkComponentSwizzle value specifying the source for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..442a8838 100644 --- a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml @@ -68,9 +68,9 @@ SkiaSharp.GRVkYcbcrComponents - To be added. - To be added. - To be added. + Gets or sets the component swizzle mapping for the YCbCr conversion. + A describing how the R, G, B, and A channels are remapped during sampling. + @@ -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 mode must match the chroma filter. + if the sampler's min/mag filter must equal the chroma filter; otherwise, . + @@ -374,9 +374,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether linear filtering is supported for this conversion. + if linear chroma filtering is supported; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..4c2a0d65 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml @@ -3000,12 +3000,12 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface whose contents are drawn. + The point at which the top-left corner of the surface is placed. + The sampling options that control how pixels are filtered when drawing. + The paint to apply, or to draw with default settings. + Draws the contents of the specified surface onto this canvas at the given point, using the specified sampling options. + @@ -3059,13 +3059,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface whose contents are drawn. + The x-coordinate at which the top-left corner of the surface is placed. + The y-coordinate at which the top-left corner of the surface is placed. + The sampling options that control how pixels are filtered when drawing. + The paint to apply, or to draw with default settings. + Draws the contents of the specified surface onto this canvas at the given coordinates, using the specified sampling options. + @@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use - - - + + + Method SkiaSharp - 3.116.0.0 - 3.119.0.0 - 4.147.0.0 + 2.80.0.0 + 2.88.0.0 System.Void - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - + - The matrix to set as the current transformation matrix. + The matrix that will be copied into the current matrix. Replaces the current matrix with a copy of the specified matrix. - - - + + + Method SkiaSharp - 2.80.0.0 - 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 System.Void - + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + - The matrix that will be copied into the current matrix. + The matrix to set as the current transformation matrix. Replaces the current matrix with a copy of the specified matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index 9e7e0d87..e3e0730e 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 as defined in ITU-T H.273. + One of the enumeration values that specifies the opto-electronic transfer function as defined in ITU-T H.273. + Creates a color space defined by the specified CICP (Coding-Independent Code Points) color primaries and transfer characteristics. + A new described by the given CICP parameters, or if the combination is not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..6f063c0a 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + An 8-byte pixel format with four 10-bit extended-range (XR) components in BGRA order, supporting values outside the [0, 1] range. @@ -234,7 +234,7 @@ 27 - To be added. + A 2-byte pixel format with a single 16-bit unsigned normalized red channel. @@ -519,7 +519,7 @@ 26 - To be added. + An 8-byte opaque pixel format with three 16-bit float RGB channels and one unused 16-bit padding component. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..2321376d 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,27 @@ System.Enum - To be added. - To be added. + Specifies the color primaries of a color space as defined by the CICP (Coding-Independent Code Points) standard ITU-T H.273. + to + to construct an + from CICP metadata embedded in image files (for +example, AVIF or HEIC). + +## Examples + +```csharp +// Create an sRGB-equivalent color space using CICP codes +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Iec6196621); +``` +]]> @@ -28,7 +47,7 @@ 8 - To be added. + Generic film color primaries (CICP code point 8). @@ -45,7 +64,7 @@ 22 - To be added. + ITU-T H.273 code point 22, used for EBU Tech 3213-E color primaries. @@ -62,7 +81,7 @@ 9 - To be added. + ITU-R BT.2020 / BT.2100 color primaries, used for ultra-high-definition television (CICP code point 9). @@ -79,7 +98,7 @@ 5 - To be added. + ITU-R BT.470 System B/G color primaries, used for PAL and SECAM standard definition television (CICP code point 5). @@ -96,7 +115,7 @@ 4 - To be added. + ITU-R BT.470 System M color primaries, used for NTSC standard definition television (CICP code point 4). @@ -113,7 +132,7 @@ 6 - To be added. + ITU-R BT.601 color primaries, used for standard definition television (CICP code point 6). @@ -130,7 +149,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for high-definition television and sRGB displays (CICP code point 1). @@ -147,7 +166,7 @@ 12 - To be added. + SMPTE EG 432-1 (P3-D65) color primaries, used for digital cinema and Apple Display P3 (CICP code point 12). @@ -164,7 +183,7 @@ 11 - To be added. + SMPTE RP 431-2 (P3-DCI) color primaries, used for digital cinema projection (CICP code point 11). @@ -181,7 +200,7 @@ 7 - To be added. + SMPTE ST 240 color primaries (CICP code point 7). @@ -198,7 +217,7 @@ 10 - To be added. + SMPTE ST 428-1 (XYZ) color primaries, used for digital cinema (CICP code point 10). @@ -215,7 +234,7 @@ 0 - To be added. + Unknown or unspecified color primaries (CICP code point 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index bddb849d..b57d620c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,27 @@ System.Enum - To be added. - To be added. + Specifies the opto-electronic transfer function (OETF) of a color space as defined by the CICP (Coding-Independent Code Points) standard ITU-T H.273. + to + to construct an + from CICP metadata embedded in image files (for +example, AVIF or HEIC). + +## Examples + +```csharp +// Create an HDR PQ color space from CICP metadata +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +47,7 @@ 18 - To be added. + Hybrid Log-Gamma (HLG) transfer function, used for HDR broadcast (CICP code point 18). @@ -45,7 +64,7 @@ 13 - To be added. + IEC 61966-2-1 transfer function, which defines the standard sRGB electro-optical transfer function (CICP code point 13). @@ -62,7 +81,7 @@ 11 - To be added. + IEC 61966-2-4 transfer function (CICP code point 11). @@ -79,7 +98,7 @@ 8 - To be added. + Linear (no gamma) transfer function (CICP code point 8). @@ -96,7 +115,7 @@ 16 - To be added. + Perceptual Quantizer (PQ / SMPTE ST 2084) transfer function, used for HDR displays (CICP code point 16). @@ -113,7 +132,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer function (CICP code point 14). @@ -130,7 +149,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer function (CICP code point 15). @@ -147,7 +166,7 @@ 5 - To be added. + ITU-R BT.470 System B/G transfer function, assumed display gamma (CICP code point 5). @@ -164,7 +183,7 @@ 4 - To be added. + ITU-R BT.470 System M transfer function, assumed display gamma (CICP code point 4). @@ -181,7 +200,7 @@ 6 - To be added. + ITU-R BT.601 transfer function, used for standard definition television (CICP code point 6). @@ -198,7 +217,7 @@ 1 - To be added. + ITU-R BT.709 transfer function, used for high-definition television (CICP code point 1). @@ -215,7 +234,7 @@ 7 - To be added. + SMPTE ST 240 transfer function (CICP code point 7). @@ -232,7 +251,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer function, used for digital cinema (CICP code point 17). @@ -249,7 +268,7 @@ 0 - To be added. + Unknown or unspecified transfer function (CICP code point 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..86e9ff9e 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,33 @@ - To be added. - To be added. + Specifies options for creating an XPS document. + . Set the desired DPI and other +properties before passing the struct to the factory method. + +This is a value type and does not require disposal. + +## Examples + +```csharp +var options = new SKDocumentXpsOptions +{ + DPI = 300, + AllowNoPngs = false, +}; + +using var stream = File.OpenWrite("output.xps"); +using var doc = SKDocument.CreateXps(stream, options); +using var canvas = doc.BeginPage(595, 842); +canvas.DrawColor(SKColors.White); +doc.EndPage(); +``` +]]> @@ -37,9 +62,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether images may be embedded without PNG encoding. + to allow non-PNG image encodings in the document; otherwise, . + @@ -60,9 +85,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the dots per inch (DPI) used when rasterizing content in the XPS document. + The resolution in dots per inch. + @@ -89,10 +114,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all option fields are equal; otherwise, . + @@ -116,10 +141,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 equal field values; otherwise, . + @@ -141,9 +166,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code based on all option fields. + @@ -163,11 +188,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and are equal; otherwise, . + @@ -187,11 +212,11 @@ - 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. + Returns a value indicating 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..c4531dd7 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,35 @@ - To be added. - To be added. + Specifies the arguments used to customize a typeface when cloning it, including variation axis positions, palette selection, and palette color overrides. + . You can +specify variation axis coordinates, a color palette index, and per-color +overrides for the palette. + +This is a ref struct (stack-only) value type and does not require disposal. + +## Examples + +```csharp +SKFontVariationPositionCoordinate[] coords = +[ + new() { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, +]; + +var args = new SKFontArguments +{ + VariationDesignPosition = coords, + PaletteIndex = 0, +}; + +using var boldTypeface = typeface.Clone(args); +``` +]]> @@ -41,9 +68,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 (TTC) file. + The index of the font within the collection. The default value is 0. + @@ -64,9 +91,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 index of the palette to apply. The default value is 0. + @@ -87,9 +114,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-color overrides to apply on top of the selected palette. + A read-only span of values. Each entry replaces a specific color in the active palette. + @@ -110,9 +137,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation axis design-space coordinates to apply to the typeface. + A read-only span of values, one per axis to override. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..495d8588 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,39 @@ - To be added. - To be added. + Specifies a replacement color for a single entry in a font's color palette. + when cloning a typeface to +change specific colors in the active CPAL palette without switching to a +different palette entirely. + +The field stores a packed ARGB +value in the same format as (`0xAARRGGBB`). + +This is a value type and does not require disposal. + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new() { Index = 0, Color = (uint)SKColors.Red }, + new() { Index = 1, Color = (uint)SKColors.Blue }, +}; + +var args = new SKFontArguments +{ + PaletteIndex = 0, + PaletteOverrides = overrides, +}; + +using var customTypeface = typeface.Clone(args); +``` +]]> @@ -37,9 +68,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color as a packed ARGB value. + The ARGB color packed as 0xAARRGGBB, matching the layout. + @@ -66,10 +97,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both the index and color are equal; otherwise, . + @@ -93,10 +124,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 equal field values; otherwise, . + @@ -118,9 +149,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code based on the palette index and color value. + @@ -141,9 +172,9 @@ System.UInt16 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the palette color entry to override. + The zero-based index into the active color palette. + @@ -163,11 +194,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and are equal; otherwise, . + @@ -187,11 +218,11 @@ - 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. + Returns a value indicating 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..7c319de6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,29 @@ - To be added. - To be added. + Describes a single variation axis of an OpenType variable font, including its tag, value range, default value, and visibility. + or + to retrieve the +axes supported by a typeface. + +This is a value type and does not require disposal. + +## Examples + +```csharp +SKFontVariationAxis[] axes = typeface.VariationDesignParameters; +foreach (var axis in axes) +{ + Console.WriteLine( + $"{axis.Tag}: min={axis.Min}, def={axis.Default}, max={axis.Max}"); +} +``` +]]> @@ -37,9 +58,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default design-space value for this variation axis. + The default axis value in design-space units. + @@ -66,10 +87,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all fields are equal; otherwise, . + @@ -93,10 +114,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 an with equal field values; otherwise, . + @@ -118,9 +139,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code based on the tag, min, default, max, and hidden flag. + @@ -141,9 +162,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this axis should be hidden from end-user interfaces. + if the axis is marked hidden in the font; otherwise, . + @@ -164,9 +185,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum allowed design-space value for this variation axis. + The maximum axis value in design-space units. + @@ -187,9 +208,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum allowed design-space value for this variation axis. + The minimum axis value in design-space units. + @@ -209,11 +230,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and are equal; otherwise, . + @@ -233,11 +254,11 @@ - 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. + Returns a value indicating whether two instances are not equal. + if and are not equal; otherwise, . + @@ -258,9 +279,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag identifying this variation axis. + The for this axis, for example wght for weight or wdth for width. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..8f6fdab9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,30 @@ - To be added. - To be added. + Specifies a design-space position for a single variation axis of an OpenType variable font. + or directly to + +to pin specific axes of a variable font to desired values. + +This is a value type and does not require disposal. + +## Examples + +```csharp +var position = new SKFontVariationPositionCoordinate[] +{ + new() { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + new() { Axis = SKFourByteTag.Parse("ital"), Value = 1 }, +}; + +using var styledTypeface = typeface.Clone(position.AsSpan()); +``` +]]> @@ -37,9 +59,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag identifying the variation axis. + The of the axis, for example wght for weight. + @@ -66,10 +88,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both the axis tag and value are equal; otherwise, . + @@ -93,10 +115,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is an with equal field values; 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 based on the axis tag and value. + @@ -140,11 +162,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and are equal; otherwise, . + @@ -164,11 +186,11 @@ - 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. + Returns a value indicating whether two instances are not equal. + if and are not equal; otherwise, . + @@ -189,9 +211,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the variation axis. + The axis value in design-space units, which must be within the range defined by the axis. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..099e17f0 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/TrueType tag packed into a 32-bit unsigned integer. + (c1 << 24) | (c2 << 16) | (c3 << 8) | c4. +This matches the OpenType/TrueType tag convention used for table identifiers, +feature tags, variation axis tags, and similar four-character codes. + +Implicit conversions to and from `uint` are provided, and the struct is +interchangeable with `uint` in most SkiaSharp APIs that accept tags. + +This is a value type and does not require disposal. + +## Examples + +```csharp +// Construct from four characters +var wghtTag = new SKFourByteTag('w', 'g', 'h', 't'); + +// Parse from a string (pads or truncates to 4 characters) +var italTag = SKFourByteTag.Parse("ital"); + +// Round-trip to/from uint +uint raw = wghtTag; +SKFourByteTag back = raw; + +Console.WriteLine(wghtTag.ToString()); // "wght" +``` +]]> @@ -37,9 +65,9 @@ - To be added. - To be added. - To be added. + The packed tag value, where the most-significant byte holds the first character. + Initializes a new instance of the struct from a packed 32-bit 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 ASCII characters. + @@ -85,10 +113,10 @@ - To be added. - To be added. - To be added. - To be added. + The value to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both tags encode the same 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 packed value; otherwise, . + @@ -132,9 +160,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + The packed 32-bit tag value cast to . + @@ -154,11 +182,11 @@ - 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. + Returns a value indicating whether two instances are equal. + if and encode the same value; otherwise, . + @@ -177,10 +205,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Implicitly converts a to its packed representation. + The packed 32-bit value of the tag. + @@ -199,10 +227,10 @@ - To be added. - To be added. - To be added. - To be added. + The packed 32-bit tag value to convert. + Implicitly converts a packed value to an . + An wrapping . + @@ -222,11 +250,11 @@ - 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. + Returns a value indicating whether two instances are not equal. + if and encode different values; otherwise, . + @@ -250,10 +278,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. If or empty, the returned tag encodes zero. + Parses a string into an , padding with spaces or truncating to exactly four characters. + An representing the first four characters of , padded with spaces if shorter. + @@ -275,9 +303,9 @@ - To be added. - To be added. - To be added. + Returns the string representation of this tag as four ASCII characters. + A four-character string decoded from the packed tag value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml index 7c0d12f2..c24b20c9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml +++ b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml @@ -1571,9 +1571,9 @@ - - - + + + Method SkiaSharp @@ -1593,7 +1593,7 @@ - + The target matrix. @@ -1603,9 +1603,9 @@ - - - + + + Method SkiaSharp @@ -1625,7 +1625,7 @@ - + The target matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 9ed1121c..b2b69222 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml @@ -1446,11 +1446,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The path builder that receives the filled geometry. + Computes the filled path that would result from drawing the source path with this paint and writes it 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 to fill. + The path builder that receives the filled geometry. + The transformation matrix applied before filling. + Computes the filled path that would result from drawing the source path with this paint and the specified matrix, and writes it 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 to fill. + The path builder that receives the filled geometry. + The rectangle used to cull away geometry outside the area of interest. + Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle, and writes it 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 to fill. + The path builder that receives the filled geometry. + The resolution scale factor, used to control the precision of curve approximation. + Computes the filled path that would result from drawing the source path with this paint at the specified resolution scale, and writes it 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 to fill. + The path builder that receives the filled geometry. + The rectangle used to cull away geometry outside the area of interest. + The transformation matrix applied before filling. + Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle and transformed by the specified matrix, and writes it 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 to fill. + The path builder that receives the filled geometry. + The rectangle used to cull away geometry outside the area of interest. + The resolution scale factor, used to control the precision of curve approximation. + Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle at the specified resolution scale, and writes it 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..28772dcf 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPath.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml @@ -1582,9 +1582,9 @@ the first point is automatically set to (0, 0). System.IntPtr - To be added. - To be added. - To be added. + Gets or sets the native handle for this path object. + The native handle used internally to communicate with the Skia library. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..7755deea 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,34 @@ - To be added. - To be added. + A mutable builder for constructing objects incrementally. + +to obtain an immutable `SKPath` snapshot, or + to take ownership of the built path and +reset the builder in one step. + +This type wraps a native Skia resource and implements `IDisposable`. Always +dispose of it when done, either with a `using` statement or by calling +`Dispose()` directly. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(10, 10); +builder.LineTo(100, 10); +builder.LineTo(100, 100); +builder.Close(); + +using var path = builder.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +52,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + @@ -43,9 +69,9 @@ - To be added. - To be added. - To be added. + The path whose geometry is copied into this builder. + Initializes a new instance of the class as a copy of the specified path. + @@ -66,11 +92,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; positive sweeps clockwise. + Appends an arc of the specified oval to this path. + @@ -92,12 +118,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. + The direction in which to wind the circle contour. + Appends a circle contour to this path. + @@ -117,10 +143,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. + Appends an oval contour fitting the specified rectangle to this path. + @@ -140,10 +166,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + One of the enumeration values that specifies how the path is appended. + Appends all contours from the specified path to this path using the given add mode. + @@ -170,11 +196,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + The transformation applied to the appended contours. + One of the enumeration values that specifies how the path is appended. + Appends all contours from the specified path, transformed by the given matrix, to this path. + @@ -196,12 +222,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + The horizontal translation applied to the appended contours. + The vertical translation applied to the appended contours. + One of the enumeration values that specifies how the path is appended. + Appends all contours from the specified path, translated by the given offset, to this path. + @@ -221,10 +247,10 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + to automatically close the contour; otherwise, . + Appends a polygon contour from an array of points to this path. + @@ -244,10 +270,10 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + to automatically close the contour; otherwise, . + Appends a polygon contour from a span of points to this path. + @@ -267,10 +293,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + Appends a closed rectangle contour to this path. + @@ -291,11 +317,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + The zero-based index (0–3) of the corner at which to start the contour. + Appends a closed rectangle contour to this path, starting at the specified corner index. + @@ -315,10 +341,10 @@ - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + Appends a closed rounded-rectangle contour to this path. + @@ -339,11 +365,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add. + One of the enumeration values that specifies the winding direction of the contour. + The zero-based starting corner index for the contour. + Appends a closed rounded-rectangle contour to this path, starting at the specified corner index. + @@ -365,12 +391,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the rounded rectangle. + The horizontal radius of the rounded corners. + The vertical radius of the rounded corners. + One of the enumeration values that specifies the winding direction of the contour. + Appends a closed rounded-rectangle contour with the specified corner radii to this path. + @@ -391,11 +417,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point. + The second tangent point. + The radius of the arc. + Appends an arc to this path using two tangent points and a radius. + @@ -417,12 +443,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The angle in degrees at which the arc starts. + The sweep angle in degrees. + to begin a new contour with a move-to; otherwise, to append to the current contour. + Appends an arc of the specified oval to this path. + @@ -445,13 +471,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 as (rx, ry). + The rotation angle of the ellipse x-axis in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the sweep direction. + The endpoint of the arc. + Appends an SVG-style arc to this path using radii, rotation, size, sweep, and endpoint. + @@ -474,13 +500,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first tangent point. + The y-coordinate of the first tangent point. + The x-coordinate of the second tangent point. + The y-coordinate of the second tangent point. + The radius of the arc. + Appends an arc to this path using two tangent points specified as scalar coordinates and a radius. + @@ -505,15 +531,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 angle of the ellipse x-axis in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the sweep direction. + The x-coordinate of the arc endpoint. + The y-coordinate of the arc endpoint. + Appends an SVG-style arc to this path using scalar radii, rotation, size, sweep, and endpoint. + @@ -530,8 +556,8 @@ - To be added. - To be added. + Closes the current contour by appending a line from the current point to the last move-to point. + @@ -552,11 +578,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point. + The endpoint. + The conic weight controlling how closely the curve follows the control point. + Appends a weighted quadratic Bézier (conic) segment to the current contour. + @@ -579,13 +605,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 endpoint. + The y-coordinate of the endpoint. + The conic weight. + Appends a weighted quadratic Bézier (conic) segment to the current contour using scalar coordinates. + @@ -606,11 +632,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 endpoint. + Appends a cubic Bézier segment to the current contour. + @@ -634,14 +660,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 endpoint. + The y-coordinate of the endpoint. + Appends a cubic Bézier segment to the current contour using scalar coordinates. + @@ -658,9 +684,9 @@ - To be added. - To be added. - To be added. + Finalizes the path and transfers ownership to the caller, resetting this builder. + A new containing all contours built so far. + @@ -679,9 +705,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 +724,8 @@ - To be added. - To be added. + Releases the native Skia path builder resources held by this instance. + @@ -715,9 +741,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type that determines how overlapping contours are filled. + One of the values. + @@ -736,9 +762,9 @@ - To be added. - To be added. - To be added. + The endpoint of the line segment. + Appends a straight-line segment from the current point to the specified point. + @@ -758,10 +784,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the endpoint. + The y-coordinate of the endpoint. + Appends a straight-line segment from the current point to the specified coordinates. + @@ -780,9 +806,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 +828,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 +851,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point. + The endpoint. + Appends a quadratic Bézier segment to the current contour. + @@ -850,12 +876,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 endpoint. + The y-coordinate of the endpoint. + Appends a quadratic Bézier segment to the current contour using scalar coordinates. + @@ -878,13 +904,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 as (rx, ry). + The rotation angle of the ellipse x-axis in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the sweep direction. + The relative endpoint offset of the arc. + Appends a relative SVG-style arc to this path using radii, rotation, size, sweep, and endpoint offset. + @@ -909,15 +935,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 angle of the ellipse x-axis in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the sweep direction. + The relative x-offset of the arc endpoint. + The relative y-offset of the arc endpoint. + Appends a relative SVG-style arc to this path using scalar radii, rotation, size, sweep, and endpoint offset. + @@ -938,11 +964,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The relative control point offset from the current point. + The relative endpoint offset from the current point. + The conic weight. + Appends a conic segment to the current contour using relative point offsets. + @@ -965,13 +991,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The relative x-offset of the control point. + The relative y-offset of the control point. + The relative x-offset of the endpoint. + The relative y-offset of the endpoint. + The conic weight. + Appends a conic segment to the current contour using scalar relative offsets. + @@ -992,11 +1018,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The relative first control point offset. + The relative second control point offset. + The relative endpoint offset. + Appends a cubic Bézier segment to the current contour using relative point offsets. + @@ -1020,14 +1046,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 relative x-offset of the first control point. + The relative y-offset of the first control point. + The relative x-offset of the second control point. + The relative y-offset of the second control point. + The relative x-offset of the endpoint. + The relative y-offset of the endpoint. + Appends a cubic Bézier segment to the current contour using scalar relative offsets. + @@ -1044,8 +1070,8 @@ - To be added. - To be added. + Removes all contours and resets this builder to an empty state. + @@ -1064,9 +1090,9 @@ - To be added. - To be added. - To be added. + The path whose contours are appended in reverse. + Appends all contours from the specified path to this path in reverse order. + @@ -1085,9 +1111,9 @@ - To be added. - To be added. - To be added. + The relative offset of the endpoint. + Appends a line segment using a relative endpoint offset from the current point. + @@ -1107,10 +1133,10 @@ - To be added. - To be added. - To be added. - To be added. + The relative x-offset of the endpoint. + The relative y-offset of the endpoint. + Appends a line segment using scalar relative offsets from the current point. + @@ -1129,9 +1155,9 @@ - To be added. - To be added. - To be added. + The relative offset from the current point. + Begins a new contour at a point offset relative to the current point. + @@ -1151,10 +1177,10 @@ - To be added. - To be added. - To be added. - To be added. + The relative x-offset. + The relative y-offset. + Begins a new contour at scalar offsets relative to the current point. + @@ -1174,10 +1200,10 @@ - To be added. - To be added. - To be added. - To be added. + The relative control point offset. + The relative endpoint offset. + Appends a quadratic Bézier segment to the current contour using relative point offsets. + @@ -1199,12 +1225,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The relative x-offset of the control point. + The relative y-offset of the control point. + The relative x-offset of the endpoint. + The relative y-offset of the endpoint. + Appends a quadratic Bézier segment to the current contour using scalar relative offsets. + @@ -1221,9 +1247,9 @@ - To be added. - To be added. - To be added. + Creates an immutable snapshot of the path built so far without resetting this builder. + A new containing all contours built so far. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..e19ffa95 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 path builder that receives the extracted segment. + to prepend a move-to at the start of the segment; otherwise, . + Extracts the segment of the path between the specified start and stop 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..cbc6a3d3 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 this stream as an object. + An containing the stream's data, or if the data could not be retrieved. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..16e50cb4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -2826,12 +2826,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas on which to draw. + The point at which the top-left corner of the surface is placed on the canvas. + The sampling options that control how pixels are filtered when drawing. + The paint to apply, or to draw with default settings. + Draws this surface's contents onto the specified canvas at the given point, using the specified sampling options. + @@ -2885,13 +2885,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas on which to draw. + The x-coordinate at which the top-left corner of the surface is placed on the canvas. + The y-coordinate at which the top-left corner of the surface is placed on the canvas. + The sampling options that control how pixels are filtered when drawing. + The paint to apply, or to draw with default settings. + Draws this surface's contents 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..a856a45f 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 arguments specifying variation axis positions, palette index, and palette color overrides. + Creates a new typeface derived from this one with the specified font arguments applied. + A new with the specified customizations applied. + @@ -140,10 +140,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette from the font's CPAL table. + Creates a new typeface derived from this one using the specified color palette. + A new that uses the specified color palette. + @@ -162,10 +162,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The variation axis design-space coordinates to apply. + Creates a new typeface derived from this one with the specified variation axis coordinates. + A new with the given variation coordinates applied. + @@ -686,9 +686,9 @@ Typeface objects are immutable, and so they can be shared between threads. SkiaSharp.SKTypeface - To be added. - To be added. - To be added. + Gets a shared empty typeface instance that contains no glyphs. + A singleton with no glyph data. + @@ -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 descriptors. + Fills the provided span with information about this typeface's variation axes. + The number of axis entries written into . + @@ -1767,10 +1767,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + The span to fill with axis tag-value pairs. + Fills the provided span with the current variation axis coordinates for this typeface. + The number of coordinates 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 defined for this typeface. + The total number of variation axes available in the font. + @@ -2237,9 +2237,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationAxis[] - To be added. - To be added. - To be added. + Gets an array of descriptors for all variation axes defined for this typeface. + An array of structs, one per axis, or an empty array if the font is not variable. + @@ -2255,9 +2255,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationPositionCoordinate[] - To be added. - To be added. - To be added. + Gets an array of the current variation axis coordinates for this typeface. + An array of values, or an empty array if no variation coordinates are 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 axis coordinates currently set for this typeface. + The count of variation axis coordinates available via . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..ea22392d 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,31 @@ - To be added. - To be added. + Provides static methods for encoding images and animated sequences to the WebP format. + to WebP using an + configuration. Both lossy and lossless +encoding are supported through the options struct. Animated WebP sequences can +be created by passing a span of objects. + +This type has no state and does not require disposal. + +## Examples + +```csharp +using var bitmap = new SKBitmap(200, 200); +using var canvas = new SKCanvas(bitmap); +canvas.Clear(SKColors.CornflowerBlue); + +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80); +using var data = SKWebpEncoder.Encode(bitmap.PeekPixels(), options); +if (data != 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 source pixel data to encode. + The encoding options, including compression type and quality. + Encodes the specified pixmap to WebP and returns the result as an object. + An containing the WebP-encoded 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 destination stream that receives the encoded WebP data. + The source pixel data to encode. + The encoding options, including compression type and quality. + Encodes the specified pixmap to WebP and writes the result to the given write 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 destination managed stream that receives the encoded WebP data. + The source pixel data to encode. + The encoding options, including compression type and quality. + Encodes the specified pixmap to WebP and writes the result to the given managed stream. + if encoding succeeded; otherwise, . + @@ -133,11 +156,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The frames to include in the animated WebP, each with its own duration. + The encoding options applied to all frames. + Encodes the specified frames as an animated WebP and returns the result as an object. + An containing the 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 destination stream that receives the animated WebP data. + The frames to include in the animated WebP, each with its own duration. + The encoding options applied to all frames. + Encodes the specified frames as an animated WebP and writes the result to the given write 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 destination managed stream that receives the animated WebP data. + The frames to include in the animated WebP, each with its own duration. + The encoding options applied to all frames. + Encodes the specified frames as an animated WebP and writes the result to the given managed stream. + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..3d65ef82 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,32 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence, consisting of pixel data and a display duration. + to produce an animated WebP. + +When constructing from an or +, the pixmap is obtained by calling `PeekPixels()` +on the source object. + +## Examples + +```csharp +var frame1Duration = TimeSpan.FromMilliseconds(100); +var frame2Duration = TimeSpan.FromMilliseconds(100); +var frames = new SKWebpEncoderFrame[] +{ + new SKWebpEncoderFrame(frame1Pixmap, frame1Duration), + new SKWebpEncoderFrame(frame2Pixmap, frame2Duration), +}; +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80); +using var data = SKWebpEncoder.EncodeAnimated(frames, options); +``` +]]> @@ -93,9 +117,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the display duration of this frame. + A specifying how long this frame is displayed before advancing to the next frame. + @@ -116,9 +140,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixel data for this frame. + The containing the pixel data for this frame. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..6fcc1ca5 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -750,12 +750,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -812,13 +812,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -846,13 +846,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -912,14 +912,14 @@ System.Void - - - - - - - - + + + + + + + + The canvas to draw on. @@ -948,11 +948,11 @@ System.Void - - - - - + + + + + The canvas to draw on. @@ -1006,12 +1006,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1038,12 +1038,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1100,13 +1100,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -1204,7 +1204,7 @@ System.Int32 - + The color type to query. @@ -1556,7 +1556,7 @@ SkiaSharp.SKSamplingOptions - + The filter quality to convert. @@ -3124,7 +3124,7 @@ ExtensionMethod - + To be added. @@ -3146,7 +3146,7 @@ ExtensionMethod - + To be added. @@ -3168,7 +3168,7 @@ ExtensionMethod - + To be added. @@ -3190,7 +3190,7 @@ ExtensionMethod - + To be added. @@ -3212,7 +3212,7 @@ ExtensionMethod - + To be added. @@ -3234,7 +3234,7 @@ ExtensionMethod - + To be added. @@ -3256,7 +3256,7 @@ ExtensionMethod - + To be added. @@ -3478,7 +3478,7 @@ ExtensionMethod - + To be added. @@ -3500,7 +3500,7 @@ ExtensionMethod - + To be added. @@ -3568,7 +3568,7 @@ ExtensionMethod - + To be added. @@ -3590,7 +3590,7 @@ ExtensionMethod - + To be added. @@ -3634,7 +3634,7 @@ ExtensionMethod - + To be added. @@ -3678,7 +3678,7 @@ ExtensionMethod - + To be added. @@ -4860,9 +4860,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -4960,10 +4960,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -5036,9 +5036,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap. @@ -6276,12 +6276,12 @@ - - - + + + ExtensionMethod - Microsoft.Maui.Hosting.MauiAppBuilder + Microsoft.Maui.Hosting.MauiAppBuilder @@ -6992,7 +6992,7 @@ SkiaSharp.SKColorF - + The Tizen NUI color. @@ -7036,7 +7036,7 @@ SkiaSharp.SKPoint - + The Tizen NUI position. @@ -7080,7 +7080,7 @@ SkiaSharp.SKPointI - + The Tizen NUI 2D position. @@ -7124,7 +7124,7 @@ SkiaSharp.SKRect - + The Tizen NUI rectangle. @@ -7168,7 +7168,7 @@ SkiaSharp.SKRectI - + The Tizen NUI rectangle. @@ -7212,7 +7212,7 @@ SkiaSharp.SKSize - + The Tizen NUI size. @@ -7256,7 +7256,7 @@ SkiaSharp.SKSizeI - + The Tizen NUI 2D size. @@ -8414,9 +8414,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -8514,10 +8514,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -8590,9 +8590,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap. diff --git a/output/docs-work/HarfBuzzSharp__Face.json b/output/docs-work/HarfBuzzSharp__Face.json new file mode 100644 index 00000000..2bf698cb --- /dev/null +++ b/output/docs-work/HarfBuzzSharp__Face.json @@ -0,0 +1,396 @@ +{ + "typeName": "HarfBuzzSharp.Face", + "entries": [ + { + "memberType": "Method", + "memberName": "GetNamedInstanceDesignCoords", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoords(System.Int32)", + "signature": "public float[] GetNamedInstanceDesignCoords (int instanceIndex);", + "fields": { + "summary": "Returns the design coordinates for the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.instanceIndex" + ], + "remarks": "", + "returns": "An array of design coordinates for the named instance." + } + }, + { + "memberType": "Method", + "memberName": "GetNamedInstanceDesignCoords", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoords(System.Int32,System.Span{System.Single})", + "signature": "public int GetNamedInstanceDesignCoords (int instanceIndex, Span coords);", + "fields": { + "summary": "Fills the provided span with the design coordinates for the specified named instance.", + "params": { + "coords": "The span to fill with design coordinate values.", + "instanceIndex": "The zero-based index of the named instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.coords", + "params.instanceIndex" + ], + "remarks": "", + "returns": "The number of design coordinates written into ." + } + }, + { + "memberType": "Method", + "memberName": "GetNamedInstanceDesignCoordsCount", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoordsCount(System.Int32)", + "signature": "public int GetNamedInstanceDesignCoordsCount (int instanceIndex);", + "fields": { + "summary": "Returns the number of design coordinates for the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.instanceIndex" + ], + "remarks": "", + "returns": "The number of design coordinates for the named instance." + } + }, + { + "memberType": "Method", + "memberName": "GetNamedInstancePostScriptNameId", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstancePostScriptNameId(System.Int32)", + "signature": "public HarfBuzzSharp.OpenTypeNameId GetNamedInstancePostScriptNameId (int instanceIndex);", + "fields": { + "summary": "Returns the OpenType name identifier for the PostScript name of the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.instanceIndex" + ], + "remarks": "", + "returns": "The of the PostScript name for the named instance." + } + }, + { + "memberType": "Method", + "memberName": "GetNamedInstanceSubfamilyNameId", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceSubfamilyNameId(System.Int32)", + "signature": "public HarfBuzzSharp.OpenTypeNameId GetNamedInstanceSubfamilyNameId (int instanceIndex);", + "fields": { + "summary": "Returns the OpenType name identifier for the subfamily name of the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.instanceIndex" + ], + "remarks": "", + "returns": "The of the subfamily name for the named instance." + } + }, + { + "memberType": "Method", + "memberName": "GetPaletteColorNameId", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColorNameId(System.Int32)", + "signature": "public HarfBuzzSharp.OpenTypeNameId GetPaletteColorNameId (int colorIndex);", + "fields": { + "summary": "Returns the OpenType name identifier for the name of the specified palette color entry.", + "params": { + "colorIndex": "The zero-based index of the color entry within the font's color palettes." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.colorIndex" + ], + "remarks": "", + "returns": "The of the palette color entry's name." + } + }, + { + "memberType": "Method", + "memberName": "GetPaletteColors", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColors(System.Int32)", + "signature": "public uint[] GetPaletteColors (int paletteIndex);", + "fields": { + "summary": "Returns all color values in the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.paletteIndex" + ], + "remarks": "", + "returns": "An array of hb_color_t values (packed as BGRA in a ) for the palette." + } + }, + { + "memberType": "Method", + "memberName": "GetPaletteColors", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColors(System.Int32,System.Span{System.UInt32})", + "signature": "public int GetPaletteColors (int paletteIndex, Span colors);", + "fields": { + "summary": "Fills the provided span with the color values in the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette.", + "colors": "The span to fill with hb_color_t color values." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.paletteIndex", + "params.colors" + ], + "remarks": "", + "returns": "The number of color values written into ." + } + }, + { + "memberType": "Method", + "memberName": "GetPaletteFlags", + "docId": "M:HarfBuzzSharp.Face.GetPaletteFlags(System.Int32)", + "signature": "public HarfBuzzSharp.OpenTypeColorPaletteFlags GetPaletteFlags (int paletteIndex);", + "fields": { + "summary": "Returns the flags describing the usage of the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.paletteIndex" + ], + "remarks": "", + "returns": "A value indicating whether the palette is suitable for light or dark backgrounds." + } + }, + { + "memberType": "Method", + "memberName": "GetPaletteNameId", + "docId": "M:HarfBuzzSharp.Face.GetPaletteNameId(System.Int32)", + "signature": "public HarfBuzzSharp.OpenTypeNameId GetPaletteNameId (int paletteIndex);", + "fields": { + "summary": "Returns the OpenType name identifier for the name of the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.paletteIndex" + ], + "remarks": "", + "returns": "The of the palette's name." + } + }, + { + "memberType": "Method", + "memberName": "GetVariationAxisInfos", + "docId": "M:HarfBuzzSharp.Face.GetVariationAxisInfos(System.Span{HarfBuzzSharp.OpenTypeVarAxisInfo})", + "signature": "public int GetVariationAxisInfos (Span axes);", + "fields": { + "summary": "Fills the provided span with information about the font's variation axes.", + "params": { + "axes": "The span to fill with variation axis information." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.axes" + ], + "remarks": "", + "returns": "The number of variation axis entries written into ." + } + }, + { + "memberType": "Property", + "memberName": "HasColorLayers", + "docId": "P:HarfBuzzSharp.Face.HasColorLayers", + "signature": "public bool HasColorLayers { get; }", + "fields": { + "summary": "Gets a value indicating whether this font face contains color layer data (COLR table).", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the font contains a COLR color layers table; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "HasColorPng", + "docId": "P:HarfBuzzSharp.Face.HasColorPng", + "signature": "public bool HasColorPng { get; }", + "fields": { + "summary": "Gets a value indicating whether this font face contains embedded PNG color glyphs (sbix table).", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the font contains embedded PNG images; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "HasColorSvg", + "docId": "P:HarfBuzzSharp.Face.HasColorSvg", + "signature": "public bool HasColorSvg { get; }", + "fields": { + "summary": "Gets a value indicating whether this font face contains embedded SVG color glyphs (SVG table).", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the font contains embedded SVG images; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "HasPalettes", + "docId": "P:HarfBuzzSharp.Face.HasPalettes", + "signature": "public bool HasPalettes { get; }", + "fields": { + "summary": "Gets a value indicating whether this font face contains color palette data (CPAL table).", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the font contains a CPAL color palettes table; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "HasVariationData", + "docId": "P:HarfBuzzSharp.Face.HasVariationData", + "signature": "public bool HasVariationData { get; }", + "fields": { + "summary": "Gets a value indicating whether this font face contains OpenType variable font data.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the font contains variable font axes (fvar table); otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "NamedInstanceCount", + "docId": "P:HarfBuzzSharp.Face.NamedInstanceCount", + "signature": "public int NamedInstanceCount { get; }", + "fields": { + "summary": "Gets the number of named instances defined in this variable font face.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The total number of named instances in the font's fvar table.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "PaletteCount", + "docId": "P:HarfBuzzSharp.Face.PaletteCount", + "signature": "public int PaletteCount { get; }", + "fields": { + "summary": "Gets the number of color palettes defined in this font face.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The total number of color palettes in the font's CPAL table.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "TryFindVariationAxis", + "docId": "M:HarfBuzzSharp.Face.TryFindVariationAxis(HarfBuzzSharp.Tag,HarfBuzzSharp.OpenTypeVarAxisInfo@)", + "signature": "public bool TryFindVariationAxis (HarfBuzzSharp.Tag tag, out HarfBuzzSharp.OpenTypeVarAxisInfo axisInfo);", + "fields": { + "summary": "Attempts to find the variation axis with the specified tag.", + "params": { + "tag": "The four-byte tag identifying the variation axis to find.", + "axisInfo": "When this method returns, contains the axis information if found. This parameter is treated as uninitialized." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.tag", + "params.axisInfo" + ], + "remarks": "", + "returns": " if the axis was found; otherwise, ." + } + }, + { + "memberType": "Property", + "memberName": "VariationAxisCount", + "docId": "P:HarfBuzzSharp.Face.VariationAxisCount", + "signature": "public int VariationAxisCount { get; }", + "fields": { + "summary": "Gets the number of variation axes defined in this variable font face.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The total number of variation axes in the font's fvar table.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationAxisInfos", + "docId": "P:HarfBuzzSharp.Face.VariationAxisInfos", + "signature": "public HarfBuzzSharp.OpenTypeVarAxisInfo[] VariationAxisInfos { get; }", + "fields": { + "summary": "Gets an array describing all variation axes defined in this variable font face.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "An array of structs, one per axis, or an empty array if the font has no variation data.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\HarfBuzzSharp\\Face.xml" +} diff --git a/output/docs-work/HarfBuzzSharp__Font.json b/output/docs-work/HarfBuzzSharp__Font.json new file mode 100644 index 00000000..0340fd80 --- /dev/null +++ b/output/docs-work/HarfBuzzSharp__Font.json @@ -0,0 +1,114 @@ +{ + "typeName": "HarfBuzzSharp.Font", + "entries": [ + { + "memberType": "Method", + "memberName": "GetVariationCoordsNormalized", + "docId": "M:HarfBuzzSharp.Font.GetVariationCoordsNormalized(System.Span{System.Int32})", + "signature": "public int GetVariationCoordsNormalized (Span coords);", + "fields": { + "summary": "Fills the provided span with the current normalized variation coordinates of this font.", + "params": { + "coords": "The span to fill with normalized variation coordinate values." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.coords" + ], + "remarks": "", + "returns": "The number of coordinates written into ." + } + }, + { + "memberType": "Method", + "memberName": "SetVariationCoordsDesign", + "docId": "M:HarfBuzzSharp.Font.SetVariationCoordsDesign(System.ReadOnlySpan{System.Single})", + "signature": "public void SetVariationCoordsDesign (ReadOnlySpan coords);", + "fields": { + "summary": "Sets the variation coordinates for this font using design-space values.", + "params": { + "coords": "The design-space variation coordinate values, one per variation axis in the order defined by the font." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.coords" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "SetVariationCoordsNormalized", + "docId": "M:HarfBuzzSharp.Font.SetVariationCoordsNormalized(System.ReadOnlySpan{System.Int32})", + "signature": "public void SetVariationCoordsNormalized (ReadOnlySpan coords);", + "fields": { + "summary": "Sets the variation coordinates for this font using normalized values.", + "params": { + "coords": "The normalized variation coordinate values, one per variation axis." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.coords" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "SetVariationNamedInstance", + "docId": "M:HarfBuzzSharp.Font.SetVariationNamedInstance(System.Int32)", + "signature": "public void SetVariationNamedInstance (int instanceIndex);", + "fields": { + "summary": "Sets the variation of this font to the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance to apply." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.instanceIndex" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "SetVariations", + "docId": "M:HarfBuzzSharp.Font.SetVariations(System.ReadOnlySpan{HarfBuzzSharp.Variation})", + "signature": "public void SetVariations (ReadOnlySpan variations);", + "fields": { + "summary": "Sets multiple variation axis values on this font using tag/value pairs.", + "params": { + "variations": "The variation axis tag-value pairs to apply." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.variations" + ], + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationCoordsNormalized", + "docId": "P:HarfBuzzSharp.Font.VariationCoordsNormalized", + "signature": "public int[] VariationCoordsNormalized { get; }", + "fields": { + "summary": "Gets an array containing the current normalized variation coordinates of this font.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "An array of normalized variation coordinate values, one per axis, or an empty array if no variation coordinates are set.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\HarfBuzzSharp\\Font.xml" +} diff --git a/output/docs-work/SkiaSharp.Views.Blazor___Imports.json b/output/docs-work/SkiaSharp.Views.Blazor___Imports.json new file mode 100644 index 00000000..73f480b5 --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Blazor___Imports.json @@ -0,0 +1,20 @@ +{ + "typeName": "SkiaSharp.Views.Blazor._Imports", + "entries": [ + { + "memberType": "Method", + "memberName": "Execute", + "docId": "M:SkiaSharp.Views.Blazor._Imports.Execute", + "signature": "protected void Execute ();", + "fields": { + "summary": "This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp.Views.Blazor\\_Imports.xml" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json b/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json new file mode 100644 index 00000000..c7b42666 --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json @@ -0,0 +1,266 @@ +{ + "typeName": "SkiaSharp.Views.Gtk.GTKExtensions", + "entries": [ + { + "memberType": "Method", + "memberName": "ToGdkRectangle", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRectangle(SkiaSharp.SKRectI)", + "signature": "public static Gdk.Rectangle ToGdkRectangle (this SkiaSharp.SKRectI rect);", + "fields": { + "summary": "Converts an to a .", + "params": { + "rect": "The SkiaSharp integer rectangle to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.rect" + ], + "remarks": "", + "returns": "A with the same position and size as the source rectangle." + } + }, + { + "memberType": "Method", + "memberName": "ToGdkRGBA", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRGBA(SkiaSharp.SKColor)", + "signature": "public static Gdk.RGBA ToGdkRGBA (this SkiaSharp.SKColor color);", + "fields": { + "summary": "Converts an to a .", + "params": { + "color": "The SkiaSharp color to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.color" + ], + "remarks": "", + "returns": "A with component values normalised to the [0, 1] range." + } + }, + { + "memberType": "Method", + "memberName": "ToGdkRGBA", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRGBA(SkiaSharp.SKColorF)", + "signature": "public static Gdk.RGBA ToGdkRGBA (this SkiaSharp.SKColorF color);", + "fields": { + "summary": "Converts an to a .", + "params": { + "color": "The SkiaSharp floating-point color to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.color" + ], + "remarks": "", + "returns": "A with the same floating-point component values." + } + }, + { + "memberType": "Method", + "memberName": "ToGraphenePoint", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGraphenePoint(SkiaSharp.SKPoint)", + "signature": "public static Graphene.Point ToGraphenePoint (this SkiaSharp.SKPoint point);", + "fields": { + "summary": "Converts an to a .", + "params": { + "point": "The SkiaSharp 2D point to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.point" + ], + "remarks": "", + "returns": "A with the same X and Y coordinates." + } + }, + { + "memberType": "Method", + "memberName": "ToGraphenePoint3D", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGraphenePoint3D(SkiaSharp.SKPoint3)", + "signature": "public static Graphene.Point3D ToGraphenePoint3D (this SkiaSharp.SKPoint3 point);", + "fields": { + "summary": "Converts an to a .", + "params": { + "point": "The SkiaSharp 3D point to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.point" + ], + "remarks": "", + "returns": "A with the same X, Y, and Z coordinates." + } + }, + { + "memberType": "Method", + "memberName": "ToGrapheneRect", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGrapheneRect(SkiaSharp.SKRect)", + "signature": "public static Graphene.Rect ToGrapheneRect (this SkiaSharp.SKRect rect);", + "fields": { + "summary": "Converts an to a .", + "params": { + "rect": "The SkiaSharp floating-point rectangle to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.rect" + ], + "remarks": "", + "returns": "A with the same origin and size." + } + }, + { + "memberType": "Method", + "memberName": "ToGrapheneSize", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGrapheneSize(SkiaSharp.SKSize)", + "signature": "public static Graphene.Size ToGrapheneSize (this SkiaSharp.SKSize size);", + "fields": { + "summary": "Converts an to a .", + "params": { + "size": "The SkiaSharp size to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.size" + ], + "remarks": "", + "returns": "A with the same width and height." + } + }, + { + "memberType": "Method", + "memberName": "ToSKColor", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKColor(Gdk.RGBA)", + "signature": "public static SkiaSharp.SKColor ToSKColor (this Gdk.RGBA color);", + "fields": { + "summary": "Converts a to an .", + "params": { + "color": "The GTK RGBA color to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.color" + ], + "remarks": "", + "returns": "An with component values scaled to the [0, 255] range." + } + }, + { + "memberType": "Method", + "memberName": "ToSKColorF", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKColorF(Gdk.RGBA)", + "signature": "public static SkiaSharp.SKColorF ToSKColorF (this Gdk.RGBA color);", + "fields": { + "summary": "Converts a to an .", + "params": { + "color": "The GTK RGBA color to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.color" + ], + "remarks": "", + "returns": "An with the same floating-point component values." + } + }, + { + "memberType": "Method", + "memberName": "ToSKPoint", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKPoint(Graphene.Point)", + "signature": "public static SkiaSharp.SKPoint ToSKPoint (this Graphene.Point point);", + "fields": { + "summary": "Converts a to an .", + "params": { + "point": "The Graphene 2D point to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.point" + ], + "remarks": "", + "returns": "An with the same X and Y coordinates." + } + }, + { + "memberType": "Method", + "memberName": "ToSKPoint3", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKPoint3(Graphene.Point3D)", + "signature": "public static SkiaSharp.SKPoint3 ToSKPoint3 (this Graphene.Point3D point);", + "fields": { + "summary": "Converts a to an .", + "params": { + "point": "The Graphene 3D point to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.point" + ], + "remarks": "", + "returns": "An with the same X, Y, and Z coordinates." + } + }, + { + "memberType": "Method", + "memberName": "ToSKRect", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKRect(Graphene.Rect)", + "signature": "public static SkiaSharp.SKRect ToSKRect (this Graphene.Rect rect);", + "fields": { + "summary": "Converts a to an .", + "params": { + "rect": "The Graphene rectangle to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.rect" + ], + "remarks": "", + "returns": "An with the same origin and size." + } + }, + { + "memberType": "Method", + "memberName": "ToSKSize", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKSize(Graphene.Size)", + "signature": "public static SkiaSharp.SKSize ToSKSize (this Graphene.Size size);", + "fields": { + "summary": "Converts a to an .", + "params": { + "size": "The Graphene size to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.size" + ], + "remarks": "", + "returns": "An with the same width and height." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp.Views.Gtk\\GTKExtensions.xml" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json b/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json new file mode 100644 index 00000000..57840017 --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json @@ -0,0 +1,20 @@ +{ + "typeName": "SkiaSharp.Views.Gtk.SKDrawingArea", + "entries": [ + { + "memberType": "Method", + "memberName": "Dispose", + "docId": "M:SkiaSharp.Views.Gtk.SKDrawingArea.Dispose", + "signature": "public override void Dispose ();", + "fields": { + "summary": "Releases the resources used by the .", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp.Views.Gtk\\SKDrawingArea.xml" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json b/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json new file mode 100644 index 00000000..eb213ff5 --- /dev/null +++ b/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json @@ -0,0 +1,183 @@ +{ + "typeName": "SkiaSharp.GRVkYcbcrComponents", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Describes the per-component swizzle mapping used in a Vulkan YCbCr conversion.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": ".\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar components = new GRVkYcbcrComponents\n{\n R = (uint)VkComponentSwizzle.Identity,\n G = (uint)VkComponentSwizzle.Identity,\n B = (uint)VkComponentSwizzle.Identity,\n A = (uint)VkComponentSwizzle.Identity,\n};\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "A", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.A", + "signature": "public uint A { get; set; }", + "fields": { + "summary": "Gets or sets the swizzle applied to the alpha component.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A VkComponentSwizzle value specifying the source for the alpha channel.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "B", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.B", + "signature": "public uint B { get; set; }", + "fields": { + "summary": "Gets or sets the swizzle applied to the blue component.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A VkComponentSwizzle value specifying the source for the blue channel.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.Equals(SkiaSharp.GRVkYcbcrComponents)", + "signature": "public readonly bool Equals (SkiaSharp.GRVkYcbcrComponents obj);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "obj": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if all component swizzle values are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.Equals(System.Object)", + "signature": "public override readonly bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is a with equal component values; otherwise, ." + } + }, + { + "memberType": "Property", + "memberName": "G", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.G", + "signature": "public uint G { get; set; }", + "fields": { + "summary": "Gets or sets the swizzle applied to the green component.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A VkComponentSwizzle value specifying the source for the green channel.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.GetHashCode", + "signature": "public override readonly int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A hash code based on all four component swizzle values." + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.op_Equality(SkiaSharp.GRVkYcbcrComponents,SkiaSharp.GRVkYcbcrComponents)", + "signature": "public static bool operator == (SkiaSharp.GRVkYcbcrComponents left, SkiaSharp.GRVkYcbcrComponents right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.op_Inequality(SkiaSharp.GRVkYcbcrComponents,SkiaSharp.GRVkYcbcrComponents)", + "signature": "public static bool operator != (SkiaSharp.GRVkYcbcrComponents left, SkiaSharp.GRVkYcbcrComponents right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are not equal; otherwise, ." + } + }, + { + "memberType": "Property", + "memberName": "R", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.R", + "signature": "public uint R { get; set; }", + "fields": { + "summary": "Gets or sets the swizzle applied to the red component.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A VkComponentSwizzle value specifying the source for the red channel.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\GRVkYcbcrComponents.xml" +} diff --git a/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json b/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json new file mode 100644 index 00000000..2d7a48c7 --- /dev/null +++ b/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json @@ -0,0 +1,54 @@ +{ + "typeName": "SkiaSharp.GrVkYcbcrConversionInfo", + "entries": [ + { + "memberType": "Property", + "memberName": "Components", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.Components", + "signature": "public SkiaSharp.GRVkYcbcrComponents Components { get; set; }", + "fields": { + "summary": "Gets or sets the component swizzle mapping for the YCbCr conversion.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A describing how the R, G, B, and A channels are remapped during sampling.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "SamplerFilterMustMatchChromaFilter", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.SamplerFilterMustMatchChromaFilter", + "signature": "public bool SamplerFilterMustMatchChromaFilter { get; set; }", + "fields": { + "summary": "Gets or sets a value indicating whether the sampler filter mode must match the chroma filter.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the sampler's min/mag filter must equal the chroma filter; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "SupportsLinearFilter", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.SupportsLinearFilter", + "signature": "public bool SupportsLinearFilter { get; set; }", + "fields": { + "summary": "Gets or sets a value indicating whether linear filtering is supported for this conversion.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if linear chroma filtering is supported; otherwise, .", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\GrVkYcbcrConversionInfo.xml" +} diff --git a/output/docs-work/SkiaSharp__SKCanvas.json b/output/docs-work/SkiaSharp__SKCanvas.json new file mode 100644 index 00000000..56f7db62 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKCanvas.json @@ -0,0 +1,56 @@ +{ + "typeName": "SkiaSharp.SKCanvas", + "entries": [ + { + "memberType": "Method", + "memberName": "DrawSurface", + "docId": "M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,SkiaSharp.SKPoint,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "signature": "public void DrawSurface (SkiaSharp.SKSurface surface, SkiaSharp.SKPoint p, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "fields": { + "summary": "Draws the contents of the specified surface onto this canvas at the given point, using the specified sampling options.", + "params": { + "sampling": "The sampling options that control how pixels are filtered when drawing.", + "paint": "The paint to apply, or to draw with default settings.", + "surface": "The surface whose contents are drawn.", + "p": "The point at which the top-left corner of the surface is placed." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.sampling", + "params.paint", + "params.surface", + "params.p" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "DrawSurface", + "docId": "M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,System.Single,System.Single,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "signature": "public void DrawSurface (SkiaSharp.SKSurface surface, float x, float y, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "fields": { + "summary": "Draws the contents of the specified surface onto this canvas at the given coordinates, using the specified sampling options.", + "params": { + "x": "The x-coordinate at which the top-left corner of the surface is placed.", + "sampling": "The sampling options that control how pixels are filtered when drawing.", + "paint": "The paint to apply, or to draw with default settings.", + "surface": "The surface whose contents are drawn.", + "y": "The y-coordinate at which the top-left corner of the surface is placed." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x", + "params.sampling", + "params.paint", + "params.surface", + "params.y" + ], + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKCanvas.xml" +} diff --git a/output/docs-work/SkiaSharp__SKColorSpace.json b/output/docs-work/SkiaSharp__SKColorSpace.json new file mode 100644 index 00000000..c9dd95ab --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorSpace.json @@ -0,0 +1,28 @@ +{ + "typeName": "SkiaSharp.SKColorSpace", + "entries": [ + { + "memberType": "Method", + "memberName": "CreateCicp", + "docId": "M:SkiaSharp.SKColorSpace.CreateCicp(SkiaSharp.SKColorspacePrimariesCicp,SkiaSharp.SKColorspaceTransferFnCicp)", + "signature": "public static SkiaSharp.SKColorSpace CreateCicp (SkiaSharp.SKColorspacePrimariesCicp colorPrimaries, SkiaSharp.SKColorspaceTransferFnCicp transferCharacteristics);", + "fields": { + "summary": "Creates a color space defined by the specified CICP (Coding-Independent Code Points) color primaries and transfer characteristics.", + "params": { + "colorPrimaries": "One of the enumeration values that specifies the color primaries as defined in ITU-T H.273.", + "transferCharacteristics": "One of the enumeration values that specifies the opto-electronic transfer function as defined in ITU-T H.273." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.colorPrimaries", + "params.transferCharacteristics" + ], + "remarks": "", + "returns": "A new described by the given CICP parameters, or if the combination is not supported." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKColorSpace.xml" +} diff --git a/output/docs-work/SkiaSharp__SKColorType.json b/output/docs-work/SkiaSharp__SKColorType.json new file mode 100644 index 00000000..431188d0 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorType.json @@ -0,0 +1,42 @@ +{ + "typeName": "SkiaSharp.SKColorType", + "entries": [ + { + "memberType": "Field", + "memberName": "Bgra10101010XR", + "docId": "F:SkiaSharp.SKColorType.Bgra10101010XR", + "signature": "Bgra10101010XR", + "fields": { + "summary": "An 8-byte pixel format with four 10-bit extended-range (XR) components in BGRA order, supporting values outside the [0, 1] range.", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "R16Unorm", + "docId": "F:SkiaSharp.SKColorType.R16Unorm", + "signature": "R16Unorm", + "fields": { + "summary": "A 2-byte pixel format with a single 16-bit unsigned normalized red channel.", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "RgbF16F16F16x", + "docId": "F:SkiaSharp.SKColorType.RgbF16F16F16x", + "signature": "RgbF16F16F16x", + "fields": { + "summary": "An 8-byte opaque pixel format with three 16-bit float RGB channels and one unused 16-bit padding component.", + "_extractedKeys": [ + "summary" + ] + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKColorType.xml" +} diff --git a/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json b/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json new file mode 100644 index 00000000..86d77685 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json @@ -0,0 +1,163 @@ +{ + "typeName": "SkiaSharp.SKColorspacePrimariesCicp", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies the color primaries of a color space as defined by the CICP (Coding-Independent Code Points) standard ITU-T H.273.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " to\n to construct an\n from CICP metadata embedded in image files (for\nexample, AVIF or HEIC).\n\n## Examples\n\n```csharp\n// Create an sRGB-equivalent color space using CICP codes\nvar colorSpace = SKColorSpace.CreateCicp(\n SKColorspacePrimariesCicp.Rec709,\n SKColorspaceTransferFnCicp.Iec6196621);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Field", + "memberName": "GenericFilm", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.GenericFilm", + "signature": "GenericFilm", + "fields": { + "summary": "Generic film color primaries (CICP code point 8).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "ItuTH273Value22", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.ItuTH273Value22", + "signature": "ItuTH273Value22", + "fields": { + "summary": "ITU-T H.273 code point 22, used for EBU Tech 3213-E color primaries.", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec2020", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec2020", + "signature": "Rec2020", + "fields": { + "summary": "ITU-R BT.2020 / BT.2100 color primaries, used for ultra-high-definition television (CICP code point 9).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec470SystemBg", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec470SystemBg", + "signature": "Rec470SystemBg", + "fields": { + "summary": "ITU-R BT.470 System B/G color primaries, used for PAL and SECAM standard definition television (CICP code point 5).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec470SystemM", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec470SystemM", + "signature": "Rec470SystemM", + "fields": { + "summary": "ITU-R BT.470 System M color primaries, used for NTSC standard definition television (CICP code point 4).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec601", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec601", + "signature": "Rec601", + "fields": { + "summary": "ITU-R BT.601 color primaries, used for standard definition television (CICP code point 6).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec709", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec709", + "signature": "Rec709", + "fields": { + "summary": "ITU-R BT.709 color primaries, used for high-definition television and sRGB displays (CICP code point 1).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteEg4321", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteEg4321", + "signature": "SmpteEg4321", + "fields": { + "summary": "SMPTE EG 432-1 (P3-D65) color primaries, used for digital cinema and Apple Display P3 (CICP code point 12).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteRp4312", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteRp4312", + "signature": "SmpteRp4312", + "fields": { + "summary": "SMPTE RP 431-2 (P3-DCI) color primaries, used for digital cinema projection (CICP code point 11).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteSt240", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteSt240", + "signature": "SmpteSt240", + "fields": { + "summary": "SMPTE ST 240 color primaries (CICP code point 7).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteSt4281", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteSt4281", + "signature": "SmpteSt4281", + "fields": { + "summary": "SMPTE ST 428-1 (XYZ) color primaries, used for digital cinema (CICP code point 10).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Unknown", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Unknown", + "signature": "Unknown", + "fields": { + "summary": "Unknown or unspecified color primaries (CICP code point 0).", + "_extractedKeys": [ + "summary" + ] + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKColorspacePrimariesCicp.xml" +} diff --git a/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json b/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json new file mode 100644 index 00000000..4c516e24 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json @@ -0,0 +1,187 @@ +{ + "typeName": "SkiaSharp.SKColorspaceTransferFnCicp", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies the opto-electronic transfer function (OETF) of a color space as defined by the CICP (Coding-Independent Code Points) standard ITU-T H.273.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " to\n to construct an\n from CICP metadata embedded in image files (for\nexample, AVIF or HEIC).\n\n## Examples\n\n```csharp\n// Create an HDR PQ color space from CICP metadata\nvar colorSpace = SKColorSpace.CreateCicp(\n SKColorspacePrimariesCicp.Rec2020,\n SKColorspaceTransferFnCicp.Pq);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Field", + "memberName": "Hlg", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Hlg", + "signature": "Hlg", + "fields": { + "summary": "Hybrid Log-Gamma (HLG) transfer function, used for HDR broadcast (CICP code point 18).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Iec6196621", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Iec6196621", + "signature": "Iec6196621", + "fields": { + "summary": "IEC 61966-2-1 transfer function, which defines the standard sRGB electro-optical transfer function (CICP code point 13).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Iec6196624", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Iec6196624", + "signature": "Iec6196624", + "fields": { + "summary": "IEC 61966-2-4 transfer function (CICP code point 11).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Linear", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Linear", + "signature": "Linear", + "fields": { + "summary": "Linear (no gamma) transfer function (CICP code point 8).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Pq", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Pq", + "signature": "Pq", + "fields": { + "summary": "Perceptual Quantizer (PQ / SMPTE ST 2084) transfer function, used for HDR displays (CICP code point 16).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec202010bit", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec202010bit", + "signature": "Rec202010bit", + "fields": { + "summary": "ITU-R BT.2020 10-bit transfer function (CICP code point 14).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec202012bit", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec202012bit", + "signature": "Rec202012bit", + "fields": { + "summary": "ITU-R BT.2020 12-bit transfer function (CICP code point 15).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec470SystemBg", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec470SystemBg", + "signature": "Rec470SystemBg", + "fields": { + "summary": "ITU-R BT.470 System B/G transfer function, assumed display gamma (CICP code point 5).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec470SystemM", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec470SystemM", + "signature": "Rec470SystemM", + "fields": { + "summary": "ITU-R BT.470 System M transfer function, assumed display gamma (CICP code point 4).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec601", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec601", + "signature": "Rec601", + "fields": { + "summary": "ITU-R BT.601 transfer function, used for standard definition television (CICP code point 6).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Rec709", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec709", + "signature": "Rec709", + "fields": { + "summary": "ITU-R BT.709 transfer function, used for high-definition television (CICP code point 1).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteSt240", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.SmpteSt240", + "signature": "SmpteSt240", + "fields": { + "summary": "SMPTE ST 240 transfer function (CICP code point 7).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "SmpteSt4281", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.SmpteSt4281", + "signature": "SmpteSt4281", + "fields": { + "summary": "SMPTE ST 428-1 transfer function, used for digital cinema (CICP code point 17).", + "_extractedKeys": [ + "summary" + ] + } + }, + { + "memberType": "Field", + "memberName": "Unknown", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Unknown", + "signature": "Unknown", + "fields": { + "summary": "Unknown or unspecified transfer function (CICP code point 0).", + "_extractedKeys": [ + "summary" + ] + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKColorspaceTransferFnCicp.xml" +} diff --git a/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json b/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json new file mode 100644 index 00000000..cdb179a0 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json @@ -0,0 +1,151 @@ +{ + "typeName": "SkiaSharp.SKDocumentXpsOptions", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies options for creating an XPS document.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": ". Set the desired DPI and other\nproperties before passing the struct to the factory method.\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar options = new SKDocumentXpsOptions\n{\n DPI = 300,\n AllowNoPngs = false,\n};\n\nusing var stream = File.OpenWrite(\"output.xps\");\nusing var doc = SKDocument.CreateXps(stream, options);\nusing var canvas = doc.BeginPage(595, 842);\ncanvas.DrawColor(SKColors.White);\ndoc.EndPage();\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "AllowNoPngs", + "docId": "P:SkiaSharp.SKDocumentXpsOptions.AllowNoPngs", + "signature": "public bool AllowNoPngs { get; set; }", + "fields": { + "summary": "Gets or sets a value indicating whether images may be embedded without PNG encoding.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " to allow non-PNG image encodings in the document; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "DPI", + "docId": "P:SkiaSharp.SKDocumentXpsOptions.DPI", + "signature": "public float DPI { get; set; }", + "fields": { + "summary": "Gets or sets the dots per inch (DPI) used when rasterizing content in the XPS document.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The resolution in dots per inch.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.Equals(SkiaSharp.SKDocumentXpsOptions)", + "signature": "public readonly bool Equals (SkiaSharp.SKDocumentXpsOptions obj);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "obj": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if all option fields are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.Equals(System.Object)", + "signature": "public override readonly bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is a with equal field values; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.GetHashCode", + "signature": "public override readonly int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A hash code based on all option fields." + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.op_Equality(SkiaSharp.SKDocumentXpsOptions,SkiaSharp.SKDocumentXpsOptions)", + "signature": "public static bool operator == (SkiaSharp.SKDocumentXpsOptions left, SkiaSharp.SKDocumentXpsOptions right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.op_Inequality(SkiaSharp.SKDocumentXpsOptions,SkiaSharp.SKDocumentXpsOptions)", + "signature": "public static bool operator != (SkiaSharp.SKDocumentXpsOptions left, SkiaSharp.SKDocumentXpsOptions right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are not equal; otherwise, ." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKDocumentXpsOptions.xml" +} diff --git a/output/docs-work/SkiaSharp__SKFontArguments.json b/output/docs-work/SkiaSharp__SKFontArguments.json new file mode 100644 index 00000000..915bdbe3 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontArguments.json @@ -0,0 +1,83 @@ +{ + "typeName": "SkiaSharp.SKFontArguments", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies the arguments used to customize a typeface when cloning it, including variation axis positions, palette selection, and palette color overrides.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": ". You can\nspecify variation axis coordinates, a color palette index, and per-color\noverrides for the palette.\n\nThis is a ref struct (stack-only) value type and does not require disposal.\n\n## Examples\n\n```csharp\nSKFontVariationPositionCoordinate[] coords =\n[\n new() { Axis = SKFourByteTag.Parse(\"wght\"), Value = 700 },\n];\n\nvar args = new SKFontArguments\n{\n VariationDesignPosition = coords,\n PaletteIndex = 0,\n};\n\nusing var boldTypeface = typeface.Clone(args);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "CollectionIndex", + "docId": "P:SkiaSharp.SKFontArguments.CollectionIndex", + "signature": "public int CollectionIndex { get; set; }", + "fields": { + "summary": "Gets or sets the zero-based index of the font to use within a font collection (TTC) file.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The index of the font within the collection. The default value is 0.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "PaletteIndex", + "docId": "P:SkiaSharp.SKFontArguments.PaletteIndex", + "signature": "public int PaletteIndex { get; set; }", + "fields": { + "summary": "Gets or sets the zero-based index of the color palette to use from the font's CPAL table.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The index of the palette to apply. The default value is 0.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "PaletteOverrides", + "docId": "P:SkiaSharp.SKFontArguments.PaletteOverrides", + "signature": "public ReadOnlySpan PaletteOverrides { get; set; }", + "fields": { + "summary": "Gets or sets the per-color overrides to apply on top of the selected palette.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A read-only span of values. Each entry replaces a specific color in the active palette.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationDesignPosition", + "docId": "P:SkiaSharp.SKFontArguments.VariationDesignPosition", + "signature": "public ReadOnlySpan VariationDesignPosition { get; set; }", + "fields": { + "summary": "Gets or sets the variation axis design-space coordinates to apply to the typeface.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A read-only span of values, one per axis to override.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKFontArguments.xml" +} diff --git a/output/docs-work/SkiaSharp__SKFontPaletteOverride.json b/output/docs-work/SkiaSharp__SKFontPaletteOverride.json new file mode 100644 index 00000000..0e55138d --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontPaletteOverride.json @@ -0,0 +1,151 @@ +{ + "typeName": "SkiaSharp.SKFontPaletteOverride", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies a replacement color for a single entry in a font's color palette.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " when cloning a typeface to\nchange specific colors in the active CPAL palette without switching to a\ndifferent palette entirely.\n\nThe field stores a packed ARGB\nvalue in the same format as (`0xAARRGGBB`).\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar overrides = new SKFontPaletteOverride[]\n{\n new() { Index = 0, Color = (uint)SKColors.Red },\n new() { Index = 1, Color = (uint)SKColors.Blue },\n};\n\nvar args = new SKFontArguments\n{\n PaletteIndex = 0,\n PaletteOverrides = overrides,\n};\n\nusing var customTypeface = typeface.Clone(args);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "Color", + "docId": "P:SkiaSharp.SKFontPaletteOverride.Color", + "signature": "public uint Color { get; set; }", + "fields": { + "summary": "Gets or sets the replacement color as a packed ARGB value.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The ARGB color packed as 0xAARRGGBB, matching the layout.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontPaletteOverride.Equals(SkiaSharp.SKFontPaletteOverride)", + "signature": "public readonly bool Equals (SkiaSharp.SKFontPaletteOverride obj);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "obj": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if both the index and color are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontPaletteOverride.Equals(System.Object)", + "signature": "public override readonly bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is a with equal field values; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontPaletteOverride.GetHashCode", + "signature": "public override readonly int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A hash code based on the palette index and color value." + } + }, + { + "memberType": "Property", + "memberName": "Index", + "docId": "P:SkiaSharp.SKFontPaletteOverride.Index", + "signature": "public ushort Index { get; set; }", + "fields": { + "summary": "Gets or sets the zero-based index of the palette color entry to override.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The zero-based index into the active color palette.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontPaletteOverride.op_Equality(SkiaSharp.SKFontPaletteOverride,SkiaSharp.SKFontPaletteOverride)", + "signature": "public static bool operator == (SkiaSharp.SKFontPaletteOverride left, SkiaSharp.SKFontPaletteOverride right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontPaletteOverride.op_Inequality(SkiaSharp.SKFontPaletteOverride,SkiaSharp.SKFontPaletteOverride)", + "signature": "public static bool operator != (SkiaSharp.SKFontPaletteOverride left, SkiaSharp.SKFontPaletteOverride right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are not equal; otherwise, ." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKFontPaletteOverride.xml" +} diff --git a/output/docs-work/SkiaSharp__SKFontVariationAxis.json b/output/docs-work/SkiaSharp__SKFontVariationAxis.json new file mode 100644 index 00000000..208e757b --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontVariationAxis.json @@ -0,0 +1,199 @@ +{ + "typeName": "SkiaSharp.SKFontVariationAxis", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Describes a single variation axis of an OpenType variable font, including its tag, value range, default value, and visibility.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " or\n to retrieve the\naxes supported by a typeface.\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nSKFontVariationAxis[] axes = typeface.VariationDesignParameters;\nforeach (var axis in axes)\n{\n Console.WriteLine(\n $\"{axis.Tag}: min={axis.Min}, def={axis.Default}, max={axis.Max}\");\n}\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "Default", + "docId": "P:SkiaSharp.SKFontVariationAxis.Default", + "signature": "public float Default { get; set; }", + "fields": { + "summary": "Gets or sets the default design-space value for this variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The default axis value in design-space units.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationAxis.Equals(SkiaSharp.SKFontVariationAxis)", + "signature": "public readonly bool Equals (SkiaSharp.SKFontVariationAxis obj);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "obj": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if all fields are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationAxis.Equals(System.Object)", + "signature": "public override readonly bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is an with equal field values; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontVariationAxis.GetHashCode", + "signature": "public override readonly int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A hash code based on the tag, min, default, max, and hidden flag." + } + }, + { + "memberType": "Property", + "memberName": "IsHidden", + "docId": "P:SkiaSharp.SKFontVariationAxis.IsHidden", + "signature": "public bool IsHidden { get; set; }", + "fields": { + "summary": "Gets or sets a value indicating whether this axis should be hidden from end-user interfaces.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the axis is marked hidden in the font; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "Max", + "docId": "P:SkiaSharp.SKFontVariationAxis.Max", + "signature": "public float Max { get; set; }", + "fields": { + "summary": "Gets or sets the maximum allowed design-space value for this variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The maximum axis value in design-space units.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "Min", + "docId": "P:SkiaSharp.SKFontVariationAxis.Min", + "signature": "public float Min { get; set; }", + "fields": { + "summary": "Gets or sets the minimum allowed design-space value for this variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The minimum axis value in design-space units.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontVariationAxis.op_Equality(SkiaSharp.SKFontVariationAxis,SkiaSharp.SKFontVariationAxis)", + "signature": "public static bool operator == (SkiaSharp.SKFontVariationAxis left, SkiaSharp.SKFontVariationAxis right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontVariationAxis.op_Inequality(SkiaSharp.SKFontVariationAxis,SkiaSharp.SKFontVariationAxis)", + "signature": "public static bool operator != (SkiaSharp.SKFontVariationAxis left, SkiaSharp.SKFontVariationAxis right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are not equal; otherwise, ." + } + }, + { + "memberType": "Property", + "memberName": "Tag", + "docId": "P:SkiaSharp.SKFontVariationAxis.Tag", + "signature": "public SkiaSharp.SKFourByteTag Tag { get; set; }", + "fields": { + "summary": "Gets or sets the four-byte tag identifying this variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The for this axis, for example wght for weight or wdth for width.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKFontVariationAxis.xml" +} diff --git a/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json b/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json new file mode 100644 index 00000000..8284ebf3 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json @@ -0,0 +1,151 @@ +{ + "typeName": "SkiaSharp.SKFontVariationPositionCoordinate", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Specifies a design-space position for a single variation axis of an OpenType variable font.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " or directly to\n\nto pin specific axes of a variable font to desired values.\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar position = new SKFontVariationPositionCoordinate[]\n{\n new() { Axis = SKFourByteTag.Parse(\"wght\"), Value = 700 },\n new() { Axis = SKFourByteTag.Parse(\"ital\"), Value = 1 },\n};\n\nusing var styledTypeface = typeface.Clone(position.AsSpan());\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Property", + "memberName": "Axis", + "docId": "P:SkiaSharp.SKFontVariationPositionCoordinate.Axis", + "signature": "public SkiaSharp.SKFourByteTag Axis { get; set; }", + "fields": { + "summary": "Gets or sets the four-byte tag identifying the variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The of the axis, for example wght for weight.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.Equals(SkiaSharp.SKFontVariationPositionCoordinate)", + "signature": "public readonly bool Equals (SkiaSharp.SKFontVariationPositionCoordinate obj);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "obj": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if both the axis tag and value are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.Equals(System.Object)", + "signature": "public override readonly bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is an with equal field values; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.GetHashCode", + "signature": "public override readonly int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A hash code based on the axis tag and value." + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.op_Equality(SkiaSharp.SKFontVariationPositionCoordinate,SkiaSharp.SKFontVariationPositionCoordinate)", + "signature": "public static bool operator == (SkiaSharp.SKFontVariationPositionCoordinate left, SkiaSharp.SKFontVariationPositionCoordinate right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are equal; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.op_Inequality(SkiaSharp.SKFontVariationPositionCoordinate,SkiaSharp.SKFontVariationPositionCoordinate)", + "signature": "public static bool operator != (SkiaSharp.SKFontVariationPositionCoordinate left, SkiaSharp.SKFontVariationPositionCoordinate right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and are not equal; otherwise, ." + } + }, + { + "memberType": "Property", + "memberName": "Value", + "docId": "P:SkiaSharp.SKFontVariationPositionCoordinate.Value", + "signature": "public float Value { get; set; }", + "fields": { + "summary": "Gets or sets the design-space value for the variation axis.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The axis value in design-space units, which must be within the range defined by the axis.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKFontVariationPositionCoordinate.xml" +} diff --git a/output/docs-work/SkiaSharp__SKFourByteTag.json b/output/docs-work/SkiaSharp__SKFourByteTag.json new file mode 100644 index 00000000..10f7e890 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFourByteTag.json @@ -0,0 +1,237 @@ +{ + "typeName": "SkiaSharp.SKFourByteTag", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Represents a four-byte OpenType/TrueType tag packed into a 32-bit unsigned integer.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": "(c1 << 24) | (c2 << 16) | (c3 << 8) | c4.\nThis matches the OpenType/TrueType tag convention used for table identifiers,\nfeature tags, variation axis tags, and similar four-character codes.\n\nImplicit conversions to and from `uint` are provided, and the struct is\ninterchangeable with `uint` in most SkiaSharp APIs that accept tags.\n\nThis is a value type and does not require disposal.\n\n## Examples\n\n```csharp\n// Construct from four characters\nvar wghtTag = new SKFourByteTag('w', 'g', 'h', 't');\n\n// Parse from a string (pads or truncates to 4 characters)\nvar italTag = SKFourByteTag.Parse(\"ital\");\n\n// Round-trip to/from uint\nuint raw = wghtTag;\nSKFourByteTag back = raw;\n\nConsole.WriteLine(wghtTag.ToString()); // \"wght\"\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Constructor", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKFourByteTag.#ctor(System.UInt32)", + "signature": "public SKFourByteTag (uint value);", + "fields": { + "summary": "Initializes a new instance of the struct from a packed 32-bit value.", + "params": { + "value": "The packed tag value, where the most-significant byte holds the first character." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.value" + ], + "remarks": "" + } + }, + { + "memberType": "Constructor", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKFourByteTag.#ctor(System.Char,System.Char,System.Char,System.Char)", + "signature": "public SKFourByteTag (char c1, char c2, char c3, char c4);", + "fields": { + "summary": "Initializes a new instance of the struct from four ASCII characters.", + "params": { + "c4": "The fourth (least-significant) character of the tag.", + "c2": "The second character of the tag.", + "c3": "The third character of the tag.", + "c1": "The first (most-significant) character of the tag." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.c4", + "params.c2", + "params.c3", + "params.c1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFourByteTag.Equals(SkiaSharp.SKFourByteTag)", + "signature": "public bool Equals (SkiaSharp.SKFourByteTag other);", + "fields": { + "summary": "Determines whether the specified is equal to the current instance.", + "params": { + "other": "The value to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.other" + ], + "remarks": "", + "returns": " if both tags encode the same value; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFourByteTag.Equals(System.Object)", + "signature": "public override bool Equals (object obj);", + "fields": { + "summary": "Determines whether the specified object is equal to the current instance.", + "params": { + "obj": "The object to compare with the current instance." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.obj" + ], + "remarks": "", + "returns": " if is a with the same packed value; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFourByteTag.GetHashCode", + "signature": "public override int GetHashCode ();", + "fields": { + "summary": "Returns a hash code for the current instance.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "The packed 32-bit tag value cast to ." + } + }, + { + "memberType": "Method", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFourByteTag.op_Equality(SkiaSharp.SKFourByteTag,SkiaSharp.SKFourByteTag)", + "signature": "public static bool operator == (SkiaSharp.SKFourByteTag left, SkiaSharp.SKFourByteTag right);", + "fields": { + "summary": "Returns a value indicating whether two instances are equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and encode the same value; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "op_Implicit", + "docId": "M:SkiaSharp.SKFourByteTag.op_Implicit(SkiaSharp.SKFourByteTag)~System.UInt32", + "signature": "public static implicit operator uint (SkiaSharp.SKFourByteTag tag);", + "fields": { + "summary": "Implicitly converts a to its packed representation.", + "params": { + "tag": "The tag to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.tag" + ], + "remarks": "", + "returns": "The packed 32-bit value of the tag." + } + }, + { + "memberType": "Method", + "memberName": "op_Implicit", + "docId": "M:SkiaSharp.SKFourByteTag.op_Implicit(System.UInt32)~SkiaSharp.SKFourByteTag", + "signature": "public static implicit operator SkiaSharp.SKFourByteTag (uint tag);", + "fields": { + "summary": "Implicitly converts a packed value to an .", + "params": { + "tag": "The packed 32-bit tag value to convert." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.tag" + ], + "remarks": "", + "returns": "An wrapping ." + } + }, + { + "memberType": "Method", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFourByteTag.op_Inequality(SkiaSharp.SKFourByteTag,SkiaSharp.SKFourByteTag)", + "signature": "public static bool operator != (SkiaSharp.SKFourByteTag left, SkiaSharp.SKFourByteTag right);", + "fields": { + "summary": "Returns a value indicating whether two instances are not equal.", + "params": { + "left": "The first value to compare.", + "right": "The second value to compare." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.left", + "params.right" + ], + "remarks": "", + "returns": " if and encode different values; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Parse", + "docId": "M:SkiaSharp.SKFourByteTag.Parse(System.String)", + "signature": "public static SkiaSharp.SKFourByteTag Parse (string? tag);", + "fields": { + "summary": "Parses a string into an , padding with spaces or truncating to exactly four characters.", + "params": { + "tag": "The string to parse. If or empty, the returned tag encodes zero." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.tag" + ], + "remarks": "", + "returns": "An representing the first four characters of , padded with spaces if shorter." + } + }, + { + "memberType": "Method", + "memberName": "ToString", + "docId": "M:SkiaSharp.SKFourByteTag.ToString", + "signature": "public override string ToString ();", + "fields": { + "summary": "Returns the string representation of this tag as four ASCII characters.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A four-character string decoded from the packed tag value." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKFourByteTag.xml" +} diff --git a/output/docs-work/SkiaSharp__SKPaint.json b/output/docs-work/SkiaSharp__SKPaint.json new file mode 100644 index 00000000..17df5254 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPaint.json @@ -0,0 +1,152 @@ +{ + "typeName": "SkiaSharp.SKPaint", + "entries": [ + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "dst": "The path builder that receives the filled geometry." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKMatrix)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKMatrix matrix);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint and the specified matrix, and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "dst": "The path builder that receives the filled geometry.", + "matrix": "The transformation matrix applied before filling." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.matrix" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle, and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "dst": "The path builder that receives the filled geometry.", + "cullRect": "The rectangle used to cull away geometry outside the area of interest." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.cullRect" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,System.Single)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, float resScale);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint at the specified resolution scale, and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "dst": "The path builder that receives the filled geometry.", + "resScale": "The resolution scale factor, used to control the precision of curve approximation." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.resScale" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect,SkiaSharp.SKMatrix)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect, SkiaSharp.SKMatrix matrix);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle and transformed by the specified matrix, and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "matrix": "The transformation matrix applied before filling.", + "dst": "The path builder that receives the filled geometry.", + "cullRect": "The rectangle used to cull away geometry outside the area of interest." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.matrix", + "params.dst", + "params.cullRect" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect,System.Single)", + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect, float resScale);", + "fields": { + "summary": "Computes the filled path that would result from drawing the source path with this paint, clipped to the cull rectangle at the specified resolution scale, and writes it into the destination builder.", + "params": { + "src": "The source path to fill.", + "dst": "The path builder that receives the filled geometry.", + "resScale": "The resolution scale factor, used to control the precision of curve approximation.", + "cullRect": "The rectangle used to cull away geometry outside the area of interest." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.resScale", + "params.cullRect" + ], + "remarks": "", + "returns": " if the fill path was computed successfully; otherwise, ." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKPaint.xml" +} diff --git a/output/docs-work/SkiaSharp__SKPath.json b/output/docs-work/SkiaSharp__SKPath.json new file mode 100644 index 00000000..8acbb61b --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPath.json @@ -0,0 +1,22 @@ +{ + "typeName": "SkiaSharp.SKPath", + "entries": [ + { + "memberType": "Property", + "memberName": "Handle", + "docId": "P:SkiaSharp.SKPath.Handle", + "signature": "public override IntPtr Handle { get; protected set; }", + "fields": { + "summary": "Gets or sets the native handle for this path object.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The native handle used internally to communicate with the Skia library.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKPath.xml" +} diff --git a/output/docs-work/SkiaSharp__SKPathBuilder.json b/output/docs-work/SkiaSharp__SKPathBuilder.json new file mode 100644 index 00000000..509c563f --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPathBuilder.json @@ -0,0 +1,1077 @@ +{ + "typeName": "SkiaSharp.SKPathBuilder", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "A mutable builder for constructing objects incrementally.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": "\nto obtain an immutable `SKPath` snapshot, or\n to take ownership of the built path and\nreset the builder in one step.\n\nThis type wraps a native Skia resource and implements `IDisposable`. Always\ndispose of it when done, either with a `using` statement or by calling\n`Dispose()` directly.\n\n## Examples\n\n```csharp\nusing var builder = new SKPathBuilder();\nbuilder.MoveTo(10, 10);\nbuilder.LineTo(100, 10);\nbuilder.LineTo(100, 100);\nbuilder.Close();\n\nusing var path = builder.Detach();\ncanvas.DrawPath(path, paint);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Constructor", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKPathBuilder.#ctor", + "signature": "public SKPathBuilder ();", + "fields": { + "summary": "Initializes a new instance of the class.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + }, + { + "memberType": "Constructor", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKPathBuilder.#ctor(SkiaSharp.SKPath)", + "signature": "public SKPathBuilder (SkiaSharp.SKPath path);", + "fields": { + "summary": "Initializes a new instance of the class as a copy of the specified path.", + "params": { + "path": "The path whose geometry is copied into this builder." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.path" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddArc", + "docId": "M:SkiaSharp.SKPathBuilder.AddArc(SkiaSharp.SKRect,System.Single,System.Single)", + "signature": "public void AddArc (SkiaSharp.SKRect oval, float startAngle, float sweepAngle);", + "fields": { + "summary": "Appends an arc of the specified oval to this path.", + "params": { + "oval": "The bounding rectangle of the oval.", + "startAngle": "The angle in degrees at which the arc starts.", + "sweepAngle": "The sweep angle in degrees; positive sweeps clockwise." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.oval", + "params.startAngle", + "params.sweepAngle" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddCircle", + "docId": "M:SkiaSharp.SKPathBuilder.AddCircle(System.Single,System.Single,System.Single,SkiaSharp.SKPathDirection)", + "signature": "public void AddCircle (float x, float y, float radius, SkiaSharp.SKPathDirection dir = SkiaSharp.SKPathDirection.Clockwise);", + "fields": { + "summary": "Appends a circle contour to this path.", + "params": { + "x": "The x-coordinate of the center.", + "radius": "The radius of the circle.", + "dir": "The direction in which to wind the circle contour.", + "y": "The y-coordinate of the center." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x", + "params.radius", + "params.dir", + "params.y" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddOval", + "docId": "M:SkiaSharp.SKPathBuilder.AddOval(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)", + "signature": "public void AddOval (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "fields": { + "summary": "Appends an oval contour fitting the specified rectangle to this path.", + "params": { + "rect": "The bounding rectangle of the oval.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.rect", + "params.direction" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,SkiaSharp.SKPathAddMode)", + "signature": "public void AddPath (SkiaSharp.SKPath other, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "fields": { + "summary": "Appends all contours from the specified path to this path using the given add mode.", + "params": { + "other": "The path whose contours are appended.", + "mode": "One of the enumeration values that specifies how the path is appended." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.other", + "params.mode" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,SkiaSharp.SKMatrix@,SkiaSharp.SKPathAddMode)", + "signature": "public void AddPath (SkiaSharp.SKPath other, in SkiaSharp.SKMatrix matrix, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "fields": { + "summary": "Appends all contours from the specified path, transformed by the given matrix, to this path.", + "params": { + "mode": "One of the enumeration values that specifies how the path is appended.", + "other": "The path whose contours are appended.", + "matrix": "The transformation applied to the appended contours." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.mode", + "params.other", + "params.matrix" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPathAddMode)", + "signature": "public void AddPath (SkiaSharp.SKPath other, float dx, float dy, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "fields": { + "summary": "Appends all contours from the specified path, translated by the given offset, to this path.", + "params": { + "dy": "The vertical translation applied to the appended contours.", + "mode": "One of the enumeration values that specifies how the path is appended.", + "other": "The path whose contours are appended.", + "dx": "The horizontal translation applied to the appended contours." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dy", + "params.mode", + "params.other", + "params.dx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddPoly", + "docId": "M:SkiaSharp.SKPathBuilder.AddPoly(SkiaSharp.SKPoint[],System.Boolean)", + "signature": "public void AddPoly (SkiaSharp.SKPoint[] points, bool close = true);", + "fields": { + "summary": "Appends a polygon contour from an array of points to this path.", + "params": { + "points": "The vertices of the polygon.", + "close": " to automatically close the contour; otherwise, ." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.points", + "params.close" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddPoly", + "docId": "M:SkiaSharp.SKPathBuilder.AddPoly(System.ReadOnlySpan{SkiaSharp.SKPoint},System.Boolean)", + "signature": "public void AddPoly (ReadOnlySpan points, bool close = true);", + "fields": { + "summary": "Appends a polygon contour from a span of points to this path.", + "params": { + "points": "The vertices of the polygon.", + "close": " to automatically close the contour; otherwise, ." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.points", + "params.close" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)", + "signature": "public void AddRect (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "fields": { + "summary": "Appends a closed rectangle contour to this path.", + "params": { + "rect": "The rectangle to add.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.rect", + "params.direction" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection,System.UInt32)", + "signature": "public void AddRect (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction, uint startIndex);", + "fields": { + "summary": "Appends a closed rectangle contour to this path, starting at the specified corner index.", + "params": { + "rect": "The rectangle to add.", + "startIndex": "The zero-based index (0–3) of the corner at which to start the contour.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.rect", + "params.startIndex", + "params.direction" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection)", + "signature": "public void AddRoundRect (SkiaSharp.SKRoundRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "fields": { + "summary": "Appends a closed rounded-rectangle contour to this path.", + "params": { + "rect": "The rounded rectangle to add.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.rect", + "params.direction" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection,System.UInt32)", + "signature": "public void AddRoundRect (SkiaSharp.SKRoundRect rect, SkiaSharp.SKPathDirection direction, uint startIndex);", + "fields": { + "summary": "Appends a closed rounded-rectangle contour to this path, starting at the specified corner index.", + "params": { + "rect": "The rounded rectangle to add.", + "startIndex": "The zero-based starting corner index for the contour.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.rect", + "params.startIndex", + "params.direction" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRect,System.Single,System.Single,SkiaSharp.SKPathDirection)", + "signature": "public void AddRoundRect (SkiaSharp.SKRect rect, float rx, float ry, SkiaSharp.SKPathDirection dir = SkiaSharp.SKPathDirection.Clockwise);", + "fields": { + "summary": "Appends a closed rounded-rectangle contour with the specified corner radii to this path.", + "params": { + "ry": "The vertical radius of the rounded corners.", + "rect": "The bounding rectangle of the rounded rectangle.", + "dir": "One of the enumeration values that specifies the winding direction of the contour.", + "rx": "The horizontal radius of the rounded corners." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.ry", + "params.rect", + "params.dir", + "params.rx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "signature": "public void ArcTo (SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2, float radius);", + "fields": { + "summary": "Appends an arc to this path using two tangent points and a radius.", + "params": { + "radius": "The radius of the arc.", + "point1": "The first tangent point.", + "point2": "The second tangent point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.radius", + "params.point1", + "params.point2" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKRect,System.Single,System.Single,System.Boolean)", + "signature": "public void ArcTo (SkiaSharp.SKRect oval, float startAngle, float sweepAngle, bool forceMoveTo);", + "fields": { + "summary": "Appends an arc of the specified oval to this path.", + "params": { + "oval": "The bounding rectangle of the oval.", + "startAngle": "The angle in degrees at which the arc starts.", + "sweepAngle": "The sweep angle in degrees.", + "forceMoveTo": " to begin a new contour with a move-to; otherwise, to append to the current contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.oval", + "params.startAngle", + "params.sweepAngle", + "params.forceMoveTo" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)", + "signature": "public void ArcTo (SkiaSharp.SKPoint r, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, SkiaSharp.SKPoint xy);", + "fields": { + "summary": "Appends an SVG-style arc to this path using radii, rotation, size, sweep, and endpoint.", + "params": { + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "r": "The radii of the ellipse as (rx, ry).", + "sweep": "One of the enumeration values that specifies the sweep direction.", + "xy": "The endpoint of the arc.", + "xAxisRotate": "The rotation angle of the ellipse x-axis in degrees." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.largeArc", + "params.r", + "params.sweep", + "params.xy", + "params.xAxisRotate" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "signature": "public void ArcTo (float x1, float y1, float x2, float y2, float radius);", + "fields": { + "summary": "Appends an arc to this path using two tangent points specified as scalar coordinates and a radius.", + "params": { + "y2": "The y-coordinate of the second tangent point.", + "x1": "The x-coordinate of the first tangent point.", + "radius": "The radius of the arc.", + "x2": "The x-coordinate of the second tangent point.", + "y1": "The y-coordinate of the first tangent point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.y2", + "params.x1", + "params.radius", + "params.x2", + "params.y1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)", + "signature": "public void ArcTo (float rx, float ry, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, float x, float y);", + "fields": { + "summary": "Appends an SVG-style arc to this path using scalar radii, rotation, size, sweep, and endpoint.", + "params": { + "xAxisRotate": "The rotation angle of the ellipse x-axis in degrees.", + "sweep": "One of the enumeration values that specifies the sweep direction.", + "ry": "The y-radius of the ellipse.", + "y": "The y-coordinate of the arc endpoint.", + "x": "The x-coordinate of the arc endpoint.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "rx": "The x-radius of the ellipse." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.xAxisRotate", + "params.sweep", + "params.ry", + "params.y", + "params.x", + "params.largeArc", + "params.rx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Close", + "docId": "M:SkiaSharp.SKPathBuilder.Close", + "signature": "public void Close ();", + "fields": { + "summary": "Closes the current contour by appending a line from the current point to the last move-to point.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.ConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "signature": "public void ConicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, float w);", + "fields": { + "summary": "Appends a weighted quadratic Bézier (conic) segment to the current contour.", + "params": { + "point0": "The control point.", + "point1": "The endpoint.", + "w": "The conic weight controlling how closely the curve follows the control point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1", + "params.w" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.ConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "signature": "public void ConicTo (float x0, float y0, float x1, float y1, float w);", + "fields": { + "summary": "Appends a weighted quadratic Bézier (conic) segment to the current contour using scalar coordinates.", + "params": { + "x1": "The x-coordinate of the endpoint.", + "y0": "The y-coordinate of the control point.", + "x0": "The x-coordinate of the control point.", + "y1": "The y-coordinate of the endpoint.", + "w": "The conic weight." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x1", + "params.y0", + "params.x0", + "params.y1", + "params.w" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "CubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.CubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "signature": "public void CubicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2);", + "fields": { + "summary": "Appends a cubic Bézier segment to the current contour.", + "params": { + "point0": "The first control point.", + "point1": "The second control point.", + "point2": "The endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1", + "params.point2" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "CubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.CubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)", + "signature": "public void CubicTo (float x0, float y0, float x1, float y1, float x2, float y2);", + "fields": { + "summary": "Appends a cubic Bézier segment to the current contour using scalar coordinates.", + "params": { + "x0": "The x-coordinate of the first control point.", + "y2": "The y-coordinate of the endpoint.", + "x2": "The x-coordinate of the endpoint.", + "x1": "The x-coordinate of the second control point.", + "y1": "The y-coordinate of the second control point.", + "y0": "The y-coordinate of the first control point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x0", + "params.y2", + "params.x2", + "params.x1", + "params.y1", + "params.y0" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Detach", + "docId": "M:SkiaSharp.SKPathBuilder.Detach", + "signature": "public SkiaSharp.SKPath Detach ();", + "fields": { + "summary": "Finalizes the path and transfers ownership to the caller, resetting this builder.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A new containing all contours built so far." + } + }, + { + "memberType": "Method", + "memberName": "Dispose", + "docId": "M:SkiaSharp.SKPathBuilder.Dispose(System.Boolean)", + "signature": "protected override void Dispose (bool disposing);", + "fields": { + "summary": "Releases the resources used by the current instance of the class.", + "params": { + "disposing": " to release both managed and unmanaged resources; to release only unmanaged resources." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.disposing" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "DisposeNative", + "docId": "M:SkiaSharp.SKPathBuilder.DisposeNative", + "signature": "protected override void DisposeNative ();", + "fields": { + "summary": "Releases the native Skia path builder resources held by this instance.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "FillType", + "docId": "P:SkiaSharp.SKPathBuilder.FillType", + "signature": "public SkiaSharp.SKPathFillType FillType { get; set; }", + "fields": { + "summary": "Gets or sets the fill type that determines how overlapping contours are filled.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "One of the values.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "LineTo", + "docId": "M:SkiaSharp.SKPathBuilder.LineTo(SkiaSharp.SKPoint)", + "signature": "public void LineTo (SkiaSharp.SKPoint point);", + "fields": { + "summary": "Appends a straight-line segment from the current point to the specified point.", + "params": { + "point": "The endpoint of the line segment." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "LineTo", + "docId": "M:SkiaSharp.SKPathBuilder.LineTo(System.Single,System.Single)", + "signature": "public void LineTo (float x, float y);", + "fields": { + "summary": "Appends a straight-line segment from the current point to the specified coordinates.", + "params": { + "x": "The x-coordinate of the endpoint.", + "y": "The y-coordinate of the endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x", + "params.y" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "MoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.MoveTo(SkiaSharp.SKPoint)", + "signature": "public void MoveTo (SkiaSharp.SKPoint point);", + "fields": { + "summary": "Begins a new contour at the specified point.", + "params": { + "point": "The starting point of the new contour." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "MoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.MoveTo(System.Single,System.Single)", + "signature": "public void MoveTo (float x, float y);", + "fields": { + "summary": "Begins a new contour at the specified coordinates.", + "params": { + "x": "The x-coordinate of the starting point.", + "y": "The y-coordinate of the starting point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x", + "params.y" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "QuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.QuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "signature": "public void QuadTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1);", + "fields": { + "summary": "Appends a quadratic Bézier segment to the current contour.", + "params": { + "point0": "The control point.", + "point1": "The endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "QuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.QuadTo(System.Single,System.Single,System.Single,System.Single)", + "signature": "public void QuadTo (float x0, float y0, float x1, float y1);", + "fields": { + "summary": "Appends a quadratic Bézier segment to the current contour using scalar coordinates.", + "params": { + "x1": "The x-coordinate of the endpoint.", + "y0": "The y-coordinate of the control point.", + "x0": "The x-coordinate of the control point.", + "y1": "The y-coordinate of the endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x1", + "params.y0", + "params.x0", + "params.y1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.RArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)", + "signature": "public void RArcTo (SkiaSharp.SKPoint r, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, SkiaSharp.SKPoint xy);", + "fields": { + "summary": "Appends a relative SVG-style arc to this path using radii, rotation, size, sweep, and endpoint offset.", + "params": { + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "r": "The radii of the ellipse as (rx, ry).", + "sweep": "One of the enumeration values that specifies the sweep direction.", + "xy": "The relative endpoint offset of the arc.", + "xAxisRotate": "The rotation angle of the ellipse x-axis in degrees." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.largeArc", + "params.r", + "params.sweep", + "params.xy", + "params.xAxisRotate" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.RArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)", + "signature": "public void RArcTo (float rx, float ry, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, float x, float y);", + "fields": { + "summary": "Appends a relative SVG-style arc to this path using scalar radii, rotation, size, sweep, and endpoint offset.", + "params": { + "xAxisRotate": "The rotation angle of the ellipse x-axis in degrees.", + "sweep": "One of the enumeration values that specifies the sweep direction.", + "ry": "The y-radius of the ellipse.", + "y": "The relative y-offset of the arc endpoint.", + "x": "The relative x-offset of the arc endpoint.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "rx": "The x-radius of the ellipse." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.xAxisRotate", + "params.sweep", + "params.ry", + "params.y", + "params.x", + "params.largeArc", + "params.rx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "signature": "public void RConicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, float w);", + "fields": { + "summary": "Appends a conic segment to the current contour using relative point offsets.", + "params": { + "point0": "The relative control point offset from the current point.", + "point1": "The relative endpoint offset from the current point.", + "w": "The conic weight." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1", + "params.w" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "signature": "public void RConicTo (float dx0, float dy0, float dx1, float dy1, float w);", + "fields": { + "summary": "Appends a conic segment to the current contour using scalar relative offsets.", + "params": { + "dy0": "The relative y-offset of the control point.", + "dy1": "The relative y-offset of the endpoint.", + "dx0": "The relative x-offset of the control point.", + "dx1": "The relative x-offset of the endpoint.", + "w": "The conic weight." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dy0", + "params.dy1", + "params.dx0", + "params.dx1", + "params.w" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RCubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RCubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "signature": "public void RCubicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2);", + "fields": { + "summary": "Appends a cubic Bézier segment to the current contour using relative point offsets.", + "params": { + "point0": "The relative first control point offset.", + "point1": "The relative second control point offset.", + "point2": "The relative endpoint offset." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1", + "params.point2" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RCubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RCubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)", + "signature": "public void RCubicTo (float dx0, float dy0, float dx1, float dy1, float dx2, float dy2);", + "fields": { + "summary": "Appends a cubic Bézier segment to the current contour using scalar relative offsets.", + "params": { + "dx2": "The relative x-offset of the endpoint.", + "dy2": "The relative y-offset of the endpoint.", + "dx1": "The relative x-offset of the second control point.", + "dx0": "The relative x-offset of the first control point.", + "dy1": "The relative y-offset of the second control point.", + "dy0": "The relative y-offset of the first control point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dx2", + "params.dy2", + "params.dx1", + "params.dx0", + "params.dy1", + "params.dy0" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Reset", + "docId": "M:SkiaSharp.SKPathBuilder.Reset", + "signature": "public void Reset ();", + "fields": { + "summary": "Removes all contours and resets this builder to an empty state.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "ReverseAddPath", + "docId": "M:SkiaSharp.SKPathBuilder.ReverseAddPath(SkiaSharp.SKPath)", + "signature": "public void ReverseAddPath (SkiaSharp.SKPath other);", + "fields": { + "summary": "Appends all contours from the specified path to this path in reverse order.", + "params": { + "other": "The path whose contours are appended in reverse." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.other" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RLineTo", + "docId": "M:SkiaSharp.SKPathBuilder.RLineTo(SkiaSharp.SKPoint)", + "signature": "public void RLineTo (SkiaSharp.SKPoint point);", + "fields": { + "summary": "Appends a line segment using a relative endpoint offset from the current point.", + "params": { + "point": "The relative offset of the endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RLineTo", + "docId": "M:SkiaSharp.SKPathBuilder.RLineTo(System.Single,System.Single)", + "signature": "public void RLineTo (float dx, float dy);", + "fields": { + "summary": "Appends a line segment using scalar relative offsets from the current point.", + "params": { + "dy": "The relative y-offset of the endpoint.", + "dx": "The relative x-offset of the endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dy", + "params.dx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RMoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.RMoveTo(SkiaSharp.SKPoint)", + "signature": "public void RMoveTo (SkiaSharp.SKPoint point);", + "fields": { + "summary": "Begins a new contour at a point offset relative to the current point.", + "params": { + "point": "The relative offset from the current point." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RMoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.RMoveTo(System.Single,System.Single)", + "signature": "public void RMoveTo (float dx, float dy);", + "fields": { + "summary": "Begins a new contour at scalar offsets relative to the current point.", + "params": { + "dy": "The relative y-offset.", + "dx": "The relative x-offset." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dy", + "params.dx" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RQuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.RQuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "signature": "public void RQuadTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1);", + "fields": { + "summary": "Appends a quadratic Bézier segment to the current contour using relative point offsets.", + "params": { + "point0": "The relative control point offset.", + "point1": "The relative endpoint offset." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.point0", + "params.point1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "RQuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.RQuadTo(System.Single,System.Single,System.Single,System.Single)", + "signature": "public void RQuadTo (float dx0, float dy0, float dx1, float dy1);", + "fields": { + "summary": "Appends a quadratic Bézier segment to the current contour using scalar relative offsets.", + "params": { + "dy0": "The relative y-offset of the control point.", + "dy1": "The relative y-offset of the endpoint.", + "dx0": "The relative x-offset of the control point.", + "dx1": "The relative x-offset of the endpoint." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.dy0", + "params.dy1", + "params.dx0", + "params.dx1" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Snapshot", + "docId": "M:SkiaSharp.SKPathBuilder.Snapshot", + "signature": "public SkiaSharp.SKPath Snapshot ();", + "fields": { + "summary": "Creates an immutable snapshot of the path built so far without resetting this builder.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "A new containing all contours built so far." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKPathBuilder.xml" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp__SKPathMeasure.json b/output/docs-work/SkiaSharp__SKPathMeasure.json new file mode 100644 index 00000000..9cbb831c --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPathMeasure.json @@ -0,0 +1,32 @@ +{ + "typeName": "SkiaSharp.SKPathMeasure", + "entries": [ + { + "memberType": "Method", + "memberName": "GetSegment", + "docId": "M:SkiaSharp.SKPathMeasure.GetSegment(System.Single,System.Single,SkiaSharp.SKPathBuilder,System.Boolean)", + "signature": "public bool GetSegment (float start, float stop, SkiaSharp.SKPathBuilder dst, bool startWithMoveTo);", + "fields": { + "summary": "Extracts the segment of the path between the specified start and stop distances and appends it to the destination builder.", + "params": { + "startWithMoveTo": " to prepend a move-to at the start of the segment; otherwise, .", + "start": "The distance along the path at which the segment begins.", + "stop": "The distance along the path at which the segment ends.", + "dst": "The path builder that receives the extracted segment." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.startWithMoveTo", + "params.start", + "params.stop", + "params.dst" + ], + "remarks": "", + "returns": " if the segment was successfully extracted; otherwise, ." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKPathMeasure.xml" +} diff --git a/output/docs-work/SkiaSharp__SKStream.json b/output/docs-work/SkiaSharp__SKStream.json new file mode 100644 index 00000000..d7798a6b --- /dev/null +++ b/output/docs-work/SkiaSharp__SKStream.json @@ -0,0 +1,22 @@ +{ + "typeName": "SkiaSharp.SKStream", + "entries": [ + { + "memberType": "Method", + "memberName": "GetData", + "docId": "M:SkiaSharp.SKStream.GetData", + "signature": "public SkiaSharp.SKData GetData ();", + "fields": { + "summary": "Returns the entire contents of this stream as an object.", + "remarks": "", + "_extractedKeys": [ + "summary", + "remarks", + "returns" + ], + "returns": "An containing the stream's data, or if the data could not be retrieved." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKStream.xml" +} diff --git a/output/docs-work/SkiaSharp__SKSurface.json b/output/docs-work/SkiaSharp__SKSurface.json new file mode 100644 index 00000000..fab14a76 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKSurface.json @@ -0,0 +1,56 @@ +{ + "typeName": "SkiaSharp.SKSurface", + "entries": [ + { + "memberType": "Method", + "memberName": "Draw", + "docId": "M:SkiaSharp.SKSurface.Draw(SkiaSharp.SKCanvas,SkiaSharp.SKPoint,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "signature": "public void Draw (SkiaSharp.SKCanvas canvas, SkiaSharp.SKPoint p, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "fields": { + "summary": "Draws this surface's contents onto the specified canvas at the given point, using the specified sampling options.", + "params": { + "canvas": "The canvas on which to draw.", + "paint": "The paint to apply, or to draw with default settings.", + "sampling": "The sampling options that control how pixels are filtered when drawing.", + "p": "The point at which the top-left corner of the surface is placed on the canvas." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.canvas", + "params.paint", + "params.sampling", + "params.p" + ], + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "Draw", + "docId": "M:SkiaSharp.SKSurface.Draw(SkiaSharp.SKCanvas,System.Single,System.Single,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "signature": "public void Draw (SkiaSharp.SKCanvas canvas, float x, float y, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "fields": { + "summary": "Draws this surface's contents onto the specified canvas at the given coordinates, using the specified sampling options.", + "params": { + "x": "The x-coordinate at which the top-left corner of the surface is placed on the canvas.", + "canvas": "The canvas on which to draw.", + "paint": "The paint to apply, or to draw with default settings.", + "sampling": "The sampling options that control how pixels are filtered when drawing.", + "y": "The y-coordinate at which the top-left corner of the surface is placed on the canvas." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.x", + "params.canvas", + "params.paint", + "params.sampling", + "params.y" + ], + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKSurface.xml" +} diff --git a/output/docs-work/SkiaSharp__SKTypeface.json b/output/docs-work/SkiaSharp__SKTypeface.json new file mode 100644 index 00000000..d19c42f6 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKTypeface.json @@ -0,0 +1,202 @@ +{ + "typeName": "SkiaSharp.SKTypeface", + "entries": [ + { + "memberType": "Method", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(SkiaSharp.SKFontArguments)", + "signature": "public SkiaSharp.SKTypeface Clone (SkiaSharp.SKFontArguments args);", + "fields": { + "summary": "Creates a new typeface derived from this one with the specified font arguments applied.", + "params": { + "args": "The arguments specifying variation axis positions, palette index, and palette color overrides." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.args" + ], + "remarks": "", + "returns": "A new with the specified customizations applied." + } + }, + { + "memberType": "Method", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(System.Int32)", + "signature": "public SkiaSharp.SKTypeface Clone (int paletteIndex);", + "fields": { + "summary": "Creates a new typeface derived from this one using the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette from the font's CPAL table." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.paletteIndex" + ], + "remarks": "", + "returns": "A new that uses the specified color palette." + } + }, + { + "memberType": "Method", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(System.ReadOnlySpan{SkiaSharp.SKFontVariationPositionCoordinate})", + "signature": "public SkiaSharp.SKTypeface Clone (ReadOnlySpan position);", + "fields": { + "summary": "Creates a new typeface derived from this one with the specified variation axis coordinates.", + "params": { + "position": "The variation axis design-space coordinates to apply." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.position" + ], + "remarks": "", + "returns": "A new with the given variation coordinates applied." + } + }, + { + "memberType": "Property", + "memberName": "Empty", + "docId": "P:SkiaSharp.SKTypeface.Empty", + "signature": "public static SkiaSharp.SKTypeface Empty { get; }", + "fields": { + "summary": "Gets a shared empty typeface instance that contains no glyphs.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "A singleton with no glyph data.", + "remarks": "" + } + }, + { + "memberType": "Method", + "memberName": "GetVariationDesignParameters", + "docId": "M:SkiaSharp.SKTypeface.GetVariationDesignParameters(System.Span{SkiaSharp.SKFontVariationAxis})", + "signature": "public int GetVariationDesignParameters (Span axes);", + "fields": { + "summary": "Fills the provided span with information about this typeface's variation axes.", + "params": { + "axes": "The span to fill with variation axis descriptors." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.axes" + ], + "remarks": "", + "returns": "The number of axis entries written into ." + } + }, + { + "memberType": "Method", + "memberName": "GetVariationDesignPosition", + "docId": "M:SkiaSharp.SKTypeface.GetVariationDesignPosition(System.Span{SkiaSharp.SKFontVariationPositionCoordinate})", + "signature": "public int GetVariationDesignPosition (Span coordinates);", + "fields": { + "summary": "Fills the provided span with the current variation axis coordinates for this typeface.", + "params": { + "coordinates": "The span to fill with axis tag-value pairs." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.coordinates" + ], + "remarks": "", + "returns": "The number of coordinates written into ." + } + }, + { + "memberType": "Property", + "memberName": "IsEmpty", + "docId": "P:SkiaSharp.SKTypeface.IsEmpty", + "signature": "public bool IsEmpty { get; }", + "fields": { + "summary": "Gets a value indicating whether this typeface contains no glyphs.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": " if the typeface has a glyph count of zero; otherwise, .", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationDesignParameterCount", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignParameterCount", + "signature": "public int VariationDesignParameterCount { get; }", + "fields": { + "summary": "Gets the number of variation axes defined for this typeface.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The total number of variation axes available in the font.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationDesignParameters", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignParameters", + "signature": "public SkiaSharp.SKFontVariationAxis[] VariationDesignParameters { get; }", + "fields": { + "summary": "Gets an array of descriptors for all variation axes defined for this typeface.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "An array of structs, one per axis, or an empty array if the font is not variable.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationDesignPosition", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignPosition", + "signature": "public SkiaSharp.SKFontVariationPositionCoordinate[] VariationDesignPosition { get; }", + "fields": { + "summary": "Gets an array of the current variation axis coordinates for this typeface.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "An array of values, or an empty array if no variation coordinates are set.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "VariationDesignPositionCount", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignPositionCount", + "signature": "public int VariationDesignPositionCount { get; }", + "fields": { + "summary": "Gets the number of variation axis coordinates currently set for this typeface.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The count of variation axis coordinates available via .", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKTypeface.xml" +} diff --git a/output/docs-work/SkiaSharp__SKWebpEncoder.json b/output/docs-work/SkiaSharp__SKWebpEncoder.json new file mode 100644 index 00000000..dd9e2c83 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKWebpEncoder.json @@ -0,0 +1,159 @@ +{ + "typeName": "SkiaSharp.SKWebpEncoder", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Provides static methods for encoding images and animated sequences to the WebP format.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " to WebP using an\n configuration. Both lossy and lossless\nencoding are supported through the options struct. Animated WebP sequences can\nbe created by passing a span of objects.\n\nThis type has no state and does not require disposal.\n\n## Examples\n\n```csharp\nusing var bitmap = new SKBitmap(200, 200);\nusing var canvas = new SKCanvas(bitmap);\ncanvas.Clear(SKColors.CornflowerBlue);\n\nvar options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80);\nusing var data = SKWebpEncoder.Encode(bitmap.PeekPixels(), options);\nFile.WriteAllBytes(\"output.webp\", data.ToArray());\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Method", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static SkiaSharp.SKData? Encode (SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified pixmap to WebP and returns the result as an object.", + "params": { + "src": "The source pixel data to encode.", + "options": "The encoding options, including compression type and quality." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.options" + ], + "remarks": "", + "returns": "An containing the WebP-encoded image, or if encoding failed." + } + }, + { + "memberType": "Method", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static bool Encode (SkiaSharp.SKWStream dst, SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified pixmap to WebP and writes the result to the given write stream.", + "params": { + "src": "The source pixel data to encode.", + "dst": "The destination stream that receives the encoded WebP data.", + "options": "The encoding options, including compression type and quality." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.options" + ], + "remarks": "", + "returns": " if encoding succeeded; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(System.IO.Stream,SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static bool Encode (System.IO.Stream dst, SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified pixmap to WebP and writes the result to the given managed stream.", + "params": { + "src": "The source pixel data to encode.", + "dst": "The destination managed stream that receives the encoded WebP data.", + "options": "The encoding options, including compression type and quality." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.src", + "params.dst", + "params.options" + ], + "remarks": "", + "returns": " if encoding succeeded; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static SkiaSharp.SKData? EncodeAnimated (ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified frames as an animated WebP and returns the result as an object.", + "params": { + "options": "The encoding options applied to all frames.", + "frames": "The frames to include in the animated WebP, each with its own duration." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.options", + "params.frames" + ], + "remarks": "", + "returns": "An containing the animated WebP, or if encoding failed." + } + }, + { + "memberType": "Method", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(SkiaSharp.SKWStream,System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static bool EncodeAnimated (SkiaSharp.SKWStream dst, ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified frames as an animated WebP and writes the result to the given write stream.", + "params": { + "dst": "The destination stream that receives the animated WebP data.", + "frames": "The frames to include in the animated WebP, each with its own duration.", + "options": "The encoding options applied to all frames." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.dst", + "params.frames", + "params.options" + ], + "remarks": "", + "returns": " if encoding succeeded; otherwise, ." + } + }, + { + "memberType": "Method", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(System.IO.Stream,System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "signature": "public static bool EncodeAnimated (System.IO.Stream dst, ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "fields": { + "summary": "Encodes the specified frames as an animated WebP and writes the result to the given managed stream.", + "params": { + "dst": "The destination managed stream that receives the animated WebP data.", + "frames": "The frames to include in the animated WebP, each with its own duration.", + "options": "The encoding options applied to all frames." + }, + "_extractedKeys": [ + "summary", + "remarks", + "returns", + "params.dst", + "params.frames", + "params.options" + ], + "remarks": "", + "returns": " if encoding succeeded; otherwise, ." + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKWebpEncoder.xml" +} diff --git a/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json b/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json new file mode 100644 index 00000000..aea96836 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json @@ -0,0 +1,105 @@ +{ + "typeName": "SkiaSharp.SKWebpEncoderFrame", + "entries": [ + { + "memberType": "type", + "fields": { + "summary": "Represents a single frame in an animated WebP sequence, consisting of pixel data and a display duration.", + "_extractedKeys": [ + "summary", + "remarks" + ], + "remarksRequired": true, + "remarks": " with a frame\nduration in milliseconds. Pass a span of frames to\n to produce an animated WebP.\n\nThe struct stores a reference to an `SKPixmap` obtained from the source\nimage. When constructing from an or\n, the pixmap is obtained by calling `PeekPixels()`\non the source object.\n\n## Examples\n\n```csharp\nvar frames = new SKWebpEncoderFrame[]\n{\n new SKWebpEncoderFrame(frame1Pixmap) { Duration = 100 },\n new SKWebpEncoderFrame(frame2Pixmap) { Duration = 100 },\n};\nvar options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 80);\nusing var data = SKWebpEncoder.EncodeAnimated(frames, options);\n```\n]]>" + }, + "docId": null + }, + { + "memberType": "Constructor", + "memberName": "SKWebpEncoderFrame", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKPixmap)", + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKPixmap pixmap);", + "fields": { + "summary": "Initializes a new with the specified pixmap.", + "params": { + "pixmap": "The pixel data for this frame." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.pixmap" + ], + "remarks": "" + } + }, + { + "memberType": "Constructor", + "memberName": "SKWebpEncoderFrame", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKBitmap)", + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKBitmap bitmap);", + "fields": { + "summary": "Initializes a new from the specified bitmap.", + "params": { + "bitmap": "The bitmap whose pixel data is used for this frame." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.bitmap" + ], + "remarks": "" + } + }, + { + "memberType": "Constructor", + "memberName": "SKWebpEncoderFrame", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKImage)", + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKImage image);", + "fields": { + "summary": "Initializes a new from the specified image.", + "params": { + "image": "The image whose pixel data is used for this frame." + }, + "_extractedKeys": [ + "summary", + "remarks", + "params.image" + ], + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "Duration", + "docId": "P:SkiaSharp.SKWebpEncoderFrame.Duration", + "signature": "public int Duration { get; set; }", + "fields": { + "summary": "Gets or sets the display duration of this frame in milliseconds.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The number of milliseconds this frame is displayed before advancing to the next frame.", + "remarks": "" + } + }, + { + "memberType": "Property", + "memberName": "Pixmap", + "docId": "P:SkiaSharp.SKWebpEncoderFrame.Pixmap", + "signature": "public SkiaSharp.SKPixmap Pixmap { get; set; }", + "fields": { + "summary": "Gets or sets the pixel data for this frame.", + "_extractedKeys": [ + "summary", + "value", + "remarks" + ], + "value": "The containing the pixel data for this frame.", + "remarks": "" + } + } + ], + "file": "D:\\a\\SkiaSharp-API-docs\\SkiaSharp-API-docs\\docs\\SkiaSharpAPI\\SkiaSharp\\SKWebpEncoderFrame.xml" +} diff --git a/output/docs-work/manifest.json b/output/docs-work/manifest.json new file mode 100644 index 00000000..32698650 --- /dev/null +++ b/output/docs-work/manifest.json @@ -0,0 +1,164 @@ +[ + { + "typeName": "HarfBuzzSharp.Face", + "entryCount": 21, + "file": "HarfBuzzSharp__Face.json", + "fieldCount": 96 + }, + { + "typeName": "HarfBuzzSharp.Font", + "entryCount": 6, + "file": "HarfBuzzSharp__Font.json", + "fieldCount": 25 + }, + { + "typeName": "SkiaSharp.GRVkYcbcrComponents", + "entryCount": 10, + "file": "SkiaSharp__GRVkYcbcrComponents.json", + "fieldCount": 44 + }, + { + "typeName": "SkiaSharp.GrVkYcbcrConversionInfo", + "entryCount": 3, + "file": "SkiaSharp__GrVkYcbcrConversionInfo.json", + "fieldCount": 12 + }, + { + "typeName": "SkiaSharp.SKCanvas", + "entryCount": 2, + "file": "SkiaSharp__SKCanvas.json", + "fieldCount": 8 + }, + { + "typeName": "SkiaSharp.SKColorSpace", + "entryCount": 1, + "file": "SkiaSharp__SKColorSpace.json", + "fieldCount": 5 + }, + { + "typeName": "SkiaSharp.SKColorspacePrimariesCicp", + "entryCount": 13, + "file": "SkiaSharp__SKColorspacePrimariesCicp.json", + "fieldCount": 28 + }, + { + "typeName": "SkiaSharp.SKColorspaceTransferFnCicp", + "entryCount": 15, + "file": "SkiaSharp__SKColorspaceTransferFnCicp.json", + "fieldCount": 32 + }, + { + "typeName": "SkiaSharp.SKColorType", + "entryCount": 3, + "file": "SkiaSharp__SKColorType.json", + "fieldCount": 6 + }, + { + "typeName": "SkiaSharp.SKDocumentXpsOptions", + "entryCount": 8, + "file": "SkiaSharp__SKDocumentXpsOptions.json", + "fieldCount": 36 + }, + { + "typeName": "SkiaSharp.SKFontArguments", + "entryCount": 5, + "file": "SkiaSharp__SKFontArguments.json", + "fieldCount": 20 + }, + { + "typeName": "SkiaSharp.SKFontPaletteOverride", + "entryCount": 8, + "file": "SkiaSharp__SKFontPaletteOverride.json", + "fieldCount": 36 + }, + { + "typeName": "SkiaSharp.SKFontVariationAxis", + "entryCount": 11, + "file": "SkiaSharp__SKFontVariationAxis.json", + "fieldCount": 48 + }, + { + "typeName": "SkiaSharp.SKFontVariationPositionCoordinate", + "entryCount": 8, + "file": "SkiaSharp__SKFontVariationPositionCoordinate.json", + "fieldCount": 36 + }, + { + "typeName": "SkiaSharp.SKFourByteTag", + "entryCount": 12, + "file": "SkiaSharp__SKFourByteTag.json", + "fieldCount": 55 + }, + { + "typeName": "SkiaSharp.SKPaint", + "entryCount": 6, + "file": "SkiaSharp__SKPaint.json", + "fieldCount": 30 + }, + { + "typeName": "SkiaSharp.SKPath", + "entryCount": 1, + "file": "SkiaSharp__SKPath.json", + "fieldCount": 4 + }, + { + "typeName": "SkiaSharp.SKPathBuilder", + "entryCount": 51, + "file": "SkiaSharp__SKPathBuilder.json", + "fieldCount": 200 + }, + { + "typeName": "SkiaSharp.SKPathMeasure", + "entryCount": 1, + "file": "SkiaSharp__SKPathMeasure.json", + "fieldCount": 5 + }, + { + "typeName": "SkiaSharp.SKStream", + "entryCount": 1, + "file": "SkiaSharp__SKStream.json", + "fieldCount": 4 + }, + { + "typeName": "SkiaSharp.SKSurface", + "entryCount": 2, + "file": "SkiaSharp__SKSurface.json", + "fieldCount": 8 + }, + { + "typeName": "SkiaSharp.SKTypeface", + "entryCount": 11, + "file": "SkiaSharp__SKTypeface.json", + "fieldCount": 49 + }, + { + "typeName": "SkiaSharp.SKWebpEncoder", + "entryCount": 7, + "file": "SkiaSharp__SKWebpEncoder.json", + "fieldCount": 34 + }, + { + "typeName": "SkiaSharp.SKWebpEncoderFrame", + "entryCount": 6, + "file": "SkiaSharp__SKWebpEncoderFrame.json", + "fieldCount": 24 + }, + { + "typeName": "SkiaSharp.Views.Blazor._Imports", + "entryCount": 1, + "file": "SkiaSharp.Views.Blazor___Imports.json", + "fieldCount": 3 + }, + { + "typeName": "SkiaSharp.Views.Gtk.GTKExtensions", + "entryCount": 13, + "file": "SkiaSharp.Views.Gtk__GTKExtensions.json", + "fieldCount": 65 + }, + { + "typeName": "SkiaSharp.Views.Gtk.SKDrawingArea", + "entryCount": 1, + "file": "SkiaSharp.Views.Gtk__SKDrawingArea.json", + "fieldCount": 3 + } +]