From dd79afead1a69cb3ce9abd0c4bd0287ec497a3fb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 20 Jun 2026 00:08:34 +0000 Subject: [PATCH] Fill all documentation placeholders for SkiaSharp 3.x APIs Populate all 'To be added.' placeholder fields across 38 documentation files (1057 fields in 38 XML files) for new APIs in SkiaSharp 3.x and HarfBuzzSharp: HarfBuzzSharp: - Face: variation axes (HasVariationData, VariationAxisInfos, etc.), named instances, color palettes (HasPalettes, GetPaletteColors, etc.) - Font: SetVariations, SetVariationCoordsDesign/Normalized, VariationCoordsNormalized, SetVariationNamedInstance - HBColor: BGRA-packed color struct with full type-level remarks SkiaSharp: - SKFourByteTag: big-endian packed tag struct with remarks/examples - SKColorspacePrimariesCicp / SKColorspaceTransferFnCicp: CICP enums - SKColorSpace.CreateCicp: factory for CICP color spaces - SKColorType: Bgra10101010XR, RgbF16F16F16x, R16Unorm, RF16 - GRVkYcbcrComponents / GRVkYcbcrConversionInfo: Vulkan YCbCr structs - GrVkYcbcrConversionInfo: obsolete wrapper with conversion operators - SKDocumentXpsOptions / SKDocument.CreateXps: XPS options struct - SKFontArguments / SKFontPaletteOverride / SKFontVariationAxis / SKFontVariationPositionCoordinate: font variation/palette structs - SKTypeface: Empty, IsEmpty, Clone overloads, variation API - SKPathBuilder: full 51-member mutable path builder with remarks - SKPathMeasure.GetSegment with SKPathBuilder destination - SKPaint.GetFillPath overloads writing to SKPathBuilder - SKWebpEncoder.Encode / EncodeAnimated: animated WebP encoding - SKWebpEncoderFrame: animated WebP frame struct - SKCanvas: DrawBitmap/DrawSurface with SKSamplingOptions - SKSurface.Draw with SKSamplingOptions - SKMaskFilter.CreateShader, SKStream.GetData, SKPath.Handle - GRContext.Flush(SKImage) / Flush(SKSurface) SkiaSharp.HarfBuzz: - ColorExtensions: ToHBColor/ToSKColor/ToSKColorF/ToSKColors Views: - SKGLControl constructors, GTKExtensions converters - SKDrawingArea.Dispose, SKGLSurfaceViewRenderer (infra) - Blazor _Imports, ActionHelper, FloatFloatActionHelper (infra) - SkiaSharp.Views.Blazor.Internal namespace summary Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../FrameworksIndex/skiasharp-views.xml | 10 + SkiaSharpAPI/FrameworksIndex/skiasharp.xml | 143 - SkiaSharpAPI/HarfBuzzSharp/Face.xml | 156 +- SkiaSharpAPI/HarfBuzzSharp/Font.xml | 38 +- SkiaSharpAPI/HarfBuzzSharp/HBColor.xml | 144 +- .../SkiaSharp.HarfBuzz/ColorExtensions.xml | 44 +- .../CachingResourceProvider.xml | 8 - .../DataUriResourceProvider.xml | 8 - .../FileResourceProvider.xml | 8 - .../SkiaSharp.Resources/ResourceProvider.xml | 20 - SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml | 68 - .../SkiaSharp.Skottie/AnimationBuilder.xml | 28 - .../SKGLSurfaceViewRenderer.xml | 4 +- .../ActionHelper.xml | 65 + .../FloatFloatActionHelper.xml | 70 + .../SkiaSharp.Views.Blazor/SKCanvasView.xml | 17 - .../SkiaSharp.Views.Blazor/SKGLView.xml | 17 - .../SKPaintGLSurfaceEventArgs.xml | 8 - .../SKPaintSurfaceEventArgs.xml | 8 - .../SkiaSharp.Views.Blazor/_Imports.xml | 4 +- .../SkiaSharp.Views.Desktop/SKGLControl.xml | 18 +- .../SkiaSharp.Views.Gtk/GTKExtensions.xml | 104 +- .../SkiaSharp.Views.Gtk/SKDrawingArea.xml | 4 +- SkiaSharpAPI/SkiaSharp/GRContext.xml | 12 +- .../SkiaSharp/GRD3DBackendContext.xml | 21 +- .../SkiaSharp/GRD3DTextureResourceInfo.xml | 7 +- .../SkiaSharp/GRVkYcbcrComponents.xml | 80 +- .../SkiaSharp/GRVkYcbcrConversionInfo.xml | 414 ++ .../SkiaSharp/GrVkYcbcrConversionInfo.xml | 184 +- SkiaSharpAPI/SkiaSharp/SKBitmap.xml | 180 - SkiaSharpAPI/SkiaSharp/SKBlender.xml | 8 - SkiaSharpAPI/SkiaSharp/SKCanvas.xml | 358 +- .../SkiaSharp/SKCanvasSaveLayerRec.xml | 8 - SkiaSharpAPI/SkiaSharp/SKColorSpace.xml | 10 +- SkiaSharpAPI/SkiaSharp/SKColorType.xml | 8 +- .../SkiaSharp/SKColorspacePrimariesCicp.xml | 45 +- .../SkiaSharp/SKColorspaceTransferFnCicp.xml | 49 +- SkiaSharpAPI/SkiaSharp/SKDocument.xml | 30 +- .../SkiaSharp/SKDocumentXpsOptions.xml | 64 +- SkiaSharpAPI/SkiaSharp/SKFontArguments.xml | 62 +- .../SkiaSharp/SKFontPaletteOverride.xml | 65 +- .../SkiaSharp/SKFontVariationAxis.xml | 86 +- .../SKFontVariationPositionCoordinate.xml | 65 +- SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | 137 +- SkiaSharpAPI/SkiaSharp/SKImage.xml | 124 - SkiaSharpAPI/SkiaSharp/SKImageFilter.xml | 653 +-- SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml | 8 +- SkiaSharpAPI/SkiaSharp/SKPaint.xml | 4069 ++--------------- SkiaSharpAPI/SkiaSharp/SKPath.xml | 60 +- SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml | 507 +- SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 14 +- SkiaSharpAPI/SkiaSharp/SKPixmap.xml | 100 - .../SkiaSharp/SKRuntimeEffectUniform.xml | 3 - SkiaSharpAPI/SkiaSharp/SKShader.xml | 68 - SkiaSharpAPI/SkiaSharp/SKStream.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKSurface.xml | 26 +- SkiaSharpAPI/SkiaSharp/SKTextBlob.xml | 299 +- SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml | 157 +- SkiaSharpAPI/SkiaSharp/SKTypeface.xml | 76 +- SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml | 113 +- SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml | 64 +- .../SkiaSharp/SKWebpEncoderOptions.xml | 5 + SkiaSharpAPI/SkiaSharp/SkiaExtensions.xml | 27 - SkiaSharpAPI/index.xml | 34 +- .../ns-SkiaSharp.Views.Blazor.Internal.xml | 6 + 65 files changed, 2261 insertions(+), 7045 deletions(-) create mode 100644 SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/ActionHelper.xml create mode 100644 SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/FloatFloatActionHelper.xml create mode 100644 SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml create mode 100644 SkiaSharpAPI/ns-SkiaSharp.Views.Blazor.Internal.xml diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp-views.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp-views.xml index e4933fbe..35588bc5 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp-views.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp-views.xml @@ -222,6 +222,16 @@ + + + + + + + + + + diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp.xml index 3fd3eeb0..7e332c23 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp.xml @@ -404,21 +404,15 @@ - - - - - - @@ -581,20 +575,13 @@ - - - - - - - @@ -624,7 +611,6 @@ - @@ -1702,7 +1688,6 @@ - @@ -1779,8 +1764,6 @@ - - @@ -1794,8 +1777,6 @@ - - @@ -1860,14 +1841,11 @@ - - - @@ -1882,8 +1860,6 @@ - - @@ -2195,33 +2171,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2242,98 +2192,17 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2342,13 +2211,6 @@ - - - - - - - @@ -2437,8 +2299,6 @@ - - @@ -2708,7 +2568,6 @@ - @@ -3257,8 +3116,6 @@ - - diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index 50b57eb2..bf4fa323 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Face.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Face.xml @@ -167,10 +167,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the design coordinates for the specified named instance. + An array containing the design-space coordinates for each variation axis of the named instance. + @@ -190,11 +190,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + The span to fill with the design-space coordinates for each variation axis. + Fills the provided span with the design coordinates for the specified named instance. + The number of coordinates written into . + @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the number of design coordinates for the specified named instance. + The total number of design-space coordinates (one per variation axis) for the named instance. + @@ -235,10 +235,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name identifier for the PostScript name of the specified named instance. + The for the PostScript name of the named instance. + @@ -257,10 +257,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name identifier for the subfamily name of the specified named instance. + The for the subfamily name of 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 a palette. + Returns the OpenType name identifier for the specified palette color entry. + The that names the color entry. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns all colors in the specified color palette. + An array of values representing each color in the palette. + @@ -324,11 +324,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + The span to fill with the palette colors. + Fills the provided span with the colors from the specified color palette. + The number of color values written into . + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Returns the flags that describe the intended usage of the specified color palette. + One of the values. + @@ -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 identifier for the specified color palette. + The that names the palette. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + The span to fill with the variation axis information. + Fills the provided span with information about the variation axes defined in the font. + The number of values written into . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains color glyph layers (COLR table). + if the font face has a COLR table with color layers; otherwise, . + @@ -446,9 +446,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains PNG color glyphs (CBDT/CBLC tables). + if the font face has embedded PNG color glyphs; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font face contains SVG color glyphs (SVG table). + if the font face has an SVG 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 color palettes (CPAL table). + if the font face has a CPAL 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 (fvar table). + if the font face has variation axis data; otherwise, . + @@ -573,9 +573,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of named instances defined in the font. + The number of named instances in the font's variation table. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes defined in the font. + The number of palettes in the font's CPAL table. + @@ -653,11 +653,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte tag identifying the variation axis. + When this method returns, contains the axis information if found. This parameter is treated as uninitialized. + Attempts to find a variation axis by its four-byte tag. + if the axis was found; otherwise, . + @@ -691,9 +691,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes defined in the font. + The number of variation axes in the font's variation table. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets an array containing information about all variation axes defined in the font. + An array of values, one per variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index 6033fbd3..292d5335 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Font.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Font.xml @@ -321,10 +321,10 @@ - To be added. - To be added. - To be added. - To be added. + The span to fill with the normalized variation coordinates. + Fills the provided span with the normalized variation coordinates currently applied to the font. + The number of coordinates written into . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + The design-space coordinates, one value per variation axis in the order defined by the face. + Sets the variation axes of the font using design-space coordinates. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + The normalized coordinates in the range [-1, 1], one value per variation axis in the order defined by the face. + Sets the variation axes of the font using normalized coordinates. + @@ -621,9 +621,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the named instance defined in the font face. + Sets the variation axes of the font to the design coordinates of the specified named instance. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + The variation values to apply, each identifying an axis by tag and specifying the desired value. + Sets one or more variation axes of the font using axis tag and value pairs. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets an array of the normalized variation coordinates currently applied to the font. + An array of normalized variation coordinates, one per variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml index 7cb5ad95..d8a549fb 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml @@ -14,9 +14,37 @@ System.IEquatable<HarfBuzzSharp.HBColor> + + + [System.Runtime.CompilerServices.IsReadOnly] + + - To be added. - To be added. + Represents a HarfBuzz color value with BGRA byte ordering. + @@ -32,9 +60,9 @@ - To be added. - To be added. - To be added. + The raw hb_color_t value packed as 0xBBGGRRAA. + Initializes a new instance of the struct from a raw packed value. + @@ -53,12 +81,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 components. + @@ -74,9 +102,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the alpha channel value. + The alpha component (0–255), extracted from the low byte of the packed value. + @@ -92,9 +120,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the blue channel value. + The blue component (0–255), extracted from the high byte of the packed value. + @@ -116,10 +144,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Determines whether this instance and the specified have the same packed value. + if both instances represent the same color; otherwise, . + @@ -138,10 +166,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same packed value; otherwise, . + @@ -158,9 +186,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -176,9 +204,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the green channel value. + The green component (0–255), extracted from bits 23–16 of the packed value. + @@ -198,11 +226,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 instances have the same packed value. + if and are equal; otherwise, . + @@ -221,10 +249,10 @@ - To be added. - To be added. - To be added. - To be added. + The raw packed hb_color_t value (0xBBGGRRAA). + Explicitly converts a raw hb_color_t unsigned integer to an . + A new backed by the specified raw value. + @@ -243,10 +271,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Implicitly converts an to its raw 32-bit unsigned integer representation. + The raw packed value of the color (0xBBGGRRAA). + @@ -266,11 +294,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 instances have different packed values. + if and differ; otherwise, . + @@ -286,9 +314,9 @@ System.Byte - To be added. - To be added. - To be added. + Gets the red channel value. + The red component (0–255), extracted from bits 15–8 of the packed value. + @@ -305,9 +333,9 @@ - To be added. - To be added. - To be added. + Returns the hexadecimal string representation of this color. + A string in the format #AARRGGBB representing the alpha, red, green, and blue channels. + @@ -323,9 +351,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets the raw packed hb_color_t value. + A 32-bit unsigned integer packed as 0xBBGGRRAA: blue in the high byte, alpha in the low byte. + diff --git a/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml index e6b07184..28de9c16 100644 --- a/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml @@ -11,8 +11,8 @@ - To be added. - To be added. + Provides extension methods for converting between / and . + @@ -31,10 +31,10 @@ - To be added. - To be added. - To be added. - To be added. + The (ARGB) to convert. + Converts an to an . + An representing the same color. + @@ -53,10 +53,10 @@ - To be added. - To be added. - To be added. - To be added. + The (float ARGB) to convert. + Converts an to an . + An representing the same color with components clamped to [0, 255]. + @@ -75,10 +75,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 +97,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. + @@ -119,10 +119,10 @@ - To be added. - To be added. - To be added. - To be added. + The array of values to convert. + Converts an to an . + An representing the same color. + diff --git a/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml index 2b409108..cfa9594d 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml @@ -10,14 +10,6 @@ SkiaSharp.Resources.ResourceProvider - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - A resource provider proxy that caches loaded image assets. diff --git a/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml index a7c26529..a6c84132 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml @@ -10,14 +10,6 @@ SkiaSharp.Resources.ResourceProvider - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(2)] - - A resource provider that can load resources from data URIs embedded in Lottie JSON files. diff --git a/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml index 30636ff3..78597f04 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml @@ -10,14 +10,6 @@ SkiaSharp.Resources.ResourceProvider - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - A resource provider that loads resources from a directory on the file system. Use this provider to load Lottie animation assets (images, fonts, nested animations) from a local directory. diff --git a/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml index 84e1ab4f..27713a26 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml @@ -27,18 +27,8 @@ SkiaSharp.Resources 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKData - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -59,18 +49,8 @@ SkiaSharp.Resources 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKData - - - [System.Runtime.CompilerServices.Nullable(2)] - - diff --git a/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml b/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml index 67447a53..cfbf85fd 100644 --- a/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml +++ b/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml @@ -10,14 +10,6 @@ SkiaSharp.SKObject - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Represents a Lottie animation that can be loaded, positioned, and rendered to a canvas. @@ -38,11 +30,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -65,11 +52,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -92,11 +74,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -119,11 +96,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -258,11 +230,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -331,11 +298,6 @@ SkiaSharp.Skottie 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Void @@ -359,11 +321,6 @@ SkiaSharp.Skottie 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Void @@ -387,11 +344,6 @@ SkiaSharp.Skottie 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Void @@ -415,11 +367,6 @@ SkiaSharp.Skottie 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Void @@ -471,9 +418,6 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - - [System.Runtime.CompilerServices.Nullable(2)] - @@ -505,9 +449,6 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - - [System.Runtime.CompilerServices.Nullable(2)] - @@ -539,9 +480,6 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - - [System.Runtime.CompilerServices.Nullable(2)] - @@ -573,9 +511,6 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - - [System.Runtime.CompilerServices.Nullable(2)] - @@ -607,9 +542,6 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - - [System.Runtime.CompilerServices.Nullable(2)] - diff --git a/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml b/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml index d1b68425..71c42cdb 100644 --- a/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml @@ -10,14 +10,6 @@ SkiaSharp.SKObject - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Provides a builder pattern for creating animations with custom configuration. @@ -37,11 +29,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -64,11 +51,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -91,11 +73,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -118,11 +95,6 @@ SkiaSharp.Skottie.Animation - - - [System.Runtime.CompilerServices.Nullable(2)] - - diff --git a/SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceViewRenderer.xml b/SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceViewRenderer.xml index 52da68f2..d73c48d6 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceViewRenderer.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceViewRenderer.xml @@ -118,8 +118,8 @@ - To be added. - To be added. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/ActionHelper.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/ActionHelper.xml new file mode 100644 index 00000000..43630831 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/ActionHelper.xml @@ -0,0 +1,65 @@ + + + + + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + System.Object + + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + + + + Constructor + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + + + + Method + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + + [Microsoft.JSInterop.JSInvokable] + + + + System.Void + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/FloatFloatActionHelper.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/FloatFloatActionHelper.xml new file mode 100644 index 00000000..6b53cce9 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/FloatFloatActionHelper.xml @@ -0,0 +1,70 @@ + + + + + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + System.Object + + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + + + + Constructor + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + + + + Method + + SkiaSharp.Views.Blazor + 4.150.0.0 + + + + [Microsoft.JSInterop.JSInvokable] + + + + System.Void + + + + + + + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml index 2f49ee96..a63bc256 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml @@ -15,12 +15,6 @@ - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [System.Runtime.Versioning.SupportedOSPlatform("browser")] @@ -58,9 +52,6 @@ [Microsoft.AspNetCore.Components.Parameter(CaptureUnmatchedValues=true)] - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })] - System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object> @@ -80,11 +71,6 @@ SkiaSharp.Views.Blazor 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Void @@ -238,9 +224,6 @@ [Microsoft.AspNetCore.Components.Parameter] - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] - System.Action<SkiaSharp.Views.Blazor.SKPaintSurfaceEventArgs> diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml index 1d649e99..d81bcae0 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml @@ -15,12 +15,6 @@ - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - [System.Runtime.Versioning.SupportedOSPlatform("browser")] @@ -58,9 +52,6 @@ [Microsoft.AspNetCore.Components.Parameter(CaptureUnmatchedValues=true)] - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })] - System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object> @@ -80,11 +71,6 @@ SkiaSharp.Views.Blazor 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Void @@ -238,9 +224,6 @@ [Microsoft.AspNetCore.Components.Parameter] - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] - System.Action<SkiaSharp.Views.Blazor.SKPaintGLSurfaceEventArgs> diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml index d2eacdeb..7732ed22 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml @@ -10,14 +10,6 @@ System.EventArgs - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Provides data for the callback. This class contains the GPU-backed drawing surface and information about its size, format, and backend render target for WebGL-accelerated Blazor canvas views. diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml index de650f54..fb685fbd 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml @@ -10,14 +10,6 @@ System.EventArgs - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Provides data for the callback. This class contains the drawing surface and information about its size and format for software-rendered Blazor canvas views. diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml index 43b35a4f..30d84c3f 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. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml b/SkiaSharpAPI/SkiaSharp.Views.Desktop/SKGLControl.xml index c01b8480..d37c802d 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 describing the pixel format. + 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 describing the pixel format. + The major version number of the requested OpenGL context. + The minor version number of the requested OpenGL context. + The used to 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..0435e14c 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 bounds as . + @@ -75,10 +75,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A with the same color values as . + @@ -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 color values as . + @@ -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 as . + @@ -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 as . + @@ -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 as . + @@ -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 as . + @@ -395,10 +395,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An with the same color values as . + @@ -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 color values as . + @@ -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 as . + @@ -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 as . + @@ -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 as . + @@ -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 as . + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml index 24cfa66c..0fb5cfed 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml @@ -77,8 +77,8 @@ - To be added. - To be added. + Releases the resources used by the . + diff --git a/SkiaSharpAPI/SkiaSharp/GRContext.xml b/SkiaSharpAPI/SkiaSharp/GRContext.xml index cfc5d30a..f83b3991 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 whose pending GPU operations should be flushed. + Flushes any pending GPU work associated with the specified image. + @@ -395,9 +395,9 @@ - To be added. - To be added. - To be added. + The whose pending GPU operations should be flushed. + Flushes any pending GPU work associated with the specified surface. + diff --git a/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml b/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml index 8a0c2ccd..dc8e5c21 100644 --- a/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml +++ b/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml @@ -35,7 +35,7 @@ - + Property @@ -43,6 +43,11 @@ SkiaSharp 4.150.0.0 + + + [System.Runtime.CompilerServices.NativeInteger] + + System.IntPtr @@ -53,7 +58,7 @@ - + Property @@ -61,6 +66,11 @@ SkiaSharp 4.150.0.0 + + + [System.Runtime.CompilerServices.NativeInteger] + + System.IntPtr @@ -133,7 +143,7 @@ - + Property @@ -141,6 +151,11 @@ SkiaSharp 4.150.0.0 + + + [System.Runtime.CompilerServices.NativeInteger] + + System.IntPtr diff --git a/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml b/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml index 5541e3f6..c2d973ae 100644 --- a/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml @@ -133,7 +133,7 @@ - + Property @@ -141,6 +141,11 @@ SkiaSharp 4.150.0.0 + + + [System.Runtime.CompilerServices.NativeInteger] + + System.IntPtr diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml index de7db9df..ab114dcf 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,18 @@ - To be added. - To be added. + Specifies the Vulkan component swizzle mapping for each channel of a YCbCr sampler conversion. + @@ -37,9 +47,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 specifying how the alpha channel is mapped. + @@ -60,9 +70,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 specifying how the blue channel is mapped. + @@ -89,10 +99,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is a with identical swizzle values; otherwise, . + @@ -116,10 +126,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is a with identical swizzle values; otherwise, . + @@ -140,9 +150,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 specifying how the green channel is mapped. + @@ -164,9 +174,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -186,11 +196,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same component swizzle values. + if both instances are equal; otherwise, . + @@ -210,11 +220,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have different component swizzle values. + if the instances are not equal; otherwise, . + @@ -235,9 +245,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 specifying how the red channel is mapped. + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml new file mode 100644 index 00000000..ab3faf8c --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml @@ -0,0 +1,414 @@ + + + + + + SkiaSharp + 4.150.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.GRVkYcbcrConversionInfo> + + + + Describes a Vulkan YCbCr sampler conversion for use with Skia GPU backends. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkFilter value used for chroma reconstruction. + A VkFilter value (VK_FILTER_NEAREST or VK_FILTER_LINEAR) as a . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + SkiaSharp.GRVkYcbcrComponents + + + Gets or sets the component swizzle applied to each channel during YCbCr sampling. + A specifying the VkComponentSwizzle for each channel. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is a with the same field values; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is a with the same field values; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt64 + + + Gets or sets the external format identifier for the Vulkan image, used when is zero. + A platform-specific external format handle as a . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets a value indicating whether explicit chroma reconstruction is forced. + A non-zero value forces explicit reconstruction; 0 allows the implementation to choose. + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkFormat of the Vulkan image. + A VkFormat value as a , or 0 when using an external format. + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Int32 + + + + Returns the hash code for this instance. + A 32-bit signed integer hash code. + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + System.Boolean + + + + + + + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same field values. + if both instances are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.150.0.0 + + + System.Boolean + + + + + + + The first instance to compare. + The second instance to compare. + Determines whether two instances have different field values. + if the instances differ; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the sampler filter must match the chroma filter. + if the sampler filter must equal the chroma filter; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether linear filtering is supported for this conversion. + if linear filtering is supported; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkChromaLocation for the X chroma offset. + A VkChromaLocation value as a . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkSamplerYcbcrModelConversion value describing the YCbCr color model. + A VkSamplerYcbcrModelConversion value as a . + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkSamplerYcbcrRange value describing the nominal range of encoded values. + A VkSamplerYcbcrRange value as a (VK_SAMPLER_YCBCR_RANGE_ITU_FULL or VK_SAMPLER_YCBCR_RANGE_ITU_NARROW). + + + + + + + + Property + + SkiaSharp + 4.150.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the VkChromaLocation for the Y chroma offset. + A VkChromaLocation value as a . + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 2f9c4dc0..77379fc4 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 @@ -45,7 +46,7 @@ - + Property SkiaSharp @@ -60,72 +61,15 @@ SkiaSharp.GRVkYcbcrComponents - To be added. - To be added. - 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. + Gets or sets the Vulkan component swizzle mapping used during YCbCr conversion. + A value describing the component swizzle. + - + Property SkiaSharp @@ -148,7 +92,7 @@ - + Property SkiaSharp @@ -171,7 +115,7 @@ - + Property SkiaSharp @@ -191,82 +135,80 @@ - - - - - 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 features. This property is obsolete and has no effect. + Always returns 0. Setting this property is a no-op. + - - - - + + + + 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. + The to convert. + Implicitly converts the obsolete type to . + A with the same field values. + - - - - + + + + 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. + The to convert. + Implicitly converts a to the obsolete type. + A wrapping the same data. + - + Property SkiaSharp @@ -281,15 +223,15 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the sampler filter must match the chroma filter. + if the sampler filter must match the chroma filter; otherwise, . + - + Property SkiaSharp @@ -304,15 +246,15 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether linear filtering is supported for this YCbCr conversion. + if linear filtering is supported; otherwise, . + - + 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/SKBlender.xml b/SkiaSharpAPI/SkiaSharp/SKBlender.xml index bb9ad7a6..376a4cec 100644 --- a/SkiaSharpAPI/SkiaSharp/SKBlender.xml +++ b/SkiaSharpAPI/SkiaSharp/SKBlender.xml @@ -10,14 +10,6 @@ SkiaSharp.SKObject - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Represents a custom blending function that combines source and destination colors. diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index eb3e6d7b..f0fd5bd4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml @@ -525,14 +525,6 @@ using (var surface = SKSurface.Create(info)) { SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.Nullable(2)] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.GRRecordingContext @@ -976,12 +968,12 @@ this information. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to draw. + The top-left position on the canvas where the bitmap is drawn. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the bitmap onto the canvas at the specified coordinates. + @@ -1035,12 +1027,12 @@ this information. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to draw. + The destination rectangle on the canvas. + The sampling options controlling how pixels are filtered during scaling. + The paint to apply, or to use default paint settings. + Draws the bitmap onto the canvas, scaling it to fit the specified destination rectangle. + @@ -1095,13 +1087,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 to draw. + The rectangle within to draw. + The destination rectangle on the canvas. + The sampling options controlling how pixels are filtered during scaling. + The paint to apply, or to use default paint settings. + Draws a portion of the bitmap onto the canvas, sampling the source rectangle and scaling it to fit the destination rectangle. + @@ -1124,13 +1116,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 to draw. + The x-coordinate of the top-left corner. + The y-coordinate of the top-left corner. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the bitmap onto the canvas at the specified coordinates. + @@ -2743,12 +2735,12 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to draw. + The top-left position on the canvas where the surface is drawn. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the contents of the surface onto the canvas at the specified coordinates. + @@ -2798,13 +2790,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 to draw. + The x-coordinate of the top-left corner. + The y-coordinate of the top-left corner. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the contents of the surface onto the canvas at the specified coordinates. + @@ -2863,36 +2855,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. - - @@ -2920,70 +2882,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. - 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. - - @@ -3013,40 +2911,6 @@ using (var surface = SKSurface.Create(info)) { - - - - - 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. - To be added. - - @@ -3078,38 +2942,6 @@ using (var surface = SKSurface.Create(info)) { - - - - - 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 +2976,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. - - @@ -3990,11 +3754,6 @@ safely ignored. SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Int32 @@ -4017,11 +3776,6 @@ safely ignored. SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Int32 @@ -4143,32 +3897,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. - - @@ -4276,14 +4004,6 @@ guaranteed to happen. If exact clipping is desired, use SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.Nullable(2)] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKSurface diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml b/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml index 47b024f6..c2c32c70 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml @@ -10,14 +10,6 @@ System.ValueType - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(2)] - - Contains the configuration for saving a layer on an . diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index f56d6a21..0f37da05 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml @@ -32,11 +32,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The CICP color primaries identifying the red, green, and blue chromaticities. + The CICP transfer function describing the opto-electronic conversion. + Creates a color space defined by a CICP (ITU-T H.273) primaries and transfer function pair. + An representing the specified CICP color space, or if the combination is not supported by Skia. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 0e983c27..fa34fe8a 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -130,7 +130,7 @@ 25 - To be added. + Four-channel BGRA color type where each channel is stored as a 10-bit extended-range (XR) value, packed into a 64-bit word. @@ -198,7 +198,7 @@ 27 - To be added. + Single-channel color type storing a 16-bit unsigned normalized value in the red channel. @@ -232,7 +232,7 @@ 28 - To be added. + Single-channel color type storing a 16-bit floating-point value in the red channel. @@ -453,7 +453,7 @@ 26 - To be added. + Three-channel RGB color type using 16-bit floating-point values per channel, with a fourth 16-bit padding channel. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 18faa3f5..f795b304 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,25 @@ System.Enum - To be added. - To be added. + Specifies CICP (ITU-T H.273) color primaries for creating a color space. + to create a color space +from a CICP primaries and transfer function pair. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +45,7 @@ 8 - To be added. + Generic film color primaries (CICP value 8). @@ -45,7 +62,7 @@ 22 - To be added. + EBU Tech 3213-E color primaries as specified in ITU-T H.273 (CICP value 22). @@ -62,7 +79,7 @@ 9 - To be added. + ITU-R BT.2020 color primaries, used for ultra-high-definition video (CICP value 9). @@ -79,7 +96,7 @@ 5 - To be added. + ITU-R BT.470 System B/G (PAL/SECAM) color primaries (CICP value 5). @@ -96,7 +113,7 @@ 4 - To be added. + ITU-R BT.470 System M (NTSC) color primaries (CICP value 4). @@ -113,7 +130,7 @@ 6 - To be added. + ITU-R BT.601 color primaries, used for standard-definition video (CICP value 6). @@ -130,7 +147,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for HDTV and sRGB (CICP value 1). @@ -147,7 +164,7 @@ 12 - To be added. + SMPTE EG 432-1 (Display P3 with D65 white point) color primaries (CICP value 12). @@ -164,7 +181,7 @@ 11 - To be added. + SMPTE RP 431-2 (DCI-P3 with DCI white point) color primaries (CICP value 11). @@ -181,7 +198,7 @@ 7 - To be added. + SMPTE ST 240 color primaries (CICP value 7). @@ -198,7 +215,7 @@ 10 - To be added. + SMPTE ST 428-1 (CIE 1931 XYZ) color primaries (CICP value 10). @@ -215,7 +232,7 @@ 0 - To be added. + Reserved or unknown color primaries (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index 30612a63..c74b38af 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,25 @@ System.Enum - To be added. - To be added. + Specifies CICP (ITU-T H.273) transfer characteristics for creating a color space. + to create a color space +from a CICP primaries and transfer function pair. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Hlg); +``` +]]> @@ -28,7 +45,7 @@ 18 - To be added. + ITU-R BT.2100 hybrid log-gamma (HLG) transfer function for HDR (CICP value 18). @@ -45,7 +62,7 @@ 13 - To be added. + IEC 61966-2-1 (sRGB or sYCC) transfer characteristics (CICP value 13). @@ -62,7 +79,7 @@ 11 - To be added. + IEC 61966-2-4 (xvYCC) transfer characteristics (CICP value 11). @@ -79,7 +96,7 @@ 8 - To be added. + Linear transfer characteristics with no gamma encoding (CICP value 8). @@ -96,7 +113,7 @@ 16 - To be added. + SMPTE ST 2084 perceptual quantizer (PQ) transfer function for HDR (CICP value 16). @@ -113,7 +130,7 @@ 14 - To be added. + ITU-R BT.2020 transfer characteristics for 10-bit content (CICP value 14). @@ -130,7 +147,7 @@ 15 - To be added. + ITU-R BT.2020 transfer characteristics for 12-bit content (CICP value 15). @@ -147,7 +164,7 @@ 5 - To be added. + ITU-R BT.470 System B/G assumed display gamma transfer characteristics (CICP value 5). @@ -164,7 +181,7 @@ 4 - To be added. + ITU-R BT.470 System M assumed display gamma transfer characteristics (CICP value 4). @@ -181,7 +198,7 @@ 6 - To be added. + ITU-R BT.601 transfer characteristics, used for standard-definition video (CICP value 6). @@ -198,7 +215,7 @@ 1 - To be added. + ITU-R BT.709 transfer characteristics, used for HDTV (CICP value 1). @@ -215,7 +232,7 @@ 7 - To be added. + SMPTE ST 240 transfer characteristics (CICP value 7). @@ -232,7 +249,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer characteristics (CICP value 17). @@ -249,7 +266,7 @@ 0 - To be added. + Reserved or unknown transfer characteristics (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocument.xml b/SkiaSharpAPI/SkiaSharp/SKDocument.xml index 857b7278..ed79a604 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. - To be added. - To be added. - To be added. - To be added. + The managed to write the XPS document to. + The XPS options controlling DPI and other settings. + Creates an XPS document that writes to the specified managed stream using the provided options. + A new for writing XPS content, or on failure. + @@ -451,11 +451,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The managed to write the XPS document to. + The XPS options controlling DPI and other settings. + Creates an XPS document that writes to the specified managed stream using the provided options. + A new for writing XPS content, or on failure. + @@ -499,11 +499,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The file path to which the XPS document is written. + The XPS options controlling DPI and other settings. + Creates an XPS document that writes to the specified file path using the provided options. + A new for writing XPS content, or on failure. + diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index 3803e719..53792c1c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,14 @@ - To be added. - To be added. + Specifies options for creating an XPS document. + . Pass this struct to the overloads that accept +options to control the document resolution and PNG embedding behavior. +]]> @@ -37,9 +43,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether PNG images may be omitted from the XPS document. + to allow the encoder to skip PNG images; to always include them. + @@ -60,9 +66,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the resolution of the XPS document in dots per inch. + The DPI value used to map Skia coordinate units to physical document units. The default is 72 DPI. + @@ -89,10 +95,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -116,10 +122,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -141,9 +147,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -163,11 +169,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same values. + if and are equal; otherwise, . + @@ -187,11 +193,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have different values. + if and differ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 0c8e167e..9e475f51 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -11,16 +11,44 @@ - - [System.Runtime.CompilerServices.CompilerFeatureRequired("RefStructs")] - [System.Runtime.CompilerServices.IsByRefLike] - To be added. - To be added. + Specifies arguments for creating or cloning a typeface with variation and palette settings. + to produce a customized +typeface instance. + +Because `SKFontArguments` is a `ref struct`, it cannot be stored on the heap and must be used +within the same stack frame where the spans it holds are valid. + +## Examples + +```csharp +var coords = new SKFontVariationPositionCoordinate[] +{ + new() { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, +}; +var overrides = new SKFontPaletteOverride[] +{ + new() { Index = 0, Color = 0xFFFF0000 }, // override first color with red +}; +var args = new SKFontArguments +{ + CollectionIndex = 0, + PaletteIndex = 1, + VariationDesignPosition = coords, + PaletteOverrides = overrides, +}; +using var clone = typeface.Clone(args); +``` +]]> @@ -41,9 +69,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the desired typeface within a font collection (TTC). + The collection index, or 0 for non-collection fonts. + @@ -64,9 +92,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the color palette to use. + The palette index to activate in the resulting typeface. + @@ -87,9 +115,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the span of palette color overrides to apply on top of the selected palette. + A read-only span of values, each replacing one palette color entry. + @@ -110,9 +138,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation design coordinates that define the position within the font's variation space. + A read-only span of values, one per axis to override. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index a7fd7ef2..4532f014 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,15 @@ - To be added. - To be added. + Represents a palette color override that replaces a specific color entry in a font's color palette. + or . +Set to the zero-based palette color +slot and to the replacement ARGB color. +]]> @@ -37,9 +44,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color for the palette entry. + An ARGB color value (0xAARRGGBB) that replaces the color at . + @@ -66,10 +73,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -93,10 +100,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -118,9 +125,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -141,9 +148,9 @@ System.UInt16 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the palette color entry to override. + The index of the color slot within the font's color palette. + @@ -163,11 +170,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same values. + if and are equal; otherwise, . + @@ -187,11 +194,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have different values. + if and differ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 4984d640..d428f6a1 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,18 @@ - To be added. - To be added. + Describes a single variation axis of an OpenType variable font. + or + to retrieve the axes for a typeface. + +To set a variation axis value, create an +with the axis and the desired value, then +pass the coordinates to . +]]> @@ -37,9 +47,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default value of this variation axis. + The default design-space value applied when no override is specified for this axis. + @@ -66,10 +76,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -93,10 +103,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -118,9 +128,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -141,9 +151,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this axis is hidden from user interfaces. + if the axis is tagged as hidden in the font; otherwise, . + @@ -164,9 +174,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum allowed value for this variation axis. + The upper bound of the design-space range for this axis. + @@ -187,9 +197,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum allowed value for this variation axis. + The lower bound of the design-space range for this axis. + @@ -209,11 +219,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same values. + if and are equal; otherwise, . + @@ -233,11 +243,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have different values. + if and differ; otherwise, . + @@ -258,9 +268,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag identifying this variation axis. + An such as 'wght' for weight or 'ital' for italic. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index 5ce3933c..9a81b2b9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,15 @@ - To be added. - To be added. + Represents a single variation axis coordinate in a font's variation design space. + to produce a typeface with specific axis +settings. +]]> @@ -37,9 +44,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag identifying the variation axis. + An such as 'wght' for weight or 'wdth' for width. + @@ -66,10 +73,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -93,10 +100,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same field values; otherwise, . + @@ -118,9 +125,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code. + @@ -140,11 +147,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have the same values. + if and are equal; otherwise, . + @@ -164,11 +171,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two instances have different values. + if and differ; otherwise, . + @@ -189,9 +196,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the variation axis. + A floating-point value within the allowed range defined by the corresponding . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index b5b7f7fb..edf50b93 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,36 @@ - To be added. - To be added. + Represents a four-byte tag packed into a 32-bit unsigned integer in big-endian byte order. + @@ -37,9 +65,9 @@ - To be added. - To be added. - To be added. + The raw unsigned integer representing the four-byte tag. + Initializes a new instance of the struct from a raw 32-bit value. + @@ -58,12 +86,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The first character, stored in the high byte. + The second character. + The third character. + The fourth character, stored in the low byte. + Initializes a new instance of the struct from four individual characters. + @@ -85,10 +113,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with this instance. + Determines whether this instance and the specified have the same value. + if both tags represent the same packed value; otherwise, . + @@ -100,11 +128,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Boolean @@ -112,10 +135,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with this instance. + Determines whether this instance and the specified object are equal. + if is an with the same packed value; otherwise, . + @@ -132,9 +155,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for this instance. + A 32-bit signed integer hash code derived from the packed tag value. + @@ -154,11 +177,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tag to compare. + The second tag to compare. + Determines whether two instances are equal. + if and have the same packed value; otherwise, . + @@ -177,10 +200,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Implicitly converts an to its raw 32-bit unsigned integer representation. + The packed tag value. + @@ -199,10 +222,10 @@ - To be added. - To be added. - To be added. - To be added. + The raw unsigned integer tag value. + Implicitly converts a raw 32-bit unsigned integer to an . + An backed by the specified raw value. + @@ -222,11 +245,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tag to compare. + The second tag to compare. + Determines whether two instances are not equal. + if and have different packed values; otherwise, . + @@ -238,11 +261,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKFourByteTag @@ -250,10 +268,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. Only the first four characters are used; shorter strings are padded with spaces. or empty strings return a zero-valued tag. + Creates an by parsing a string of up to four characters. + An representing the parsed tag; strings shorter than four characters are padded with spaces. + @@ -265,19 +283,14 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - System.String - To be added. - To be added. - To be added. + Returns the four-character string representation of this tag. + A four-character string formed by unpacking the four bytes of the tag value in big-endian order. + 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..b61a10ab 100644 --- a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml +++ b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml @@ -10,14 +10,6 @@ SkiaSharp.SKObject - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Image filters for use with the property of a . @@ -41,13 +33,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The first arithmetic blend coefficient. @@ -70,18 +56,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -114,18 +90,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -165,13 +131,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The custom blender to use. @@ -195,13 +155,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The blend mode to use. @@ -225,20 +179,8 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + + The custom blender to use. @@ -258,18 +200,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -299,20 +231,8 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + + @@ -334,18 +254,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -402,13 +312,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The Gaussian blur standard deviation in the X direction. @@ -460,13 +364,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -495,13 +393,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The Gaussian blur standard deviation in the X direction. @@ -529,13 +421,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -585,13 +471,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The color filter to apply. @@ -615,13 +495,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -696,13 +570,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The morphology radius in the X direction. @@ -728,13 +596,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -792,13 +654,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The color channel to use for X displacement. @@ -828,13 +684,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -894,13 +744,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The direction of the light. @@ -930,13 +774,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -999,13 +837,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The direction of the light. @@ -1037,13 +869,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1107,13 +933,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The X offset of the shadow. @@ -1145,13 +965,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1215,13 +1029,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The X offset of the shadow. @@ -1253,13 +1061,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1314,13 +1116,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The morphology radius in the X direction. @@ -1346,13 +1142,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1411,39 +1201,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. - - @@ -1517,13 +1274,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The bounds of the magnifier lens. @@ -1553,13 +1304,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1602,33 +1347,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 +1377,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. - - @@ -1717,13 +1398,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The transformation matrix. @@ -1743,18 +1418,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -1787,18 +1452,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -1808,13 +1463,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The size of the convolution kernel. @@ -1839,18 +1488,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -1860,13 +1499,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -1897,13 +1530,7 @@ SkiaSharp.SKImageFilter - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - - - + The array of image filters to merge. @@ -1921,18 +1548,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -1959,13 +1576,7 @@ SkiaSharp.SKImageFilter - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - - - + @@ -1985,27 +1596,11 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - - - - - [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] - - - + @@ -2025,18 +1620,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKImageFilter - - - [System.Runtime.CompilerServices.Nullable(1)] - - @@ -2091,13 +1676,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The morphology radius in the X direction. @@ -2123,13 +1702,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2142,62 +1715,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. - - @@ -2289,13 +1806,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The position of the light. @@ -2325,13 +1836,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2394,13 +1899,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The position of the light. @@ -2432,13 +1931,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2467,13 +1960,7 @@ SkiaSharp.SKImageFilter - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The shader to use. @@ -2495,13 +1982,7 @@ SkiaSharp.SKImageFilter - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2525,13 +2006,7 @@ SkiaSharp.SKImageFilter - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2598,13 +2073,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The position of the light. @@ -2640,13 +2109,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2721,13 +2184,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The position of the light. @@ -2765,13 +2222,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + @@ -2829,13 +2280,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The pixels to tile. diff --git a/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml b/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml index eadbc77e..c569d75d 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 when computing the mask. The shader's output alpha channel defines the mask. + Creates a mask filter that uses the specified shader to generate the mask alpha channel. + A new that applies as a mask. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 0ffc3a18..9ff62841 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 that receives the filled path. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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 that receives the filled path. + A transformation matrix applied when computing the fill path. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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 that receives the filled path. + An optional rectangle used to cull distant path segments and improve performance. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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 that receives the filled path. + A scaling factor used to determine how finely curved segments are approximated. Use 1.0 for screen resolution. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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 that receives the filled path. + An optional rectangle used to cull distant path segments and improve performance. + A transformation matrix applied when computing the fill path. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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 that receives the filled path. + An optional rectangle used to cull distant path segments and improve performance. + A scaling factor used to determine how finely curved segments are approximated. Use 1.0 for screen resolution. + Applies the paint's fill settings to and writes the result into the destination path builder. + if the resulting fill path is non-empty; 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..dad1a00f 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 native handle to the underlying Skia path object. + A pointer to the native sk_path_t structure managed by Skia. + @@ -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..3e1f3d22 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,39 @@ - To be added. - To be added. + Provides a mutable builder for incrementally constructing an . + via or +. It is the preferred way to construct complex paths +incrementally and is also the type accepted by methods such as + and +. + +Call `Snapshot()` to obtain a path while keeping the builder's geometry intact for further +modifications. Call `Detach()` to transfer ownership of the geometry to the new path and +reset the builder in one step. Use `Reset()` to discard all geometry and start fresh. + +All coordinates are in the coordinate system active at the time of the call. Relative methods +(prefixed with `R`) add points relative to the current point. + +`SKPathBuilder` is a disposable object. Always dispose it or use a `using` block. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(0, 0); +builder.LineTo(100, 0); +builder.LineTo(100, 100); +builder.LineTo(0, 100); +builder.Close(); +using var path = builder.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +57,8 @@ - To be added. - To be added. + Initializes a new, empty with no geometry. + @@ -43,9 +74,9 @@ - To be added. - To be added. - To be added. + The whose geometry is copied into this builder. + Initializes a new with a copy of the geometry from an existing path. + @@ -66,11 +97,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The start angle in degrees, measured clockwise from the positive x-axis. + The sweep angle in degrees. + Appends a complete or partial arc of an oval as a new contour. + @@ -92,12 +123,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the circle's center. + The y-coordinate of the circle's center. + The radius of the circle. + The direction in which the circle contour is wound. + Appends a circle as a new closed contour. + @@ -117,10 +148,10 @@ - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The direction in which the contour is wound. + Appends an oval (ellipse) as a new closed contour. + @@ -140,10 +171,10 @@ - To be added. - To be added. - To be added. - To be added. + The to append. + Specifies how the appended path is connected to the current geometry. + Appends the geometry from another path to this builder. + @@ -170,11 +201,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to append. + The transformation matrix to apply to the source path's geometry. + Specifies how the appended path is connected to the current geometry. + Appends the geometry from another path, transformed by a matrix, to this builder. + @@ -196,12 +227,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to append. + The x-axis offset to apply. + The y-axis offset to apply. + Specifies how the appended path is connected to the current geometry. + Appends the geometry from another path, offset by the specified amount, to this builder. + @@ -221,10 +252,10 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + to close the polygon by connecting the last point back to the first; to leave it open. + Appends a polygon defined by the given points as a new contour. + @@ -244,10 +275,10 @@ - To be added. - To be added. - To be added. - To be added. + The vertices of the polygon. + to close the polygon by connecting the last point back to the first; to leave it open. + Appends a polygon defined by the given points as a new contour. + @@ -267,10 +298,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + The direction in which the contour is wound. + Appends a rectangle as a new closed contour. + @@ -291,11 +322,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + The direction in which the contour is wound. + The index of the vertex at which winding starts (0–3). + Appends a rectangle as a new closed contour. + @@ -315,10 +346,10 @@ - To be added. - To be added. - To be added. - To be added. + The to add. + The direction in which the contour is wound. + Appends a rounded rectangle as a new closed contour. + @@ -339,11 +370,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The to add. + The direction in which the contour is wound. + The index of the vertex at which winding starts. + Appends a rounded rectangle as a new closed contour. + @@ -365,12 +396,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle. + The x-radius of each corner. + The y-radius of each corner. + The direction in which the contour is wound. + Appends a rounded rectangle as a new closed contour, with independent x and y corner radii. + @@ -391,11 +422,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point defining the corner of the arc. + The second tangent point defining the end direction of the arc. + The radius of the tangent arc. + Appends a tangent arc from the current point toward and then toward , with the specified radius. + @@ -417,12 +448,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval that defines the arc. + The start angle of the arc in degrees, measured clockwise from the positive x-axis. + The sweep angle in degrees. Positive values sweep clockwise. + to begin a new contour at the start of the arc; to connect from the current point with a line if needed. + Appends an arc defined by the given oval rectangle, starting at and sweeping degrees. + @@ -445,13 +476,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 and y-radius). + The rotation of the ellipse's x-axis relative to the current coordinate system, in degrees. + Specifies which of two possible arcs to use (the larger or the smaller). + Specifies whether the arc is drawn in the positive-angle or negative-angle direction. + The endpoint of the arc. + Appends an SVG-style arc from the current point to the specified endpoint. + @@ -474,13 +505,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 tangent arc. + Appends a tangent arc from the current point, using coordinate pairs for the two tangent points. + @@ -505,15 +536,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 which of the two possible arcs to use. + Specifies the arc sweep direction. + The x-coordinate of the endpoint. + The y-coordinate of the endpoint. + Appends an SVG-style arc from the current point to the specified endpoint, using individual scalar parameters. + @@ -530,8 +561,8 @@ - To be added. - To be added. + Closes the current contour by appending a straight line from the current point back to the contour's start point. + @@ -552,11 +583,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point. + The control point. + The weight of the conic, where 1 produces a quadratic curve, less than 1 an ellipse, and greater than 1 a hyperbola. + Appends a conic (rational quadratic Bézier) curve from the current point using a control point, an endpoint, and a weight. + @@ -579,13 +610,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 control point. + The y-coordinate of the control point. + The weight of the conic. + Appends a conic (rational quadratic Bézier) curve from the current point to the specified endpoint, guided by a control point and weight. + @@ -606,11 +637,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point. + The first control point. + The second control point. + Appends a cubic Bézier curve from the current point using two control points and an endpoint. + @@ -634,14 +665,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 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. + Appends a cubic Bézier curve from the current point to the specified endpoint, guided by two control points. + @@ -658,9 +689,9 @@ - To be added. - To be added. - To be added. + Builds an from the current geometry and resets this builder to an empty state. + A new containing the geometry that was in the builder. The builder is reset after this call. + @@ -679,9 +710,9 @@ - To be added. - To be added. - To be added. + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the resources used by the . + @@ -698,8 +729,8 @@ - To be added. - To be added. + Releases the underlying native path builder handle. + @@ -715,9 +746,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type that determines how the path's interior is defined. + One of the values. The default is . + @@ -736,9 +767,9 @@ - To be added. - To be added. - To be added. + The endpoint of the line. + Appends a straight line from the current point to the specified point. + @@ -758,10 +789,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the endpoint. + The y-coordinate of the endpoint. + Appends a straight line from the current point to the specified coordinates. + @@ -780,9 +811,9 @@ - To be added. - To be added. - To be added. + The destination point. + Moves the current point to the specified point, starting a new contour. + @@ -802,10 +833,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the destination point. + The y-coordinate of the destination point. + Moves the current point to the specified coordinates, starting a new contour. + @@ -825,10 +856,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point. + The endpoint of the curve. + Appends a quadratic Bézier curve from the current point using a control point and an endpoint. + @@ -850,12 +881,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the endpoint. + The y-coordinate of the endpoint. + Appends a quadratic Bézier curve from the current point to the specified endpoint, guided by a control point. + @@ -878,13 +909,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 and y-radius). + The rotation of the ellipse's x-axis in degrees. + Specifies which arc to use (large or small). + Specifies the sweep direction. + The offset from the current point to the endpoint. + Appends an SVG-style arc using endpoint coordinates relative to the current point. + @@ -909,15 +940,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 which arc to use (large or small). + Specifies the sweep direction. + The x offset from the current point to the endpoint. + The y offset from the current point to the endpoint. + Appends an SVG-style arc using endpoint coordinates relative to the current point. + @@ -938,11 +969,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 control point. + The weight of the conic. + Appends a conic curve using offsets relative to the current point. + @@ -965,13 +996,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the control point. + The y offset to the control point. + The x offset to the control point. + The y offset to the control point. + The weight of the conic. + Appends a conic curve using offsets relative to the current point. + @@ -992,11 +1023,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 first control point. + The offset from the current point to the second control point. + Appends a cubic Bézier curve using offsets relative to the current point. + @@ -1020,14 +1051,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the first control point. + The y offset to the first control point. + The x offset to the first control point. + The y offset to the first control point. + The x offset to the second control point. + The y offset to the second control point. + Appends a cubic Bézier curve using offsets relative to the current point. + @@ -1044,8 +1075,8 @@ - To be added. - To be added. + Discards all geometry in this builder and resets it to an empty state. + @@ -1064,9 +1095,9 @@ - To be added. - To be added. - To be added. + The whose geometry is appended in reverse. + Appends the geometry from another path in reverse order to this builder. + @@ -1085,9 +1116,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the endpoint. + Appends a line from the current point to a point offset by the specified amount. + @@ -1107,10 +1138,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-axis offset to the endpoint. + The y-axis offset to the endpoint. + Appends a line from the current point to a point offset by the specified amount. + @@ -1129,9 +1160,9 @@ - To be added. - To be added. - To be added. + The offset from the current point. + Moves the current point by the specified offset relative to the current point, starting a new contour. + @@ -1151,10 +1182,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-axis offset from the current point. + The y-axis offset from the current point. + Moves the current point by the specified offset relative to the current point, starting a new contour. + @@ -1174,10 +1205,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 control point. + Appends a quadratic Bézier curve using offsets relative to the current point. + @@ -1199,12 +1230,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x offset to the control point. + The y offset to the control point. + The x offset to the control point. + The y offset to the control point. + Appends a quadratic Bézier curve using offsets relative to the current point. + @@ -1221,9 +1252,9 @@ - To be added. - To be added. - To be added. + Builds an from the current geometry without modifying this builder. + A new containing the current geometry. The builder is unchanged and can continue to be used. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index d058fcfb..30ae1123 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -297,13 +297,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The distance along the path at which to start the segment. + The distance along the path at which to end the segment. + The to which the extracted segment is appended. + to prepend a move-to command at the start of the extracted segment; to omit it. + Extracts the path segment between two distances along the measured path and appends it to the destination builder. + if a non-empty segment was extracted and appended to ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml index f8e1cab9..0697b947 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml @@ -10,14 +10,6 @@ SkiaSharp.SKObject - - - [System.Runtime.CompilerServices.Nullable(0)] - - - [System.Runtime.CompilerServices.NullableContext(1)] - - Pairs with actual pixels and rowbytes. This class does not try to manage the lifetime of the pixel memory (nor the color table if provided). @@ -179,14 +171,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.Nullable(2)] - - - [get: System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKColorSpace @@ -300,11 +284,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKData @@ -327,11 +306,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKData @@ -354,11 +328,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKData @@ -381,11 +350,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKData @@ -698,11 +662,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKPixmap @@ -864,11 +823,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Span<System.Byte> @@ -888,11 +842,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Span<System.Byte> @@ -917,11 +866,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Span<T> @@ -932,11 +876,6 @@ NotNullableValueTypeConstraint System.ValueType - - - [System.Runtime.CompilerServices.IsUnmanaged] - - @@ -956,11 +895,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(0)] - - System.Span<T> @@ -971,11 +905,6 @@ NotNullableValueTypeConstraint System.ValueType - - - [System.Runtime.CompilerServices.IsUnmanaged] - - @@ -1232,35 +1161,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/SKRuntimeEffectUniform.xml b/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml index a3b7c60b..0ed7aa99 100644 --- a/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml +++ b/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml @@ -11,9 +11,6 @@ - - [System.Runtime.CompilerServices.CompilerFeatureRequired("RefStructs")] - [System.Runtime.CompilerServices.IsByRefLike] 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..6d79cebf 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 content of this stream as an object. + An instance containing all data from the stream. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index bfaf672b..7919671b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -1653,12 +1653,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The on which to draw. + The top-left position on the canvas where the surface is drawn. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the surface contents onto the specified canvas at the given coordinates. + @@ -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 on which to draw. + The x-coordinate of the top-left corner. + The y-coordinate of the top-left corner. + The sampling options controlling how pixels are filtered. + The paint to apply, or to use default paint settings. + Draws the surface contents onto the specified canvas at the given coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml b/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml index 9c6ea096..6341b6c6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml @@ -42,11 +42,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - System.Int32 @@ -75,21 +70,10 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -110,18 +94,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -148,22 +122,11 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -185,18 +148,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -227,21 +180,10 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -264,29 +206,13 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - - - + @@ -310,22 +236,11 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -351,23 +266,12 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -392,27 +296,11 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - - - + @@ -438,18 +326,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -478,27 +356,11 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - - - + @@ -526,18 +388,8 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - @@ -572,21 +424,10 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -607,29 +448,13 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - - - + The text to shape and render. @@ -651,22 +476,11 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -690,23 +504,12 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -731,21 +534,10 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -766,29 +558,13 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(0)] - - - + The text to shape and render. @@ -810,22 +586,11 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -849,23 +614,12 @@ SkiaSharp.SKTextBlob - - - [System.Runtime.CompilerServices.Nullable(2)] - - - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -910,24 +664,13 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - System.Single[] - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The upper Y bound of the horizontal band. @@ -954,13 +697,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(2)] - - - + The upper Y bound of the horizontal band. diff --git a/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml index 484f2e6e..c8867e64 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml @@ -44,13 +44,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -77,22 +71,10 @@ - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -120,13 +102,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -151,13 +127,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -182,13 +152,7 @@ - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -208,11 +172,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKHorizontalRunBuffer @@ -241,11 +200,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKHorizontalTextRunBuffer @@ -276,11 +230,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKPositionedRunBuffer @@ -307,11 +256,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKPositionedTextRunBuffer @@ -344,13 +288,7 @@ SkiaSharp.SKRawRunBuffer<System.Single> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -378,13 +316,7 @@ SkiaSharp.SKRawRunBuffer<System.Single> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -414,13 +346,7 @@ SkiaSharp.SKRawRunBuffer<SkiaSharp.SKPoint> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -446,13 +372,7 @@ SkiaSharp.SKRawRunBuffer<SkiaSharp.SKPoint> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -480,13 +400,7 @@ SkiaSharp.SKRawRunBuffer<SkiaSharp.SKRotationScaleMatrix> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -512,13 +426,7 @@ SkiaSharp.SKRawRunBuffer<SkiaSharp.SKRotationScaleMatrix> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -546,13 +454,7 @@ SkiaSharp.SKRawRunBuffer<System.Single> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -582,13 +484,7 @@ SkiaSharp.SKRawRunBuffer<System.Single> - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + @@ -616,11 +512,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKRotationScaleRunBuffer @@ -647,11 +538,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKRotationScaleTextRunBuffer @@ -680,11 +566,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKRunBuffer @@ -715,11 +596,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKTextRunBuffer @@ -752,11 +628,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(2)] - - SkiaSharp.SKTextBlob diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index 652aa14f..5333d7d0 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. + A ref struct specifying the variation position, collection index, palette index, and palette color overrides. + Creates a new from this typeface with the variation position, collection index, palette, and palette overrides specified by the font arguments. + A new instance with the specified 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. + Creates a new from this typeface with the specified palette index. + A new instance using 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. + The variation design coordinates to apply, one per axis. + Creates a new from this typeface with the specified variation design position. + A new instance with the variation axes set to the given design coordinates. + @@ -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 the empty typeface singleton, which contains no glyphs. + The shared empty instance. This object is immortal and must not be disposed. + @@ -1076,10 +1076,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + The span to fill with variation axis information. + Fills the provided span with the variation axis parameters defined by this typeface. + The number of values written into . + @@ -1098,10 +1098,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + The span to fill with the current design coordinates, one per variation axis. + Fills the provided span with the current variation design coordinates for this typeface. + The number of values written into . + @@ -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 contains no glyphs. + if the typeface has a glyph count of zero; 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 axes defined by this typeface. + The number of variation axes available in the typeface, or 0 if the typeface has no variation data. + @@ -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 an array describing all variation axes defined by this typeface. + An array of values, one per variation axis. + @@ -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 an array containing the current variation design coordinates for this typeface. + An array of values representing the current axis settings. + @@ -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 variation design coordinates currently set for this typeface. + The number of variation axes for which a design coordinate is defined. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7930b162..b0e462c3 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,8 @@ - To be added. - To be added. + Provides methods for encoding images in WebP format, including animated WebP. + @@ -24,29 +24,19 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - SkiaSharp.SKData - - - [System.Runtime.CompilerServices.Nullable(2)] - - - To be added. - To be added. - To be added. - To be added. - To be added. + The containing the pixel data to encode. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided pixmap as a WebP image and returns the result as . + An containing the encoded WebP, or on failure. + @@ -58,11 +48,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - System.Boolean @@ -72,12 +57,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the encoded WebP data is written. + The containing the pixel data to encode. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided pixmap as a WebP image and writes the result to the specified Skia write stream. + if encoding succeeded; otherwise, . + @@ -89,11 +74,6 @@ SkiaSharp 4.150.0.0 - - - [System.Runtime.CompilerServices.NullableContext(1)] - - System.Boolean @@ -103,12 +83,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the encoded WebP data is written. + The containing the pixel data to encode. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided pixmap as a WebP image and writes the result to the specified managed stream. + if encoding succeeded; otherwise, . + @@ -122,22 +102,17 @@ SkiaSharp.SKData - - - [System.Runtime.CompilerServices.Nullable(2)] - - - To be added. - To be added. - To be added. - To be added. - To be added. + The sequence of values that define each animation frame. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided frames as an animated WebP image and returns the result as . + An containing the encoded animated WebP, or on failure. + @@ -153,23 +128,17 @@ System.Boolean - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the encoded WebP data is written. + The sequence of values that define each animation frame. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided frames as an animated WebP image and writes the result to the specified Skia write stream. + if encoding succeeded; otherwise, . + @@ -185,23 +154,17 @@ System.Boolean - - - - [System.Runtime.CompilerServices.Nullable(1)] - - - + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to which the encoded WebP data is written. + The sequence of values that define each animation frame. + The encoding options controlling quality, method, and other WebP parameters. + Encodes the provided frames as an animated WebP image 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..9ea75ad0 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,32 @@ - To be added. - To be added. + Represents a single frame of an animated WebP image, combining pixel data with a display duration. + to produce the animated file. + +The frame holds an internally. When constructing from an + or , `PeekPixels()` is called to obtain +the pixmap; the source object must remain alive for the lifetime of the frame, and the +underlying image must be raster-backed (not GPU-only). + +## Examples + +```csharp +using var bitmap1 = /* first frame */ SKBitmap.Decode("frame1.png"); +using var bitmap2 = /* second frame */ SKBitmap.Decode("frame2.png"); +var frames = new SKWebpEncoderFrame[] +{ + new(bitmap1, TimeSpan.FromMilliseconds(100)), + new(bitmap2, TimeSpan.FromMilliseconds(100)), +}; +var encoded = SKWebpEncoder.Encode(frames, new SKWebpEncoderOptions()); +``` +]]> @@ -29,10 +53,10 @@ - To be added. - To be added. - To be added. - To be added. + The whose pixels are used for this frame. The bitmap must remain alive for the lifetime of this frame. + The length of time this frame is displayed. + Initializes a new from a bitmap and a display duration. + @@ -49,10 +73,10 @@ - To be added. - To be added. - To be added. - To be added. + The whose pixels are used for this frame. The image must be raster-backed and remain alive for the lifetime of this frame. + The length of time this frame is displayed. + Initializes a new from a raster-backed image and a display duration. + @@ -69,10 +93,10 @@ - To be added. - To be added. - To be added. - To be added. + The containing the pixel data for this frame. + The length of time this frame is displayed. + Initializes a new from a pixmap and a display duration. + @@ -93,9 +117,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets the display duration of this frame. + The specifying how long this frame is shown in the animated WebP. + @@ -116,9 +140,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets the pixel data for this frame. + The containing the pixel data used when encoding 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..91de48b1 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -432,6 +432,10 @@ + + + + @@ -1058,7 +1062,7 @@ - + @@ -1082,7 +1086,7 @@ - + @@ -1106,7 +1110,7 @@ - + @@ -1352,30 +1356,6 @@ - - - - - - - - - ExtensionMethod - - SkiaSharp.SKSamplingOptions - - - - - - To be added. - To be added. - To be added. - To be added. - - - - diff --git a/SkiaSharpAPI/ns-SkiaSharp.Views.Blazor.Internal.xml b/SkiaSharpAPI/ns-SkiaSharp.Views.Blazor.Internal.xml new file mode 100644 index 00000000..d0a82240 --- /dev/null +++ b/SkiaSharpAPI/ns-SkiaSharp.Views.Blazor.Internal.xml @@ -0,0 +1,6 @@ + + + Provides internal infrastructure types for the SkiaSharp Blazor views component. + + +