diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp.xml index 3fd3eeb0..9e05998b 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp.xml @@ -15,7 +15,6 @@ - @@ -404,21 +403,15 @@ - - - - - - @@ -582,19 +575,14 @@ - - - - - @@ -624,7 +612,6 @@ - @@ -1331,12 +1318,6 @@ - - - - - - @@ -1685,7 +1666,6 @@ - @@ -1702,7 +1682,6 @@ - @@ -1779,8 +1758,6 @@ - - @@ -1794,8 +1771,6 @@ - - @@ -1860,14 +1835,11 @@ - - - @@ -1882,8 +1854,6 @@ - - @@ -2195,33 +2165,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2242,98 +2186,17 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2342,19 +2205,6 @@ - - - - - - - - - - - - - @@ -2437,8 +2287,6 @@ - - @@ -2708,7 +2556,6 @@ - @@ -2869,7 +2716,6 @@ - @@ -3056,9 +2902,7 @@ - - @@ -3114,7 +2958,6 @@ - @@ -3257,8 +3100,6 @@ - - diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index 50b57eb2..073f6d91 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-space coordinates for the specified named instance. + An array of design-space coordinate values for the named instance, one per variation axis. + @@ -190,11 +190,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + A span to receive the design-space coordinate values. + Fills a span with the design-space coordinates for the specified named instance. + The number of design-space coordinates written to . + @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the number of design-space coordinates for the specified named instance. + The number of design-space 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 ID of the PostScript name for the specified named instance. + The of the PostScript name string 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 ID of the subfamily name for the specified named instance. + The of the subfamily name string 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 palette. + Returns the OpenType name ID of the name string for the specified palette color entry. + The of the color-entry name string. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns all color entries for the specified font palette. + An array of values for the palette, in BGRA byte order. + @@ -324,11 +324,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + A span to receive the values. + Fills a span with the color entries for the specified font palette. + The number of color entries written to . + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the flags for the specified font palette. + A bitwise combination of values describing the palette. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the OpenType name ID of the name string for the specified palette. + The of the palette name string. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + A span to receive the values. + Fills a span with information about the font's variation axes. + The number of variation axis infos written to . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains a COLR color-layers table. + if the face 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 the font face contains a PNG color-bitmap table. + if the face contains a CBDT/CBLC PNG color-bitmap table; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains an SVG color table. + if the face contains an SVG color table; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains a CPAL color-palette table. + if the face contains a CPAL color-palette table; otherwise, . + @@ -500,9 +500,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains OpenType variation data. + if the face contains OpenType variation data (fvar table); otherwise, . + @@ -573,9 +573,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of named instances in the font face. + The number of named instances defined in the font's fvar table. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes in the font face. + The number of color palettes defined 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 OpenType tag of the variation axis to find. + When this method returns, contains the axis information if found. This parameter is treated as uninitialized. + Attempts to find information about 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 in the font face. + The number of variation axes defined in the font's fvar table. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets information about all variation axes in the font face. + An array of describing each variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index 6033fbd3..5925a420 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Font.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Font.xml @@ -321,10 +321,10 @@ - To be added. - To be added. - To be added. - To be added. + A span to receive the normalized coordinate values in the range [-16384, 16384]. + Fills a span with the current normalized variation coordinates for this font. + The number of normalized coordinates written to . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + A read-only span of design-space coordinate values, one per variation axis. + Sets the variation coordinates for this font using design-space values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + A read-only span of normalized coordinate values in the range [-16384, 16384], 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 coordinates for this font to those of the specified named instance. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + A read-only span of values specifying the axis tag and design-space value for each axis to set. + Sets the variation coordinates for this font using an array of tag-value pairs. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates for this font. + An array of normalized variation coordinate values in the range [-16384, 16384], one per variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml index 7cb5ad95..6c8c232a 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml @@ -14,9 +14,33 @@ System.IEquatable<HarfBuzzSharp.HBColor> + + + [System.Runtime.CompilerServices.IsReadOnly] + + - To be added. - To be added. + Represents a 32-bit BGRA color value used by HarfBuzz. + @@ -32,9 +56,9 @@ - To be added. - To be added. - To be added. + The raw packed BGRA value to store. + Initializes a new instance of the struct from a raw 32-bit BGRA value. + @@ -53,12 +77,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The red channel value (0–255). + The green channel value (0–255). + The blue channel value (0–255). + The alpha channel value (0–255), where 0 is fully transparent and 255 is fully opaque. + Initializes a new instance of the struct from individual RGBA channel values. + @@ -74,9 +98,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the alpha component of the color. + The alpha channel value in the range [0, 255], where 0 is fully transparent and 255 is fully opaque. + @@ -92,9 +116,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the blue component of the color. + The blue channel value in the range [0, 255]. + @@ -116,10 +140,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this color is equal to another . + if the two colors have the same packed value; otherwise, . + @@ -158,9 +182,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this color. + A hash code for this instance. + @@ -176,9 +200,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the green component of the color. + The green channel value in the range [0, 255]. + @@ -198,11 +222,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and have the same packed value; otherwise, . + @@ -266,11 +290,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and have different packed values; otherwise, . + @@ -286,9 +310,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the red component of the color. + The red channel value in the range [0, 255]. + @@ -305,9 +329,9 @@ - To be added. - To be added. - To be added. + Returns a hexadecimal string representation of this color. + A string in #AARRGGBB hexadecimal format representing this color. + @@ -323,9 +347,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets the underlying packed BGRA value of this color. + The raw packed 32-bit BGRA value of this color. + diff --git a/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml index e6b07184..2996b6f8 100644 --- a/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml @@ -11,8 +11,22 @@ - To be added. - To be added. + Provides extension methods for converting between SkiaSharp and HarfBuzz color types. + , , and . + +## Examples + +Converting an `SKColor` to an `HBColor` and back: + +```csharp +SKColor skColor = SKColors.CornflowerBlue; +HBColor hbColor = skColor.ToHBColor(); +SKColor restored = hbColor.ToSKColor(); +``` +]]> @@ -31,10 +45,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to an . + An representing the same color. + @@ -53,10 +67,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to an . + An representing the same color with each channel quantized to 8 bits. + @@ -75,10 +89,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to an . + An representing the same color. + @@ -97,10 +111,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to an . + An representing the same color with each channel normalized to the range [0, 1]. + @@ -119,10 +133,10 @@ - To be added. - To be added. - To be added. - To be added. + The array of values to convert. + Converts an array of values to an array of values. + An array of values corresponding to each element of . + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml index 43b35a4f..1ca89a84 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml @@ -44,8 +44,8 @@ - To be added. - To be added. + Executes the Blazor component imports. This is an internal infrastructure method used by the Blazor build system. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml b/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml index c01b8480..5218e183 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml @@ -51,9 +51,9 @@ - To be added. - To be added. - To be added. + The OpenTK graphics mode that defines the color, depth, stencil, and accumulation buffer configuration for the control. + Initializes a new instance of the class with the specified graphics mode. + @@ -72,12 +72,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The OpenTK graphics mode that defines the color, depth, stencil, and accumulation buffer configuration. + The major version number of the OpenGL context to create. + The minor version number of the OpenGL context to create. + A bitwise combination of values that control context creation. + Initializes a new instance of the class with the specified graphics mode, OpenGL version, and context flags. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml index fd22bfdc..f3e9e3ce 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -55,10 +55,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same integer bounds. + @@ -75,10 +75,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A representing the same color with each channel normalized to the range [0, 1]. + @@ -95,10 +95,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same floating-point channel values. + @@ -115,10 +115,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same X and Y coordinates. + @@ -135,10 +135,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same X, Y, and Z coordinates. + @@ -155,10 +155,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same bounds. + @@ -175,10 +175,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same width and height. + @@ -395,10 +395,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An representing the same color. + @@ -415,10 +415,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same floating-point channel values. + @@ -480,10 +480,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same X and Y coordinates. + @@ -500,10 +500,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same X, Y, and Z coordinates. + @@ -542,10 +542,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same bounds. + @@ -588,10 +588,10 @@ - To be added. - To be added. - To be added. - To be added. + The 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 24cfa66c..3f71d56f 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml @@ -97,10 +97,9 @@ - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. + to release both managed and native resources; to release only native resources. + Releases the resources used by this . + diff --git a/SkiaSharpAPI/SkiaSharp/GRBackendRenderTarget.xml b/SkiaSharpAPI/SkiaSharp/GRBackendRenderTarget.xml index dfbcc273..84b69e26 100644 --- a/SkiaSharpAPI/SkiaSharp/GRBackendRenderTarget.xml +++ b/SkiaSharpAPI/SkiaSharp/GRBackendRenderTarget.xml @@ -94,35 +94,6 @@ doesn't require this (eg: OpenGL). - - - - - Constructor - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use GRBackendRenderTarget(int width, int height, GRVkImageInfo vkImageInfo) instead.")] - - - - - - - - - - The width of the render target in pixels. - The height of the render target in pixels. - The number of samples per pixel. - The Vulkan image information. - Creates a new Vulkan with the specified properties and image. - - - diff --git a/SkiaSharpAPI/SkiaSharp/GRContext.xml b/SkiaSharpAPI/SkiaSharp/GRContext.xml index cfc5d30a..9a251e7e 100644 --- a/SkiaSharpAPI/SkiaSharp/GRContext.xml +++ b/SkiaSharpAPI/SkiaSharp/GRContext.xml @@ -374,9 +374,9 @@ - To be added. - To be added. - To be added. + The image whose associated GPU work should be flushed. + Flushes any pending GPU drawing work associated with the specified image. + @@ -395,9 +395,9 @@ - To be added. - To be added. - To be added. + The surface whose associated GPU work should be flushed. + Flushes any pending GPU drawing work associated with the specified surface. + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml index de7db9df..717e1920 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,28 @@ - To be added. - To be added. + Describes the component mapping for a Vulkan YCbCr conversion. + . + +Each property stores a `VkComponentSwizzle` value (as a `uint`) indicating which Vulkan image component feeds the corresponding output channel. + +## Examples + +Creating a default component mapping (identity swizzle): + +```csharp +var components = new GRVkYcbcrComponents +{ + R = 0, // VK_COMPONENT_SWIZZLE_IDENTITY + G = 0, + B = 0, + A = 0, +}; +``` +]]> @@ -37,9 +57,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the alpha channel. + A VkComponentSwizzle value indicating the source for the alpha output channel. + @@ -60,9 +80,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the blue channel. + A VkComponentSwizzle value indicating the source for the blue output channel. + @@ -89,10 +109,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this component mapping is equal to another . + if both instances have identical component swizzle values; otherwise, . + @@ -116,10 +136,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether this component mapping is equal to the specified object. + if is a with identical component swizzle values; otherwise, . + @@ -140,9 +160,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the green channel. + A VkComponentSwizzle value indicating the source for the green output channel. + @@ -164,9 +184,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this component mapping. + A hash code for this instance. + @@ -186,11 +206,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -210,11 +230,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + @@ -235,9 +255,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the red channel. + A VkComponentSwizzle value indicating the source for the red output channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml new file mode 100644 index 00000000..3b23c012 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml @@ -0,0 +1,429 @@ + + + + + + SkiaSharp + 4.150.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.GRVkYcbcrConversionInfo> + + + + Describes the parameters for Vulkan YCbCr sampler conversion. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the chroma filter used when reconstructing YCbCr chroma values. + A raw VkFilter value specifying the filter applied when reconstructing chroma. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + SkiaSharp.GRVkYcbcrComponents + + + Gets or sets the component mapping for this YCbCr conversion. + A describing the channel swizzle mapping for this conversion. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The to compare with this instance. + Indicates whether this conversion info is equal to another . + if both instances have identical conversion parameters; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with this instance. + Indicates whether this conversion info is equal to the specified object. + if is a with identical conversion parameters; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt64 + + + Gets or sets the Vulkan external format for this YCbCr conversion. + The Vulkan external format identifier, or 0 if no external format is used. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets whether explicit chroma reconstruction is required. + 1 to require explicit chroma reconstruction; 0 to allow implicit reconstruction. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Vulkan image format for this YCbCr conversion. + A raw VkFormat value identifying the Vulkan image format used by this conversion. + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns a hash code for this conversion info. + A hash code for this instance. + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + System.Boolean + + + + + + + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + System.Boolean + + + + + + + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets whether the sampler filter must match the chroma reconstruction filter. + if the sampler filter must match the chroma filter; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets whether linear filtering is supported for this YCbCr conversion. + if linear filtering is supported for this YCbCr conversion; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the horizontal chroma sample location offset. + A raw VkChromaLocation value for the horizontal chroma sample position. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the YCbCr color model conversion. + A raw VkSamplerYcbcrModelConversion value identifying the YCbCr color model. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the quantization range of the encoded YCbCr values. + A raw VkSamplerYcbcrRange value indicating whether the data uses full or narrow/ITU range. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the vertical chroma sample location offset. + A raw VkChromaLocation value for the vertical chroma sample position. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 2f9c4dc0..6ad508b0 100644 --- a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml @@ -1,7 +1,7 @@ - - - - + + + + SkiaSharp 4.150.0.0 @@ -9,11 +9,12 @@ System.ValueType - - - System.IEquatable<SkiaSharp.GRVkYcbcrConversionInfo> - - + + + + [System.Obsolete("Use GRVkYcbcrConversionInfo instead.")] + + Configuration information for Vulkan YCbCr color space conversion. @@ -22,7 +23,7 @@ - + Property SkiaSharp @@ -37,15 +38,15 @@ System.UInt32 - Gets or sets the chroma filter mode used for upsampling chroma components. - The VkFilter value for chroma filtering. + Gets or sets the chroma filter used when reconstructing YCbCr chroma. + The applied when reconstructing chroma values. - + Property SkiaSharp @@ -65,67 +66,10 @@ To be added. - - - - - Method - - M:System.IEquatable`1.Equals(`0) - - - SkiaSharp - 4.150.0.0 - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - + Property SkiaSharp @@ -140,15 +84,15 @@ System.UInt64 - Gets or sets the external format when using VK_ANDROID_external_memory_android_hardware_buffer. - The external format value, or 0 if not using an external format. + Gets or sets the Vulkan external format for this YCbCr conversion. + The Vulkan external format identifier, or 0 if no external format is used. - + Property SkiaSharp @@ -171,7 +115,7 @@ - + Property SkiaSharp @@ -191,73 +135,71 @@ - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - [System.Runtime.CompilerServices.IsReadOnly] + [System.Obsolete("FormatFeatures is no longer supported in the native API.")] + + + [get: System.Runtime.CompilerServices.IsReadOnly] - System.Int32 + System.UInt32 - - To be added. - To be added. - To be added. + Gets or sets the Vulkan format feature flags. This property is obsolete and no longer supported. + Always returns 0. Setting this property has no effect. + - - - - + + + + Method SkiaSharp 4.150.0.0 - System.Boolean + SkiaSharp.GRVkYcbcrConversionInfo - - + - To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - + + + + Method SkiaSharp 4.150.0.0 - System.Boolean + SkiaSharp.GrVkYcbcrConversionInfo - - + - To be added. - To be added. + To be added. To be added. To be added. To be added. @@ -266,7 +208,7 @@ - + Property SkiaSharp @@ -289,7 +231,7 @@ - + Property SkiaSharp @@ -312,7 +254,7 @@ - + Property SkiaSharp @@ -335,7 +277,7 @@ - + Property SkiaSharp @@ -358,7 +300,7 @@ - + Property SkiaSharp @@ -381,7 +323,7 @@ - + Property SkiaSharp diff --git a/SkiaSharpAPI/SkiaSharp/SKBitmap.xml b/SkiaSharpAPI/SkiaSharp/SKBitmap.xml index 5fc1ce82..29fbdf04 100644 --- a/SkiaSharpAPI/SkiaSharp/SKBitmap.xml +++ b/SkiaSharpAPI/SkiaSharp/SKBitmap.xml @@ -1637,35 +1637,6 @@ The result is a bitmap with zero width and height, and no pixels. Its color type is set to . If we are a (shared) owner of the pixels, that ownership is decremented. - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Resize(SKImageInfo info, SKSamplingOptions sampling) instead.", true)] - - - - SkiaSharp.SKBitmap - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -1690,35 +1661,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Resize(SKSizeI size, SKSamplingOptions sampling) instead.", true)] - - - - SkiaSharp.SKBitmap - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -1761,35 +1703,6 @@ The same as . - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ScalePixels(SKBitmap destination, SKSamplingOptions sampling) instead.", true)] - - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -1814,35 +1727,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ScalePixels(SKPixmap destination, SKSamplingOptions sampling) instead.", true)] - - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -1974,37 +1858,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ToShader(SKShaderTileMode tmx, SKShaderTileMode tmy, SKSamplingOptions sampling) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2057,39 +1910,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ToShader(SKShaderTileMode tmx, SKShaderTileMode tmy, SKSamplingOptions sampling, SKMatrix localMatrix) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index eb3e6d7b..12b636df 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml @@ -1035,12 +1035,12 @@ this information. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bitmap to draw. + The destination rectangle on the canvas. + The sampling options to use when scaling the bitmap. + The paint to apply, or to use default paint settings. + Draws the specified bitmap into the destination rectangle using the given sampling options. + @@ -1095,13 +1095,13 @@ this information. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bitmap to draw. + The source rectangle within the bitmap. + The destination rectangle on the canvas. + The sampling options to use when scaling the bitmap. + The paint to apply, or to use default paint settings. + Draws a portion of the specified bitmap into the destination rectangle using the given sampling options. + @@ -2743,12 +2743,12 @@ contours intersect each other (think ). - To be added. + The surface to draw. To be added. - To be added. - To be added. - To be added. - To be added. + The sampling options to use when drawing the surface. + The paint to apply, or to use default paint settings. + Draws the specified surface onto the canvas at the given point using the given sampling options. + @@ -2798,13 +2798,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The x-coordinate of the destination position on the canvas. + The y-coordinate of the destination position on the canvas. + The sampling options to use when drawing the surface. + The paint to apply, or to use default paint settings. + Draws the specified surface onto the canvas at the given position using the given sampling options. + @@ -2863,36 +2863,6 @@ using (var surface = SKSurface.Create(info)) { - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use DrawText(string text, SKPoint p, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] - - - - System.Void - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2931,7 +2901,7 @@ using (var surface = SKSurface.Create(info)) { - [System.Obsolete("Use DrawText(string text, SKPoint p, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] + [System.Obsolete("Use DrawText(string text, SKPoint p, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", false)] @@ -2944,44 +2914,12 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use DrawText(string text, float x, float y, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] - - - - System.Void - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text string to draw. + The origin point of the text baseline. + The font to use for rendering the text. + The paint to apply when drawing. + Draws the specified text at the given point using the font and paint. + @@ -3004,12 +2942,12 @@ using (var surface = SKSurface.Create(info)) { - The text to draw. - The point at which to draw the text. - The text alignment relative to the point. - The font used to render the text. - The paint used to draw the text. - Draws text at the specified point with alignment. + The text string to draw. + The origin point relative to which the text is aligned. + The horizontal alignment of the text relative to the origin point. + The font to use for rendering the text. + The paint to apply when drawing. + Draws the specified text aligned around the given point using the font and paint. @@ -3024,7 +2962,7 @@ using (var surface = SKSurface.Create(info)) { - [System.Obsolete("Use DrawText(string text, float x, float y, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] + [System.Obsolete("Use DrawText(string text, float x, float y, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", false)] @@ -3038,13 +2976,13 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text string to draw. + The x-coordinate of the text baseline origin. + The y-coordinate of the text baseline origin. + The font to use for rendering the text. + The paint to apply when drawing. + Draws the specified text at the given coordinates using the font and paint. + @@ -3068,48 +3006,16 @@ using (var surface = SKSurface.Create(info)) { - The text to draw. - The x-coordinate of the text origin. - The y-coordinate of the text origin. - The text alignment relative to the coordinates. - The font used to render the text. - The paint used to draw the text. - Draws text at the specified coordinates with alignment. + The text string to draw. + The x-coordinate of the origin relative to which the text is aligned. + The y-coordinate of the origin relative to which the text is aligned. + The horizontal alignment of the text relative to the origin. + The font to use for rendering the text. + The paint to apply when drawing. + Draws the specified text aligned around the given coordinates using the font and paint. - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use DrawTextOnPath(string text, SKPath path, float hOffset, float vOffset, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] - - - - System.Void - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -3144,74 +3050,6 @@ using (var surface = SKSurface.Create(info)) { - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use DrawTextOnPath(string text, SKPath path, SKPoint offset, bool warpGlyphs, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] - - - - System.Void - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use DrawTextOnPath(string text, SKPath path, float hOffset, float vOffset, SKTextAlign textAlign, SKFont font, SKPaint paint) instead.", true)] - - - - System.Void - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -4143,32 +3981,6 @@ guaranteed to happen. If exact clipping is desired, use - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SetMatrix(in SKMatrix) instead.", true)] - - - - System.Void - - - - - - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 0e983c27..1908df20 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -130,7 +130,7 @@ 25 - To be added. + An 8-bytes-per-pixel format storing blue, green, red, and alpha as 10-bit extended-range (XR) values. @@ -198,7 +198,7 @@ 27 - To be added. + A 2-bytes-per-pixel format storing a single red channel as a 16-bit normalized unsigned integer. @@ -232,7 +232,7 @@ 28 - To be added. + A 2-bytes-per-pixel format storing a single red channel as a 16-bit floating-point value. @@ -453,7 +453,7 @@ 26 - To be added. + An 8-bytes-per-pixel format storing red, green, and blue as 16-bit floating-point values, with a 16-bit padding component. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 18faa3f5..9c6b6bd6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,26 @@ System.Enum - To be added. - To be added. + Identifies color primaries using ITU-T H.273 / ISO 23001-8 Coding-Independent Code Points (CICP) values. + to create a CICP-specified color space. + +Each member's numeric value corresponds directly to the "Colour primaries" code point in Table 2 of ITU-T H.273. + +## Examples + +Creating a BT.2020 wide-gamut color space: + +```csharp +using var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq, + SKColorspaceMatrixCoefficients.Identity, + SKColorspaceRange.Full); +``` +]]> @@ -28,7 +46,7 @@ 8 - To be added. + Generic film color primaries (code point 8), based on D65 white point and C-illuminant. @@ -45,7 +63,7 @@ 22 - To be added. + ITU-T H.273 value 22 color primaries (code point 22), intended for EBU Tech 3213-E and related consumer electronics standards. @@ -62,7 +80,7 @@ 9 - To be added. + ITU-R BT.2020 color primaries (code point 9), used for ultra-high-definition television with a wide color gamut. @@ -79,7 +97,7 @@ 5 - To be added. + ITU-R BT.470 System B/G color primaries (code point 5), used for PAL and SECAM analog television. @@ -96,7 +114,7 @@ 4 - To be added. + ITU-R BT.470 System M color primaries (code point 4), used for NTSC analog television. @@ -113,7 +131,7 @@ 6 - To be added. + ITU-R BT.601 color primaries (code point 6), used for standard-definition television. @@ -130,7 +148,7 @@ 1 - To be added. + ITU-R BT.709 color primaries (code point 1), used for HDTV and sRGB. @@ -147,7 +165,7 @@ 12 - To be added. + SMPTE EG 432-1 color primaries (code point 12), defining the Display P3 (P3-D65) gamut used on Apple displays. @@ -164,7 +182,7 @@ 11 - To be added. + SMPTE RP 431-2 color primaries (code point 11), defining the DCI-P3 gamut used in digital cinema. @@ -181,7 +199,7 @@ 7 - To be added. + SMPTE ST 240 color primaries (code point 7), used for early HDTV production. @@ -198,7 +216,7 @@ 10 - To be added. + SMPTE ST 428-1 color primaries (code point 10), using CIE XYZ with a D50 white point. @@ -215,7 +233,7 @@ 0 - To be added. + Unknown or unspecified color primaries (code point 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index 30612a63..a1270090 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,26 @@ System.Enum - To be added. - To be added. + Identifies transfer functions (opto-electronic transfer characteristics) using ITU-T H.273 / ISO 23001-8 Coding-Independent Code Points (CICP) values. + to create a CICP-specified color space. + +Each member's numeric value corresponds directly to the "Transfer characteristics" code point in Table 3 of ITU-T H.273. + +## Examples + +Creating an HDR PQ color space with BT.2020 primaries: + +```csharp +using var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq, + SKColorspaceMatrixCoefficients.Identity, + SKColorspaceRange.Full); +``` +]]> @@ -28,7 +46,7 @@ 18 - To be added. + ARIB STD-B67 Hybrid Log-Gamma (HLG) transfer characteristics (code point 18), used for HDR broadcast per ITU-R BT.2100. @@ -45,7 +63,7 @@ 13 - To be added. + IEC 61966-2-1 transfer characteristics (code point 13), defining the sRGB and sYCC transfer functions. @@ -62,7 +80,7 @@ 11 - To be added. + IEC 61966-2-4 transfer characteristics (code point 11), used for xvYCC extended-gamut video. @@ -79,7 +97,7 @@ 8 - To be added. + Linear transfer characteristics with no gamma encoding (code point 8). @@ -96,7 +114,7 @@ 16 - To be added. + SMPTE ST 2084 Perceptual Quantizer (PQ) transfer characteristics (code point 16), used for HDR10 content. @@ -113,7 +131,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer characteristics (code point 14), used for 10-bit UHD content. @@ -130,7 +148,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer characteristics (code point 15), used for 12-bit UHD content. @@ -147,7 +165,7 @@ 5 - To be added. + ITU-R BT.470 System B/G transfer characteristics (code point 5), assuming a display gamma of 2.8. @@ -164,7 +182,7 @@ 4 - To be added. + ITU-R BT.470 System M transfer characteristics (code point 4), assuming a display gamma of 2.2. @@ -181,7 +199,7 @@ 6 - To be added. + ITU-R BT.601 transfer characteristics (code point 6), used for standard-definition television. @@ -198,7 +216,7 @@ 1 - To be added. + ITU-R BT.709 transfer characteristics (code point 1), used for HDTV; also matches sRGB in practice. @@ -215,7 +233,7 @@ 7 - To be added. + SMPTE ST 240 transfer characteristics (code point 7), used for early HDTV production. @@ -232,7 +250,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer characteristics (code point 17), defining the D-Cinema transfer function with a power-law gamma of approximately 2.6. @@ -249,7 +267,7 @@ 0 - To be added. + Unknown or unspecified transfer characteristics (code point 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocument.xml b/SkiaSharpAPI/SkiaSharp/SKDocument.xml index 857b7278..8d47f1c5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocument.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocument.xml @@ -403,11 +403,11 @@ canvas, and then complete the page with a call to - To be added. + The stream to which the XPS document will be written. To be added. - To be added. - To be added. - To be added. + Creates an XPS document writer that writes to the specified stream using the provided options. + A new for writing XPS content, or if XPS is not supported on the current platform. + @@ -451,11 +451,11 @@ canvas, and then complete the page with a call to - To be added. + The managed stream to which the XPS document will be written. To be added. - To be added. - To be added. - To be added. + Creates an XPS document writer that writes to the specified managed stream using the provided options. + A new for writing XPS content, or if XPS is not supported on the current platform. + @@ -499,11 +499,11 @@ canvas, and then complete the page with a call to - To be added. + The file path to which the XPS document will be written. To be added. - To be added. - To be added. - To be added. + Creates an XPS document writer that writes to the specified file using the provided options. + A new for writing XPS content, or if XPS is not supported on the current platform. + diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index 3803e719..541c9c51 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,28 @@ - To be added. - To be added. + Options for creating an XPS document with . + . Pass an instance of this struct to specify custom DPI or PNG-embedding behavior. + +All fields are zero-initialized by default; a `Dpi` of `0` lets the XPS writer choose its own default resolution. + +## Examples + +Creating an XPS document at 96 DPI: + +```csharp +using var stream = File.OpenWrite("output.xps"); +var opts = new SKDocumentXpsOptions { Dpi = 96f }; +using var doc = SKDocument.CreateXps(stream, opts); +using var page = doc.BeginPage(800, 600); +// ... draw ... +doc.EndPage(); +doc.Close(); +``` +]]> @@ -37,9 +57,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the XPS encoder may omit PNG image data. + to allow the encoder to omit PNG images and substitute alternative representations; otherwise, . + @@ -60,9 +80,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the dots-per-inch resolution of the XPS document. + The target DPI of the XPS document, or 0 to use the encoder's default. + @@ -89,10 +109,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether these options are equal to another . + if both instances have the same DPI and flags; otherwise, . + @@ -116,10 +136,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether these options are equal to the specified object. + if is a with the same values; otherwise, . + @@ -141,9 +161,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for these XPS options. + A hash code for this instance. + @@ -163,11 +183,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -187,11 +207,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 0c8e167e..c88f9d60 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,32 @@ - To be added. - To be added. + Specifies arguments for customizing a typeface clone, including the collection index, color palette, palette overrides, and variation design position. + when creating a customized typeface instance. Because it is a `ref struct`, it cannot be stored on the heap or used across async boundaries. + +Typically you create an instance, set its properties, and pass it directly to `Clone`. + +## Examples + +Cloning a variable font at a specific weight: + +```csharp +using var typeface = SKTypeface.FromFile("variable-font.ttf"); + +var wghtTag = SKFourByteTag.Parse("wght"); +var args = new SKFontArguments +{ + VariationDesignPosition = new[] + { + new SKFontVariationPositionCoordinate { Axis = wghtTag, Value = 700 }, + }, +}; +using var bold = typeface.Clone(args); +``` +]]> @@ -41,9 +65,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the index of the desired typeface within a font collection. + The zero-based index of the typeface within a TTC (TrueType Collection) font file. + @@ -64,9 +88,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the color palette index to use when cloning the typeface. + The zero-based index of the color palette from the font's CPAL table to use. + @@ -87,9 +111,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-entry color overrides to apply to the palette. + A read-only span of values that override specific color entries in the chosen palette. + @@ -110,9 +134,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation design position to apply to the cloned typeface. + A read-only span of values specifying a design-space value for each variation axis. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index a7fd7ef2..b90acd45 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,27 @@ - To be added. - To be added. + Overrides a single color entry in a font color palette. + for a specific zero-based index within the palette selected by . An array of overrides is assigned to before passing the arguments to . + +The `Color` property stores a packed `0xAARRGGBB` value (same format as ). + +## Examples + +Overriding the first palette entry to red: + +```csharp +var overrides = new[] +{ + new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red }, +}; +var args = new SKFontArguments { PaletteOverrides = overrides }; +using var typeface = original.Clone(args); +``` +]]> @@ -37,9 +56,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color for the overridden palette entry. + The replacement color for the palette entry, stored as a packed 0xAARRGGBB value. + @@ -66,10 +85,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this palette override is equal to another . + if both instances have the same index and color; otherwise, . + @@ -93,10 +112,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether this palette override is equal to the specified object. + if is a with the same index and color; otherwise, . + @@ -118,9 +137,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this palette override. + A hash code for this instance. + @@ -141,9 +160,9 @@ System.UInt16 - To be added. - To be added. - To be added. + Gets or sets the index of the palette color entry to override. + The zero-based index of the color entry within the palette to override. + @@ -163,11 +182,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -187,11 +206,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 4984d640..772c3375 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,26 @@ - To be added. - To be added. + Describes a single variation axis defined in a variable font. + and . + +## Examples + +Listing the variation axes of a variable font: + +```csharp +using var typeface = SKTypeface.FromFile("variable-font.ttf"); +foreach (var axis in typeface.VariationDesignParameters) +{ + Console.WriteLine($"{axis.Tag}: [{axis.Min}, {axis.Default}, {axis.Max}] hidden={axis.IsHidden}"); +} +``` +]]> @@ -37,9 +55,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 design-space value for this axis. + @@ -66,10 +84,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this variation axis is equal to another . + if both axes have the same tag, range, and hidden flag; otherwise, . + @@ -93,10 +111,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether this variation axis is equal to the specified object. + if is a with the same values; otherwise, . + @@ -118,9 +136,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this variation axis. + A hash code for this instance. + @@ -141,9 +159,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this variation axis is intended to be hidden from the user. + if this axis should not be presented in a user interface; otherwise, . + @@ -164,9 +182,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum design-space value for this variation axis. + The maximum design-space value for this axis. + @@ -187,9 +205,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum design-space value for this variation axis. + The minimum design-space value for this axis. + @@ -209,11 +227,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -233,11 +251,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + @@ -258,9 +276,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag that identifies this variation axis. + The four-byte OpenType tag identifying this variation axis (for example, wght for weight or wdth for width). + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index 5ce3933c..9cf66acd 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,26 @@ - To be added. - To be added. + Represents a design-space value for a single variation axis. + or to create a variation instance of a variable font. + +Instances are also returned by and . + +## Examples + +Setting the weight axis to bold (700): + +```csharp +var coord = new SKFontVariationPositionCoordinate +{ + Axis = SKFourByteTag.Parse("wght"), + Value = 700f, +}; +``` +]]> @@ -37,9 +55,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag of the variation axis this coordinate applies to. + The four-byte tag identifying the variation axis (for example, wght for weight). + @@ -66,10 +84,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this coordinate is equal to another . + if both coordinates have the same axis tag and value; otherwise, . + @@ -93,10 +111,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether this coordinate is equal to the specified object. + if is a with the same axis tag and value; otherwise, . + @@ -118,9 +136,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this coordinate. + A hash code for this instance. + @@ -140,11 +158,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -164,11 +182,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + @@ -189,9 +207,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for this axis coordinate. + The design-space value for the variation axis identified by . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index b5b7f7fb..e491c6f9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,29 @@ - To be added. - To be added. + Represents a four-byte OpenType tag used to identify tables, axes, and scripts. + @@ -37,9 +58,9 @@ - To be added. - To be added. - To be added. + The raw 32-bit packed tag value. + Initializes a new instance of the struct from a raw 32-bit value. + @@ -58,12 +79,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 +106,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Indicates whether this tag is equal to another . + if both tags have the same packed value; otherwise, . + @@ -112,10 +133,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Indicates whether this tag is equal to the specified object. + if is an with the same packed value; otherwise, . + @@ -132,9 +153,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for this tag. + A hash code for this instance. + @@ -154,11 +175,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are equal. + if and are equal; otherwise, . + @@ -177,10 +198,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Implicitly converts an to its underlying 32-bit unsigned integer value. + The underlying 32-bit packed value of the tag. + @@ -199,10 +220,10 @@ - To be added. - To be added. - To be added. - To be added. + The raw 32-bit packed value to store. + Implicitly converts a 32-bit unsigned integer to an . + An wrapping the specified value. + @@ -222,11 +243,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two values are not equal. + if and are not equal; otherwise, . + @@ -250,10 +271,10 @@ - To be added. - To be added. - To be added. - To be added. + A string of up to four ASCII characters. Shorter strings are padded with spaces on the right; longer strings are truncated. + Parses a string of up to four ASCII characters into an . + An representing the four-byte packed tag. + @@ -275,9 +296,9 @@ - To be added. - To be added. - To be added. + Returns the four-character ASCII string representation of this tag. + A four-character ASCII string representation of this tag. + diff --git a/SkiaSharpAPI/SkiaSharp/SKHorizontalRunBuffer.xml b/SkiaSharpAPI/SkiaSharp/SKHorizontalRunBuffer.xml index e6162c62..c5175c9c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKHorizontalRunBuffer.xml +++ b/SkiaSharpAPI/SkiaSharp/SKHorizontalRunBuffer.xml @@ -15,30 +15,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Positions instead.")] - - - - System.Span<System.Single> - - - - Gets the span of horizontal X positions for each glyph. - A span containing the horizontal positions. - - - diff --git a/SkiaSharpAPI/SkiaSharp/SKImage.xml b/SkiaSharpAPI/SkiaSharp/SKImage.xml index d723f540..06c80e9e 100644 --- a/SkiaSharpAPI/SkiaSharp/SKImage.xml +++ b/SkiaSharpAPI/SkiaSharp/SKImage.xml @@ -2000,35 +2000,6 @@ This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ScalePixels(SKPixmap dst, SKSamplingOptions sampling) instead.", true)] - - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2053,37 +2024,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ScalePixels(SKPixmap dst, SKSamplingOptions sampling, SKImageCachingHint cachingHint) instead.", true)] - - - - System.Boolean - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2363,37 +2303,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ToShader(SKShaderTileMode tileX, SKShaderTileMode tileY, SKSamplingOptions sampling) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2446,39 +2355,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ToShader(SKShaderTileMode tileX, SKShaderTileMode tileY, SKSamplingOptions sampling, SKMatrix localMatrix) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml index b9e91d79..f5b7b60d 100644 --- a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml +++ b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml @@ -1411,39 +1411,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use CreateImage(SKImage, SKRect, SKRect, SKSamplingOptions) instead.", true)] - - - - SkiaSharp.SKImageFilter - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -1602,33 +1569,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SetMatrix(in SKMatrix) instead.", true)] - - - - SkiaSharp.SKImageFilter - - - - - - To be added. - To be added. - To be added. - To be added. - - @@ -1659,43 +1599,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SetMatrix(in SKMatrix, SKSamplingOptions, SKImageFilter) instead.", true)] - - - - SkiaSharp.SKImageFilter - - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -2142,62 +2045,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use CreateShader(SKShader) instead.", true)] - - - - SkiaSharp.SKImageFilter - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use CreateShader(SKShader, bool, SKRect) instead.", true)] - - - - SkiaSharp.SKImageFilter - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml b/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml index eadbc77e..d5188935 100644 --- a/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml +++ b/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml @@ -172,10 +172,10 @@ - To be added. - To be added. - To be added. - To be added. + The shader to use to produce the mask. + Creates a mask filter that uses the specified shader to generate the mask. + A new that uses the shader to generate coverage masks. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 0ffc3a18..a3fbeed4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml @@ -152,29 +152,6 @@ The example above produces the following: - - - - - Constructor - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont instead.", true)] - - - - - - - To be added. - To be added. - To be added. - - @@ -211,188 +188,169 @@ The example above produces the following: - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKPaint - - - - + - To be added. - To be added. - To be added. - To be added. - To be added. + Creates a copy of the current paint. + Returns the copy. + The copy is a shallow copy, all references will still point to the same objects. - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKColor + + + Gets or sets the paint's foreground color. + The paint's foreground color as a 32-bit ARGB value. + The color is a 32-bit value containing ARGB. This 32-bit value is not premultiplied, meaning that its alpha can be any value, regardless of the values of R, G and B. + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + SkiaSharp.SKColorF + + + Gets or sets the paint's color as an (floating-point RGBA). + The color in floating-point representation. + This property provides higher precision color values than the property. + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + SkiaSharp.SKColorFilter - - - - - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets the paint's color filter. + The color filter applied to source colors before drawing, or if no filter is applied. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + System.Void - - + - To be added. - To be added. - To be added. - To be added. - To be added. + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + System.Void - - - - + - To be added. - To be added. - To be added. - To be added. - To be added. + Implemented by derived types to destroy any native objects. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKPath - - - + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKPath - - - + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to transform. + The transformation matrix to apply. + Creates a new path from the result of applying any and all effects to a source path with a transformation matrix. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -400,123 +358,101 @@ The example above produces the following: - [System.Obsolete("Use SKFont.BreakText() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] - System.Int64 + System.Boolean - - - + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input path. + The output path. + Applies any and all effects to a source path, returning the result in the destination. + + if the path should be filled, or false if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + System.Boolean - - - + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + Computes the filled geometry of the source path using this paint's style and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKPath - - - + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The limit to be passed to the path effect. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.BreakText() instead.", true)] - - - System.Int64 + SkiaSharp.SKPath - - - + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -524,32 +460,31 @@ The example above produces the following: - [System.Obsolete("Use SKFont.BreakText() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] - System.Int64 + System.Boolean - - - - + + + - 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 transform. + The destination path to receive the result. + The transformation matrix to apply. + Applies any and all effects to a source path with a transformation matrix, writing the result to the destination. + + if the path should be filled; if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -557,32 +492,31 @@ The example above produces the following: - [System.Obsolete("Use SKFont.BreakText() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] - System.Int64 + System.Boolean - - - - + + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The output path. + The limit to be passed to the path effect. + Applies any and all effects to a source path, returning the result in the destination. + + if the path should be filled, or false if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -590,242 +524,161 @@ The example above produces the following: - [System.Obsolete("Use SKFont.BreakText() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] - System.Int64 + System.Boolean - - - - + + + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input path. + The output path. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Applies any and all effects to a source path, returning the result in the destination. + + if the path should be filled, or false if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - SkiaSharp.SKPaint - - - - Creates a copy of the current paint. - Returns the copy. - The copy is a shallow copy, all references will still point to the same objects. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKColor - - - Gets or sets the paint's foreground color. - The paint's foreground color as a 32-bit ARGB value. - The color is a 32-bit value containing ARGB. This 32-bit value is not premultiplied, meaning that its alpha can be any value, regardless of the values of R, G and B. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKColorF - - - Gets or sets the paint's color as an (floating-point RGBA). - The color in floating-point representation. - This property provides higher precision color values than the property. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKColorFilter - - - Gets or sets the paint's color filter. - The color filter applied to source colors before drawing, or if no filter is applied. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] - - - - System.Boolean + System.Boolean - + + + - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + The transformation matrix to apply before computing the fill. + Computes the filled geometry of the source path after applying a transformation matrix and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] - - System.Boolean - + + + - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + A rectangle used to cull path elements that lie entirely outside its bounds. + Computes the filled geometry of the source path within the cull rectangle and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] - - System.Boolean - + + + - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + The scale factor used to determine resolution-dependent path simplification. + Computes the filled geometry of the source path at the specified resolution scale and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] - - - System.Boolean + SkiaSharp.SKPath - + + + - To be added. - To be added. - To be added. - To be added. + The source path to transform. + The culling rectangle to limit the path effect. + The transformation matrix to apply. + Creates a new path from the result of applying effects to a source path with culling and transformation. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] - - - System.Boolean + SkiaSharp.SKPath - - + + + - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The limit to be passed to the path effect. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or if the source path should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -833,2973 +686,33 @@ The example above produces the following: - [System.Obsolete("Use SKFont.ContainsGlyphs() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] System.Boolean - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.CountGlyphs() instead.", true)] - - - - System.Int32 - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Void - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Void - - - - Implemented by derived types to destroy any native objects. - - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Embolden instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKSamplingOptions instead.", true)] - - - - SkiaSharp.SKFilterQuality - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Metrics instead.", true)] - - - - SkiaSharp.SKFontMetrics - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Spacing instead.", true)] - - - - System.Single - - - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - The source path. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - - The source path to transform. - The transformation matrix to apply. - Creates a new path from the result of applying any and all effects to a source path with a transformation matrix. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - - - The input path. - The output path. - Applies any and all effects to a source path, returning the result in the destination. - - if the path should be filled, or false if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - - The source path. - The limit to be passed to the path effect. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - - The source path. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - + + + + The source path to transform. The destination path to receive the result. + The culling rectangle to limit the path effect. The transformation matrix to apply. - Applies any and all effects to a source path with a transformation matrix, writing the result to the destination. - - if the path should be filled; if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - - - - The source path. - The output path. - The limit to be passed to the path effect. - Applies any and all effects to a source path, returning the result in the destination. - - if the path should be filled, or false if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - - - - The input path. - The output path. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Applies any and all effects to a source path, returning the result in the destination. - - if the path should be filled, or false if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - - - The source path to transform. - The culling rectangle to limit the path effect. - The transformation matrix to apply. - Creates a new path from the result of applying effects to a source path with culling and transformation. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKPath - - - - - - - - The source path. - The limit to be passed to the path effect. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or if the source path should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - - - - - The source path to transform. - The destination path to receive the result. - The culling rectangle to limit the path effect. - The transformation matrix to apply. - Applies any and all effects to a source path with culling and transformation, writing the result to the destination. - - if the path should be filled; if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use the SKPathBuilder overload instead.")] - - - - System.Boolean - - - - - - - - - The input path. - The output path. - The destination path may be culled to this rectangle. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Applies any and all effects to a source path, returning the result in the destination. - - if the path should be filled, or false if it should be drawn with a hairline. - - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetFontMetrics() instead.", true)] - - - - System.Single - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphOffsets() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphOffsets() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphOffsets() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphOffsets() instead.", true)] - - - - System.Single[] - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphPositions() instead.", true)] - - - - SkiaSharp.SKPoint[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphPositions() instead.", true)] - - - - SkiaSharp.SKPoint[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphPositions() instead.", true)] - - - - SkiaSharp.SKPoint[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphPositions() instead.", true)] - - - - SkiaSharp.SKPoint[] - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphs() instead.", true)] - - - - System.UInt16[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetGlyphWidths() instead.", true)] - - - - System.Single[] - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - - 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. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - - 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. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - - 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. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextBlob.GetIntercepts() instead.", true)] - - - - System.Single[] - - - - - - - - - - - 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. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.GetTextPath() instead.", true)] - - - - SkiaSharp.SKPath - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Hinting instead.", true)] - - - - SkiaSharp.SKPaintHinting - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKImageFilter - - - Gets or sets the image filter. - The image filter, or if none is set. - - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - Gets or sets a value indicating whether anti-aliasing is enabled. - - if anti-aliasing is enabled; otherwise, . - - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.ForceAutoHinting instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - Gets or sets a value indicating whether dithering is enabled. - - if dithering is enabled; otherwise, . - - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.EmbeddedBitmaps instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.LinearMetrics instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - System.Boolean - - - Gets or sets a value indicating whether to paint a stroke or the fill. - - to stroke; to fill. - This is a shortcut way to set to either or . - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Edging instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - SkiaSharp.SKMaskFilter - - - Gets or sets the mask filter to use when painting. - The mask filter, or if none is set. - Mask filters control the transformations on the alpha channel before primitives are drawn. Examples are blur or emboss. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - - System.Single - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - - System.Single - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - - System.Single - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - - System.Single - - - - - - To be added. - To be added. - To be added. - To be added. + Applies any and all effects to a source path with culling and transformation, writing the result to the destination. + + if the path should be filled; if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp @@ -3807,229 +720,176 @@ The example above produces the following: - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] + [System.Obsolete("Use the SKPathBuilder overload instead.")] - System.Single + System.Boolean - - + + + + - To be added. - To be added. - To be added. - To be added. - To be added. + The input path. + The output path. + The destination path may be culled to this rectangle. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Applies any and all effects to a source path, returning the result in the destination. + + if the path should be filled, or false if it should be drawn with a hairline. + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + System.Boolean - - + + + + - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + A rectangle used to cull path elements that lie entirely outside its bounds. + The transformation matrix to apply before computing the fill. + Computes the filled geometry of the source path within the cull rectangle after applying a transformation matrix, and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - + + + + Method SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + System.Boolean - - + + + + - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The to which the filled path is written. + A rectangle used to cull path elements that lie entirely outside its bounds. + The scale factor used to determine resolution-dependent path simplification. + Computes the filled geometry of the source path within the cull rectangle at the specified resolution scale, and writes the result to the destination path builder. + if the fill path was successfully computed; otherwise, . + - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + SkiaSharp.SKImageFilter - - - - - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets the image filter. + The image filter, or if none is set. + - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + System.Boolean - - - - - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets a value indicating whether anti-aliasing is enabled. + + if anti-aliasing is enabled; otherwise, . + - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + System.Boolean - - - - - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets a value indicating whether dithering is enabled. + + if dithering is enabled; otherwise, . + - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets a value indicating whether to paint a stroke or the fill. + + to stroke; to fill. + This is a shortcut way to set to either or . - - - - - Method + + + + + Property SkiaSharp 4.150.0.0 - - - [System.Obsolete("Use SKFont.MeasureText() instead.", true)] - - - System.Single + SkiaSharp.SKMaskFilter - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Gets or sets the mask filter to use when painting. + The mask filter, or if none is set. + Mask filters control the transformations on the alpha channel before primitives are drawn. Examples are blur or emboss. @@ -4199,190 +1059,5 @@ The example above produces the following: Can also be set using . - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Subpixel instead.", true)] - - - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextAlign method overloads instead.", true)] - - - - SkiaSharp.SKTextAlign - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKTextEncoding method overloads instead.", true)] - - - - SkiaSharp.SKTextEncoding - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.ScaleX instead.", true)] - - - - System.Single - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Size instead.", true)] - - - - System.Single - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.SkewX instead.", true)] - - - - System.Single - - - To be added. - To be added. - To be added. - - - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont instead.", true)] - - - - SkiaSharp.SKFont - - - - To be added. - To be added. - To be added. - - - - - - - Property - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKFont.Typeface instead.", true)] - - - - SkiaSharp.SKTypeface - - - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 984202d9..37aae424 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPath.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml @@ -1344,9 +1344,9 @@ the first point is automatically set to (0, 0). System.IntPtr - To be added. - To be added. - To be added. + Gets the handle to the underlying native path object. + The underlying native sk_path_t handle. + @@ -2518,32 +2518,6 @@ the first point is automatically set to (0, 0). - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Transform(in SKMatrix) instead.", true)] - - - - System.Void - - - - - - To be added. - To be added. - To be added. - - @@ -2573,34 +2547,6 @@ the first point is automatically set to (0, 0). - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Transform(in SKMatrix matrix, SKPath destination) instead.", true)] - - - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index a1a72aa8..00c1678c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,29 @@ - To be added. - To be added. + A mutable builder for constructing objects incrementally. + . Unlike `SKPath`, which is a sealed, immutable representation, `SKPathBuilder` is designed for incremental construction. + +Use to obtain a read-only copy of the current path without resetting the builder, or to transfer ownership of the path to the caller and reset the builder. + +`SKPathBuilder` extends and must be disposed when no longer needed. + +## Examples + +Building a triangle path: + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(0, 0); +builder.LineTo(100, 0); +builder.LineTo(50, 100); +builder.Close(); +using var path = builder.Detach(); +``` +]]> @@ -26,8 +47,8 @@ - To be added. - To be added. + Initializes a new, empty instance of the class. + @@ -43,9 +64,9 @@ - To be added. - To be added. - To be added. + The path whose contours are copied into this builder. + Initializes a new instance of the class with the contours of the specified path. + @@ -66,11 +87,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The bounds of the oval that defines the arc. + The starting angle of the arc, in degrees, measured clockwise from the positive x-axis. + The sweep angle of the arc, in degrees, measured clockwise. + Appends an arc of the specified oval as a new contour. + @@ -92,12 +113,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 of the circle. + The y-coordinate of the center of the circle. + The radius of the circle. + The winding direction of the circle contour. + Appends a circle contour to the path. + @@ -117,10 +138,10 @@ - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The winding direction of the oval contour. + Appends an oval contour to the path. + @@ -140,10 +161,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + Controls how the contours of are joined to the existing contours. + Appends the contours from another path to this builder. + @@ -170,11 +191,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + A transformation matrix applied to the contours of before appending. + Controls how the contours of are joined to the existing contours. + Appends the contours from another path, transformed by a matrix, to this builder. + @@ -196,12 +217,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 contours of before appending. + The vertical translation applied to the contours of before appending. + Controls how the contours of are joined to the existing contours. + Appends the contours from another path, translated by the specified offset, to this builder. + @@ -221,10 +242,10 @@ - To be added. - To be added. - To be added. - To be added. + An array of points defining the polygon vertices. + to close the polygon by adding a line back to the first point; otherwise, . + Appends a polygon contour defined by the specified points. + @@ -244,10 +265,10 @@ - To be added. - To be added. - To be added. - To be added. + A read-only span of points defining the polygon vertices. + to close the polygon by adding a line back to the first point; otherwise, . + Appends a polygon contour defined by the specified span of points. + @@ -267,10 +288,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + The winding direction of the rectangle contour. + Appends a rectangle contour to the path. + @@ -291,11 +312,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + The winding direction of the rectangle contour. + The index of the corner (0–3) at which the contour begins. + Appends a rectangle contour to the path, starting at the specified corner. + @@ -315,10 +336,10 @@ - To be added. - To be added. - To be added. - To be added. + The round rectangle to add. + The winding direction of the round rectangle contour. + Appends a round rectangle contour to the path. + @@ -339,11 +360,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The round rectangle to add. + The winding direction of the round rectangle contour. + The index of the starting point on the contour. + Appends a round rectangle contour to the path, starting at the specified point index. + @@ -365,12 +386,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the round rectangle. + The horizontal radius of the rounded corners. + The vertical radius of the rounded corners. + The winding direction of the contour. + Appends a round rectangle contour with the specified corner radii to the path. + @@ -391,11 +412,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point. + The second tangent point and end of the arc. + The radius of the circular arc. + Appends a circular arc to the current contour using two tangent points. + @@ -417,12 +438,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounds of the oval that defines the arc. + The starting angle of the arc, in degrees. + The sweep angle of the arc, in degrees. + to begin a new contour at the arc start; to connect with a line from the current point. + Appends an arc of the specified oval to the current contour. + @@ -445,13 +466,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 (x-radius, y-radius). + The rotation of the ellipse's x-axis relative to the current coordinate system, in degrees. + Specifies whether the large or small arc is drawn. + The direction in which the arc is drawn. + The end point of the arc. + Appends an SVG-style elliptical arc to the current contour. + @@ -474,13 +495,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first tangent point. + The y-coordinate of the first tangent point. + The x-coordinate of the second tangent point. + The y-coordinate of the second tangent point. + The radius of the circular arc. + Appends a circular arc to the current contour using two tangent points specified as coordinates. + @@ -505,15 +526,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius of the ellipse. + The y-radius of the ellipse. + The rotation of the ellipse's x-axis, in degrees. + Specifies whether the large or small arc is drawn. + The direction in which the arc is drawn. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends an SVG-style elliptical arc to the current contour using separate radius and endpoint coordinates. + @@ -530,8 +551,8 @@ - To be added. - To be added. + Closes the current contour by appending a line to its starting point. + @@ -552,11 +573,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic. + The end point of the conic. + The weight of the conic; values greater than 1 pull the curve toward the control point. + Appends a weighted conic curve to the current contour. + @@ -579,13 +600,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + The weight of the conic. + Appends a weighted conic curve to the current contour using coordinate values. + @@ -606,11 +627,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point of the cubic Bézier. + The second control point of the cubic Bézier. + The end point of the cubic Bézier. + Appends a cubic Bézier curve to the current contour. + @@ -634,14 +655,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first control point. + The y-coordinate of the first control point. + The x-coordinate of the second control point. + The y-coordinate of the second control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a cubic Bézier curve to the current contour using coordinate values. + @@ -658,9 +679,9 @@ - To be added. - To be added. - To be added. + Returns the built path and resets this builder to an empty state. + The built so far. The builder is reset to an empty state after the call. + @@ -679,9 +700,9 @@ - To be added. - To be added. - To be added. + to release both managed and native resources; to release only native resources. + Releases the resources used by this . + @@ -698,8 +719,8 @@ - To be added. - To be added. + Releases the native resources held by this . + @@ -715,9 +736,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type rule used when the path is converted to an . + The that determines how overlapping contours are filled. + @@ -736,9 +757,9 @@ - To be added. - To be added. - To be added. + The end point of the line segment. + Appends a straight line segment from the current point to the specified point. + @@ -758,10 +779,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a straight line segment from the current point to the specified coordinates. + @@ -780,9 +801,9 @@ - To be added. - To be added. - To be added. + The starting point of the new contour. + Begins a new contour at the specified point. + @@ -802,10 +823,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the starting point. + The y-coordinate of the starting point. + Begins a new contour at the specified coordinates. + @@ -825,10 +846,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point of the quadratic Bézier. + The end point of the quadratic Bézier. + Appends a quadratic Bézier curve to the current contour. + @@ -850,12 +871,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a quadratic Bézier curve to the current contour using coordinate values. + @@ -878,13 +899,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The radii of the ellipse (x-radius, y-radius). + The rotation of the ellipse's x-axis, in degrees. + Specifies whether the large or small arc is drawn. + The direction in which the arc is drawn. + The offset from the current point to the end point of the arc. + Appends a relative SVG-style elliptical arc to the current contour. + @@ -909,15 +930,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius of the ellipse. + The y-radius of the ellipse. + The rotation of the ellipse's x-axis, in degrees. + Specifies whether the large or small arc is drawn. + The direction in which the arc is drawn. + The x-offset from the current point to the end point. + The y-offset from the current point to the end point. + Appends a relative SVG-style elliptical arc to the current contour using separate radius and offset coordinates. + @@ -938,11 +959,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the control point. + The offset from the current point to the end point. + The weight of the conic. + Appends a relative weighted conic curve to the current contour. + @@ -965,13 +986,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point to the control point. + The y-offset from the current point to the control point. + The x-offset from the current point to the end point. + The y-offset from the current point to the end point. + The weight of the conic. + Appends a relative weighted conic curve to the current contour using offset coordinates. + @@ -992,11 +1013,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the first control point. + The offset from the current point to the second control point. + The offset from the current point to the end point. + Appends a relative cubic Bézier curve to the current contour. + @@ -1020,14 +1041,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point to the first control point. + The y-offset from the current point to the first control point. + The x-offset from the current point to the second control point. + The y-offset from the current point to the second control point. + The x-offset from the current point to the end point. + The y-offset from the current point to the end point. + Appends a relative cubic Bézier curve to the current contour using offset coordinates. + @@ -1044,8 +1065,8 @@ - To be added. - To be added. + Resets this builder to an empty state, discarding all contours and resetting the fill type to the default. + @@ -1064,9 +1085,9 @@ - To be added. - To be added. - To be added. + The path whose contours are reversed and appended. + Appends the contours from another path in reverse order. + @@ -1085,9 +1106,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the end point of the line segment. + Appends a relative straight line segment from the current point using the specified offset. + @@ -1107,10 +1128,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point. + The y-offset from the current point. + Appends a relative straight line segment from the current point using the specified offset coordinates. + @@ -1129,9 +1150,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the starting point of the new contour. + Begins a new contour at a point offset from the current point. + @@ -1151,10 +1172,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point. + The y-offset from the current point. + Begins a new contour at a position offset from the current point by the specified coordinates. + @@ -1174,10 +1195,10 @@ - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the control point. + The offset from the current point to the end point. + Appends a relative quadratic Bézier curve to the current contour. + @@ -1199,12 +1220,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point to the control point. + The y-offset from the current point to the control point. + The x-offset from the current point to the end point. + The y-offset from the current point to the end point. + Appends a relative quadratic Bézier curve to the current contour using offset coordinates. + @@ -1221,9 +1242,9 @@ - To be added. - To be added. - To be added. + Returns a snapshot of the current path without modifying this builder. + A new containing a snapshot of the current contours. The builder is not modified. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index d058fcfb..646fbd4d 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -268,14 +268,13 @@ - The starting offset of the segment. - The end offset of the segment. - The path to hold the new segment. - If true, begin the path segment with a . - Given a start and stop distance, update the destination path with the intervening segment(s). - - if the segment is zero-length, otherwise returns . - The start and stop parameters are pinned to 0... + The distance along the path at which the segment begins. + The distance along the path at which the segment ends. + The to which the extracted segment contour is appended. + to prepend a move-to verb at the start position of the segment; otherwise, . + Extracts a contour segment of the path between two distances and appends it to the destination path. + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml index f8e1cab9..c2543c4b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml @@ -1232,35 +1232,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use ScalePixels(SKPixmap destination, SKSamplingOptions sampling) instead.", true)] - - - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKPositionedRunBuffer.xml b/SkiaSharpAPI/SkiaSharp/SKPositionedRunBuffer.xml index 8fac3fb8..4d3ad3f8 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPositionedRunBuffer.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPositionedRunBuffer.xml @@ -15,30 +15,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Positions instead.")] - - - - System.Span<SkiaSharp.SKPoint> - - - - Gets the span of positions for each glyph. - A span containing the positions. - - - diff --git a/SkiaSharpAPI/SkiaSharp/SKRotationScaleRunBuffer.xml b/SkiaSharpAPI/SkiaSharp/SKRotationScaleRunBuffer.xml index 57b89b44..92bddcc0 100644 --- a/SkiaSharpAPI/SkiaSharp/SKRotationScaleRunBuffer.xml +++ b/SkiaSharpAPI/SkiaSharp/SKRotationScaleRunBuffer.xml @@ -15,30 +15,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Positions instead.")] - - - - System.Span<SkiaSharp.SKRotationScaleMatrix> - - - - Gets the span of rotation-scale matrices for each glyph. - A span containing the rotation-scale matrices. - - - @@ -78,31 +54,5 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SetPositions instead.")] - - - - System.Void - - - - - - The rotation-scale matrices to set for each glyph. - Sets the rotation-scale matrices for each glyph in the run. - - - diff --git a/SkiaSharpAPI/SkiaSharp/SKRunBuffer.xml b/SkiaSharpAPI/SkiaSharp/SKRunBuffer.xml index 43887c5c..ee94d9f9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKRunBuffer.xml +++ b/SkiaSharpAPI/SkiaSharp/SKRunBuffer.xml @@ -15,30 +15,6 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use Glyphs instead.")] - - - - System.Span<System.UInt16> - - - - Gets the span of glyph IDs for the run. - A span containing the glyph IDs. - - - diff --git a/SkiaSharpAPI/SkiaSharp/SKShader.xml b/SkiaSharpAPI/SkiaSharp/SKShader.xml index 4211cb0a..4801eaba 100644 --- a/SkiaSharpAPI/SkiaSharp/SKShader.xml +++ b/SkiaSharpAPI/SkiaSharp/SKShader.xml @@ -641,39 +641,6 @@ The example above produces the following: - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use CreateImage(SKImage src, SKShaderTileMode tmx, SKShaderTileMode tmy, SKSamplingOptions sampling) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - @@ -730,41 +697,6 @@ The example above produces the following: - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use CreateImage(SKImage src, SKShaderTileMode tmx, SKShaderTileMode tmy, SKSamplingOptions sampling, SKMatrix localMatrix) instead.", true)] - - - - SkiaSharp.SKShader - - - - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index 43e5cdcb..82f42602 100644 --- a/SkiaSharpAPI/SkiaSharp/SKStream.xml +++ b/SkiaSharpAPI/SkiaSharp/SKStream.xml @@ -29,9 +29,9 @@ - To be added. - To be added. - To be added. + Returns the entire contents of the stream as an object. + A new containing the entire contents of the stream. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index bfaf672b..21e5aa73 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -1680,11 +1680,11 @@ The example above produces the following: - The canvas to draw on. - The destination x-coordinate for the surface. - The destination y-coordinate for the surface. - The paint to use when drawing the surface, or . - Draws the current surface on the specified canvas. + The canvas onto which this surface is drawn. + The x-coordinate of the destination position. + The y-coordinate of the destination position. + The paint to apply when drawing, or to use default paint settings. + Draws this surface onto the specified canvas at the given position. @@ -1708,13 +1708,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 onto which this surface is drawn. + The x-coordinate of the destination position. + The y-coordinate of the destination position. + The sampling options to use when drawing. + The paint to apply when drawing, or to use default paint settings. + Draws this surface onto the specified canvas at the given position. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index 652aa14f..6562a2c3 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml @@ -44,10 +44,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The font arguments specifying palette, variation settings, and other parameters to apply to the clone. + Creates a new typeface derived from this typeface with the specified font arguments. + A new based on this typeface with the specified font arguments applied. + @@ -66,10 +66,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette to use in the cloned typeface. + Creates a new typeface derived from this typeface using the specified color palette index. + A new based on this typeface with the specified color palette. + @@ -88,10 +88,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + A read-only span of axis-tag/value pairs defining the variation design position. + Creates a new typeface derived from this typeface with the specified variation design position. + A new based on this typeface with the specified variation design position applied. + @@ -477,9 +477,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 instance. + A shared instance that represents an empty typeface. + @@ -1076,10 +1076,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span to receive the values. + Fills a span with the variation design parameters (axes) defined in this typeface. + The number of variation axis parameters written to . + @@ -1098,10 +1098,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span to receive the values. + Fills a span with the current variation design position of this typeface. + The number of axis coordinates written to . + @@ -1179,9 +1179,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 is the empty typeface. + if this typeface is the empty typeface; otherwise, . + @@ -1467,9 +1467,9 @@ A typeface is understood to be italic when it has a slant of either System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation design parameters (axes) in this typeface. + The number of variation axes defined in this typeface's fvar table. + @@ -1485,9 +1485,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 all variation design parameters (axes) defined in this typeface. + An array of describing each variation axis, or an empty array if this typeface has no variation axes. + @@ -1503,9 +1503,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationPositionCoordinate[] - To be added. - To be added. - To be added. + Gets the current variation design position of this typeface. + An array of representing the current design-space position for each variation axis. + @@ -1521,9 +1521,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 axes in the current variation design position of this typeface. + The number of variation axes for which the typeface has a current design-space position. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7930b162..fbd18341 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,28 @@ - To be added. - To be added. + Provides methods for encoding images and animated sequences to the WebP format. + to WebP data, as well as encoding multi-frame animated WebP sequences from a span of values. + +Encoding options such as quality and compression method are specified via . + +## Examples + +Encoding a bitmap to a WebP file: + +```csharp +using var bitmap = new SKBitmap(200, 200); +using var canvas = new SKCanvas(bitmap); +canvas.DrawColor(SKColors.CornflowerBlue); + +using var pixmap = bitmap.PeekPixels(); +using var data = SKWebpEncoder.Encode(pixmap, SKWebpEncoderOptions.Default); +File.WriteAllBytes("output.webp", data.ToArray()); +``` +]]> @@ -42,11 +62,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The pixel data to encode. + The WebP encoder options, such as quality and compression method. + Encodes the specified pixel data to the WebP format and returns the result as . + A new containing the encoded WebP data, or if encoding failed. + @@ -72,12 +92,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to which the encoded WebP data is written. + The pixel data to encode. + The WebP encoder options, such as quality and compression method. + Encodes the specified pixel data to WebP format and writes the result to the specified stream. + if encoding succeeded; otherwise, . + @@ -103,12 +123,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The managed stream to which the encoded WebP data is written. + The pixel data to encode. + The WebP encoder options, such as quality and compression method. + Encodes the specified pixel data to WebP format and writes the result to the specified managed stream. + if encoding succeeded; otherwise, . + @@ -133,11 +153,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of values describing each frame of the animation. + The WebP encoder options, such as quality and compression method. + Encodes the specified frames as an animated WebP and returns the result as . + A new containing the encoded animated WebP data, or if encoding failed. + @@ -164,12 +184,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to which the encoded animated WebP data is written. + A read-only span of values describing each frame of the animation. + The WebP encoder options, such as quality and compression method. + Encodes the specified frames as an animated WebP and writes the result to the specified stream. + if encoding succeeded; otherwise, . + @@ -196,12 +216,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The managed stream to which the encoded animated WebP data is written. + A read-only span of values describing each frame of the animation. + The WebP encoder options, such as quality and compression method. + Encodes the specified frames as an animated WebP and writes the result to the specified managed stream. + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index f6fa0c7f..5f185aa5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,31 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence. + ) and a display duration for use with . + +When constructed from an or , the constructor calls `PeekPixels()` to obtain a non-owning view of the pixel data. If pixel data is not available, an exception is thrown. + +## Examples + +Creating a two-frame animated WebP: + +```csharp +using var frame1Bitmap = new SKBitmap(100, 100); +using var frame2Bitmap = new SKBitmap(100, 100); +// ... draw into bitmaps ... + +var frames = new[] +{ + new SKWebpEncoderFrame(frame1Bitmap, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(frame2Bitmap, TimeSpan.FromMilliseconds(100)), +}; +using var data = SKWebpEncoder.EncodeAnimated(frames, SKWebpEncoderOptions.Default); +``` +]]> @@ -29,10 +52,10 @@ - To be added. - To be added. - To be added. - To be added. + The bitmap whose pixel data will be used for this frame. + The display duration of this frame. + Initializes a new instance of the struct from a bitmap and a display duration. + @@ -49,10 +72,10 @@ - To be added. - To be added. - To be added. - To be added. + The image whose pixel data will be used for this frame. + The display duration of this frame. + Initializes a new instance of the struct from an image and a display duration. + @@ -69,10 +92,10 @@ - To be added. - To be added. - To be added. - To be added. + The pixmap containing the pixel data for this frame. + The display duration of this frame. + Initializes a new instance of the struct from a pixmap and a display duration. + @@ -93,9 +116,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the display duration of this frame. + The length of time this frame is displayed during animation playback. + @@ -116,9 +139,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/SkiaSharp/SKWebpEncoderOptions.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml index f3515191..d3a1d916 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml @@ -14,6 +14,11 @@ System.IEquatable<SkiaSharp.SKWebpEncoderOptions> + + + [System.Runtime.CompilerServices.IsReadOnly] + + Options to control the WEBP encoding. diff --git a/SkiaSharpAPI/SkiaSharp/SkiaExtensions.xml b/SkiaSharpAPI/SkiaSharp/SkiaExtensions.xml index c483d77a..37c53902 100644 --- a/SkiaSharpAPI/SkiaSharp/SkiaExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp/SkiaExtensions.xml @@ -197,32 +197,5 @@ - - - - - Method - - SkiaSharp - 4.150.0.0 - - - - [System.Obsolete("Use SKSamplingOptions instead.", true)] - - - - SkiaSharp.SKSamplingOptions - - - - - - To be added. - To be added. - To be added. - To be added. - - diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index 7b98ae5a..4d6e3950 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -235,7 +235,6 @@ - @@ -285,7 +284,6 @@ - @@ -1058,7 +1056,7 @@ - + @@ -1082,7 +1080,7 @@ - + @@ -1106,7 +1104,7 @@ - + @@ -1352,30 +1350,6 @@ - - - - - - - - - ExtensionMethod - - SkiaSharp.SKSamplingOptions - - - - - - To be added. - To be added. - To be added. - To be added. - - - -