From bae371b41289ad9d51aada590dac7ff980d5a654 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 3 Jun 2026 10:11:15 +0000 Subject: [PATCH] Fill API documentation placeholders Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../FrameworksIndex/harfbuzzsharp-14.2.xml | 920 ++++++++++++++++++ .../FrameworksIndex/harfbuzzsharp-8.3.xml | 27 - .../FrameworksIndex/skiasharp-4.147.xml | 34 +- .../skiasharp-harfbuzz-4.147.xml | 7 + .../FrameworksIndex/skiasharp-views-3.119.xml | 27 +- .../PlatformConfiguration.xml | 2 +- SkiaSharpAPI/HarfBuzzSharp/Blob.xml | 6 +- SkiaSharpAPI/HarfBuzzSharp/Face.xml | 198 ++-- SkiaSharpAPI/HarfBuzzSharp/Feature.xml | 14 +- SkiaSharpAPI/HarfBuzzSharp/Font.xml | 48 +- SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml | 12 +- SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml | 14 +- SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml | 12 +- SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml | 14 +- SkiaSharpAPI/HarfBuzzSharp/HBColor.xml | 367 +++++++ .../HarfBuzzSharp/OpenTypeColorLayer.xml | 10 +- .../HarfBuzzSharp/OpenTypeMathGlyphPart.xml | 16 +- .../OpenTypeMathGlyphVariant.xml | 10 +- .../HarfBuzzSharp/OpenTypeNameEntry.xml | 12 +- .../HarfBuzzSharp/OpenTypeVarAxis.xml | 16 +- .../HarfBuzzSharp/OpenTypeVarAxisInfo.xml | 20 +- SkiaSharpAPI/HarfBuzzSharp/Variation.xml | 10 +- .../SkiaSharp.HarfBuzz/ColorExtensions.xml | 147 +++ .../CachingResourceProvider.xml | 4 +- .../DataUriResourceProvider.xml | 4 +- .../FileResourceProvider.xml | 4 +- .../SkiaSharp.Resources/ResourceProvider.xml | 4 +- SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml | 22 +- .../SkiaSharp.Skottie/AnimationBuilder.xml | 4 +- .../SkiaSharp.Views.Blazor/SKCanvasView.xml | 10 +- .../SkiaSharp.Views.Blazor/SKGLView.xml | 10 +- .../SKPaintGLSurfaceEventArgs.xml | 4 +- .../SKPaintSurfaceEventArgs.xml | 4 +- .../SkiaSharp.Views.Blazor/_Imports.xml | 17 +- .../SkiaSharp.Views.Gtk/GTKExtensions.xml | 145 +-- .../SkiaSharp.Views.Gtk/SKDrawingArea.xml | 10 +- SkiaSharpAPI/SkiaSharp/GRContext.xml | 42 + .../SkiaSharp/GRD3DBackendContext.xml | 24 +- .../SkiaSharp/GRD3DTextureResourceInfo.xml | 8 +- SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml | 9 +- .../SkiaSharp/GRVkYcbcrComponents.xml | 91 +- .../SkiaSharp/GRVkYcbcrConversionInfo.xml | 450 +++++++++ SkiaSharpAPI/SkiaSharp/SKBlender.xml | 4 +- SkiaSharpAPI/SkiaSharp/SKCanvas.xml | 80 +- .../SkiaSharp/SKCanvasSaveLayerRec.xml | 4 +- SkiaSharpAPI/SkiaSharp/SKColorSpace.xml | 10 +- SkiaSharpAPI/SkiaSharp/SKColorType.xml | 6 +- .../SkiaSharp/SKColorspacePrimariesCicp.xml | 43 +- .../SkiaSharp/SKColorspaceTransferFnCicp.xml | 47 +- SkiaSharpAPI/SkiaSharp/SKDocument.xml | 72 ++ .../SkiaSharp/SKDocumentXpsOptions.xml | 94 +- SkiaSharpAPI/SkiaSharp/SKFontArguments.xml | 58 +- .../SkiaSharp/SKFontPaletteOverride.xml | 87 +- .../SkiaSharp/SKFontVariationAxis.xml | 98 +- .../SKFontVariationPositionCoordinate.xml | 83 +- SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | 124 ++- SkiaSharpAPI/SkiaSharp/SKImageFilter.xml | 122 +-- SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml | 22 + SkiaSharpAPI/SkiaSharp/SKMatrix.xml | 16 +- SkiaSharpAPI/SkiaSharp/SKPaint.xml | 74 +- SkiaSharpAPI/SkiaSharp/SKPath.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml | 500 +++++----- SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 14 +- SkiaSharpAPI/SkiaSharp/SKPixmap.xml | 30 +- .../SkiaSharp/SKRuntimeEffectUniform.xml | 2 +- SkiaSharpAPI/SkiaSharp/SKStream.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKSurface.xml | 26 +- SkiaSharpAPI/SkiaSharp/SKTextBlob.xml | 58 +- SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml | 46 +- SkiaSharpAPI/SkiaSharp/SKTypeface.xml | 76 +- SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml | 94 +- SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml | 67 +- SkiaSharpAPI/index.xml | 319 ++++-- 73 files changed, 3766 insertions(+), 1331 deletions(-) create mode 100644 SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-14.2.xml create mode 100644 SkiaSharpAPI/HarfBuzzSharp/HBColor.xml create mode 100644 SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml create mode 100644 SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml diff --git a/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-14.2.xml b/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-14.2.xml new file mode 100644 index 00000000..664acd3c --- /dev/null +++ b/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-14.2.xml @@ -0,0 +1,920 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-8.3.xml b/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-8.3.xml index a3d4dc99..87a1fd78 100644 --- a/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-8.3.xml +++ b/SkiaSharpAPI/FrameworksIndex/harfbuzzsharp-8.3.xml @@ -131,35 +131,14 @@ - - - - - - - - - - - - - - - - - - - - - @@ -192,7 +171,6 @@ - @@ -202,10 +180,6 @@ - - - - @@ -231,7 +205,6 @@ - diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp-4.147.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp-4.147.xml index 05580ca7..5c8c4b63 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp-4.147.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp-4.147.xml @@ -67,6 +67,8 @@ + + @@ -262,16 +264,14 @@ - - - - - + + + @@ -279,6 +279,24 @@ + + + + + + + + + + + + + + + + + + @@ -1187,10 +1205,13 @@ + + + @@ -1226,7 +1247,7 @@ - + @@ -1990,6 +2011,7 @@ + diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp-harfbuzz-4.147.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp-harfbuzz-4.147.xml index ae598699..aed66b5d 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp-harfbuzz-4.147.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp-harfbuzz-4.147.xml @@ -20,6 +20,13 @@ + + + + + + + diff --git a/SkiaSharpAPI/FrameworksIndex/skiasharp-views-3.119.xml b/SkiaSharpAPI/FrameworksIndex/skiasharp-views-3.119.xml index 823cf8f7..c3712d20 100644 --- a/SkiaSharpAPI/FrameworksIndex/skiasharp-views-3.119.xml +++ b/SkiaSharpAPI/FrameworksIndex/skiasharp-views-3.119.xml @@ -4,6 +4,7 @@ + @@ -174,7 +175,7 @@ - + @@ -220,16 +221,6 @@ - - - - - - - - - - @@ -295,6 +286,13 @@ + + + + + + + @@ -304,15 +302,22 @@ + + + + + + + diff --git a/SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml b/SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml index 51163fb3..aff65443 100644 --- a/SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml +++ b/SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml @@ -2,7 +2,7 @@ - + HarfBuzzSharp 1.0.0.0 diff --git a/SkiaSharpAPI/HarfBuzzSharp/Blob.xml b/SkiaSharpAPI/HarfBuzzSharp/Blob.xml index 3ddfc6cf..3351e5d0 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Blob.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Blob.xml @@ -99,8 +99,8 @@ - - + + Method HarfBuzzSharp @@ -108,7 +108,7 @@ System.ReadOnlySpan<System.Byte> - System.Span<System.Byte> + System.Span<System.Byte> diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..15ae88ed 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Face.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Face.xml @@ -164,13 +164,13 @@ System.Single[] - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Gets all design coordinates for the specified named instance. + An array of design coordinate values, or an empty array if the instance has no design coordinates. + @@ -186,15 +186,15 @@ System.Int32 - - + + - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + The span to fill with design coordinate values. + Fills a span with the design coordinates for the specified named instance. + The number of design coordinates written to . + @@ -210,13 +210,13 @@ System.Int32 - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Gets the number of design coordinates for the specified named instance. + The number of design coordinates associated with the named instance. + @@ -232,13 +232,13 @@ HarfBuzzSharp.OpenTypeNameId - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Gets the OpenType name identifier for the PostScript name of the specified named instance. + The that refers to the PostScript name string. + @@ -254,13 +254,13 @@ HarfBuzzSharp.OpenTypeNameId - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Gets the OpenType name identifier for the subfamily name of the specified named instance. + The that refers to the subfamily name string. + @@ -276,18 +276,18 @@ HarfBuzzSharp.OpenTypeNameId - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color entry within the palette. + Gets the OpenType name identifier for the specified color entry. + The that refers to the color name string. + - - + + Method @@ -295,22 +295,22 @@ 1.0.0.0 - System.UInt32[] + HarfBuzzSharp.HBColor[] - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets all colors in the specified font color palette. + An array of values for the palette, or an empty array if the palette is empty. + - - - + + + Method HarfBuzzSharp @@ -320,15 +320,15 @@ System.Int32 - - + + - 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 color values. + Fills a span with the colors from the specified font color palette. + The number of colors written to . + @@ -344,13 +344,13 @@ HarfBuzzSharp.OpenTypeColorPaletteFlags - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the flags describing the intended use of the specified color palette. + A value describing the palette flags. + @@ -366,13 +366,13 @@ HarfBuzzSharp.OpenTypeNameId - + - To be added. - To be added. - To be added. - To be added. + The zero-based index of the palette. + Gets the OpenType name identifier for the specified color palette. + The that refers to the palette name string. + @@ -388,13 +388,13 @@ System.Int32 - + - To be added. - To be added. - To be added. - To be added. + The span to fill with values. + Fills a span with information about all OpenType variation axes. + The number of axis entries written to . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font has color layer data (COLR table). + if the font contains a COLR color layers table; otherwise, . + @@ -446,9 +446,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font has PNG color bitmap glyphs (sbix or CBDT table). + if the font contains PNG color bitmap data; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font has SVG color glyph data (SVG table). + if the font contains an SVG color table; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font has a color palette table (CPAL). + if the font contains a CPAL color palette table; otherwise, . + @@ -500,9 +500,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains OpenType variable font data. + if the font contains 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 total number of named variation instances. + @@ -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's CPAL table. + The total number of color palettes. + @@ -649,15 +649,15 @@ System.Boolean - - + + - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte OpenType tag of the variation axis to find. + When this method returns, contains the axis information if the axis was found. This parameter is treated as uninitialized. + Attempts to find information about the variation axis identified by the specified tag. + if the axis was found; otherwise, . + @@ -691,9 +691,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of OpenType variation axes defined in the font. + The total number of variation axes. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets an array of information about all OpenType variation axes defined in the font. + An array of values describing each axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Feature.xml b/SkiaSharpAPI/HarfBuzzSharp/Feature.xml index e7b1d337..1fad0077 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Feature.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Feature.xml @@ -91,7 +91,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -117,7 +117,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -144,7 +144,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -171,7 +171,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -265,7 +265,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -288,7 +288,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -355,7 +355,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..2713cef1 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Font.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Font.xml @@ -318,13 +318,13 @@ System.Int32 - + - To be added. - To be added. - To be added. - To be added. + The span to fill with normalized variation coordinate values. + Fills a span with the current normalized variation coordinates for the font. + The number of coordinates written to . + @@ -576,12 +576,12 @@ System.Void - + - To be added. - To be added. - To be added. + A read-only span of design-space coordinate values, one per variation axis. + Sets the font variation using design-space coordinate values. + @@ -597,12 +597,12 @@ System.Void - + - To be added. - To be added. - To be added. + A read-only span of normalized coordinate values in the range [-1.0, 1.0] (as 2.14 fixed-point integers), one per variation axis. + Sets the font variation using normalized coordinate values. + @@ -618,12 +618,12 @@ System.Void - + - To be added. - To be added. - To be added. + The zero-based index of the named instance as returned by . + Sets the font variation to the specified named instance. + @@ -639,12 +639,12 @@ System.Void - + - To be added. - To be added. - To be added. + A read-only span of values specifying axis tags and their desired values. + Sets one or more font variation axes by tag and value. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates for the font. + An array of normalized coordinate values (2.14 fixed-point integers), one per variation axis. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml b/SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml index 4558d830..05f4aab5 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -52,7 +52,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -78,7 +78,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -105,7 +105,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -132,7 +132,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -156,7 +156,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml b/SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml index fca1fe80..e3043107 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml @@ -32,7 +32,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -59,7 +59,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -86,7 +86,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -110,7 +110,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -204,7 +204,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -227,7 +227,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml b/SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml index 8a5d8836..52454408 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -52,7 +52,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -78,7 +78,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -105,7 +105,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -132,7 +132,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -174,7 +174,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml b/SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml index 2bcfd840..be9d31b2 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml @@ -32,7 +32,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -59,7 +59,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -86,7 +86,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -158,7 +158,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -204,7 +204,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -227,7 +227,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml new file mode 100644 index 00000000..251568f6 --- /dev/null +++ b/SkiaSharpAPI/HarfBuzzSharp/HBColor.xml @@ -0,0 +1,367 @@ + + + + + + HarfBuzzSharp + 1.0.0.0 + + + System.ValueType + + + + System.IEquatable<HarfBuzzSharp.HBColor> + + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + Represents a HarfBuzz color value with BGRA byte ordering. + , which uses ARGB ordering (`0xAARRGGBB`). + +Use the named properties (, , +, ) rather than bit-shifting +the raw value, to avoid confusion caused by the non-standard channel order. + +`HBColor` is a value type and does not require disposal. + +## Examples + +```csharp +// Create from individual RGBA components +var color = new HBColor(red: 255, green: 128, blue: 0, alpha: 255); + +// Access individual channels +byte r = color.Red; // 255 +byte g = color.Green; // 128 +byte b = color.Blue; // 0 +byte a = color.Alpha; // 255 + +// Convert from/to SKColor using extension methods +SKColor skColor = SKColors.CornflowerBlue; +HBColor hbColor = skColor.ToHBColor(); +SKColor back = hbColor.ToSKColor(); +``` +]]> + + + + + + + Constructor + + HarfBuzzSharp + 1.0.0.0 + + + + + + The raw hb_color_t value with BGRA byte ordering (0xBBGGRRAA). + Initializes a new instance of the struct from a raw packed color value. + + + + + + + + Constructor + + HarfBuzzSharp + 1.0.0.0 + + + + + + + + + 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 color channel values. + + + + + + + + Property + + HarfBuzzSharp + 1.0.0.0 + + + System.Byte + + + Gets the alpha channel value of the color. + The alpha component (0–255), where 0 is fully transparent and 255 is fully opaque. + + + + + + + + Property + + HarfBuzzSharp + 1.0.0.0 + + + System.Byte + + + Gets the blue channel value of the color. + The blue component (0–255). + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + HarfBuzzSharp + 1.0.0.0 + + + System.Boolean + + + + + + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if has the same packed color value; otherwise, . + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.Boolean + + + + + + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with the same packed color value; otherwise, . + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.Int32 + + + + Returns the hash code for the current instance. + A hash code for the current . + + + + + + + + Property + + HarfBuzzSharp + 1.0.0.0 + + + System.Byte + + + Gets the green channel value of the color. + The green component (0–255). + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.Boolean + + + + + + + The first color to compare. + The second color to compare. + Returns a value indicating whether two instances are equal. + if both colors have the same packed value; otherwise, . + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + HarfBuzzSharp.HBColor + + + + + + The raw packed color value with BGRA byte ordering (0xBBGGRRAA). + Explicitly converts a raw unsigned integer to an . + An whose packed value equals . + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.UInt32 + + + + + + The color to convert. + Implicitly converts an to its raw unsigned integer representation. + The raw packed color value with BGRA byte ordering (0xBBGGRRAA). + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.Boolean + + + + + + + The first color to compare. + The second color to compare. + Returns a value indicating whether two instances are not equal. + if the colors differ; otherwise, . + + + + + + + + Property + + HarfBuzzSharp + 1.0.0.0 + + + System.Byte + + + Gets the red channel value of the color. + The red component (0–255). + + + + + + + + Method + + HarfBuzzSharp + 1.0.0.0 + + + System.String + + + + Returns a hexadecimal string representation of the color. + A string of the form #AARRGGBB representing the color channels. + + + + + + + + Property + + HarfBuzzSharp + 1.0.0.0 + + + System.UInt32 + + + Gets the raw packed color value. + The packed hb_color_t value with BGRA byte ordering (0xBBGGRRAA). + + + + + diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeColorLayer.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeColorLayer.xml index 524a7d94..cba25610 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeColorLayer.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeColorLayer.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -55,7 +55,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -83,7 +83,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -111,7 +111,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -135,7 +135,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphPart.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphPart.xml index 2ac3fbdf..7c50ccda 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphPart.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphPart.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -55,7 +55,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -83,7 +83,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -111,7 +111,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -134,7 +134,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -157,7 +157,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -254,7 +254,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphVariant.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphVariant.xml index fc7324da..ab2758e8 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphVariant.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphVariant.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -55,7 +55,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -83,7 +83,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -111,7 +111,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -135,7 +135,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeNameEntry.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeNameEntry.xml index 5a460bb0..7294dddf 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeNameEntry.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeNameEntry.xml @@ -32,7 +32,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -60,7 +60,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -88,7 +88,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -112,7 +112,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -135,7 +135,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -208,7 +208,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxis.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxis.xml index 01ac5d97..f5cc2e95 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxis.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxis.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -55,7 +55,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -83,7 +83,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -111,7 +111,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -135,7 +135,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -158,7 +158,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -254,7 +254,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxisInfo.xml b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxisInfo.xml index bb317955..30394094 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxisInfo.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxisInfo.xml @@ -29,7 +29,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -52,7 +52,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -78,7 +78,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -106,7 +106,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -134,7 +134,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -157,7 +157,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -204,7 +204,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -227,7 +227,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -300,7 +300,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/HarfBuzzSharp/Variation.xml b/SkiaSharpAPI/HarfBuzzSharp/Variation.xml index e3b9e855..1cb8d017 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Variation.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Variation.xml @@ -32,7 +32,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -59,7 +59,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -86,7 +86,7 @@ 1.0.0.0 - + [System.Runtime.CompilerServices.IsReadOnly] @@ -158,7 +158,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] @@ -181,7 +181,7 @@ 1.0.0.0 - + [get: System.Runtime.CompilerServices.IsReadOnly] diff --git a/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml new file mode 100644 index 00000000..f5f16818 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp.HarfBuzz/ColorExtensions.xml @@ -0,0 +1,147 @@ + + + + + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + System.Object + + + + Provides extension methods for converting between SkiaSharp and HarfBuzz color types. + / types and +HarfBuzz's type. + +These conversions correctly handle the difference in byte ordering: + uses ARGB (`0xAARRGGBB`), while +uses BGRA (`0xBBGGRRAA`). + +## Examples + +```csharp +SKColor skColor = SKColors.CornflowerBlue; +HBColor hbColor = skColor.ToHBColor(); +SKColor roundTripped = hbColor.ToSKColor(); +``` +]]> + + + + + + + Method + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + HarfBuzzSharp.HBColor + + + + + + The to convert. + Converts an to an . + An with the same RGBA channel values. + + + + + + + + Method + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + HarfBuzzSharp.HBColor + + + + + + The to convert. + Converts an to an . + An with the same RGBA channel values, converted from floating-point to byte range. + + + + + + + + Method + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + SkiaSharp.SKColor + + + + + + The to convert. + Converts an to an . + An with the same RGBA channel values. + + + + + + + + Method + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + SkiaSharp.SKColorF + + + + + + The to convert. + Converts an to an . + An with channel values normalized to the range [0, 1]. + + + + + + + + Method + + SkiaSharp.HarfBuzz + 4.147.0.0 + + + SkiaSharp.SKColor[] + + + + + + The array of values to convert. + Converts an array of values to an array of values. + A new array of values with the same RGBA channel values. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml index 812e5540..9c588b5b 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/CachingResourceProvider.xml @@ -13,10 +13,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml index e3bb303f..e390d459 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/DataUriResourceProvider.xml @@ -13,10 +13,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(2)] diff --git a/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml index 7e3d4354..0be7083e 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/FileResourceProvider.xml @@ -13,10 +13,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml b/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml index b80bbe7a..94b776c5 100644 --- a/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml +++ b/SkiaSharpAPI/SkiaSharp.Resources/ResourceProvider.xml @@ -32,7 +32,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -61,7 +61,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml b/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml index ee2cd664..8c97ca3d 100644 --- a/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml +++ b/SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml @@ -14,10 +14,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -351,7 +351,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -382,7 +382,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -413,7 +413,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -444,7 +444,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -505,7 +505,7 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -542,7 +542,7 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -579,7 +579,7 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -616,7 +616,7 @@ [System.Diagnostics.CodeAnalysis.NotNullWhen(true)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -653,7 +653,7 @@ [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 b8dfdd79..01212c0f 100644 --- a/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilder.xml @@ -13,10 +13,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml index 5a910d78..913186f1 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml @@ -21,10 +21,10 @@ [System.Runtime.Versioning.SupportedOSPlatform("browser")] - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -67,7 +67,7 @@ [Microsoft.AspNetCore.Components.Parameter(CaptureUnmatchedValues=true)] - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })] @@ -93,7 +93,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -270,7 +270,7 @@ [Microsoft.AspNetCore.Components.Parameter] - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml index 7360ef25..968c9886 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml @@ -21,10 +21,10 @@ [System.Runtime.Versioning.SupportedOSPlatform("browser")] - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -67,7 +67,7 @@ [Microsoft.AspNetCore.Components.Parameter(CaptureUnmatchedValues=true)] - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })] @@ -93,7 +93,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -270,7 +270,7 @@ [Microsoft.AspNetCore.Components.Parameter] - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml index 9fe2e1b7..8e8b1535 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintGLSurfaceEventArgs.xml @@ -14,10 +14,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml index a38fa766..74659e78 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/SKPaintSurfaceEventArgs.xml @@ -14,10 +14,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml index 719b610c..a9410a21 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml @@ -1,9 +1,9 @@ - - + + - - + + SkiaSharp.Views.Blazor 3.116.0.0 @@ -12,7 +12,7 @@ Microsoft.AspNetCore.Components.ComponentBase - System.Object + System.Object @@ -51,7 +51,7 @@ System.Void - + The render tree builder. @@ -66,6 +66,7 @@ Method SkiaSharp.Views.Blazor + 3.119.0.0 4.147.0.0 @@ -73,8 +74,8 @@ - To be added. - To be added. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml index f6a6007e..2827feba 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -17,6 +17,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -66,17 +67,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a GDK Gdk.Rectangle. + A Gdk.Rectangle with the same origin and dimensions. + @@ -86,17 +88,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a GDK Gdk.RGBA. + A Gdk.RGBA with channel values normalized to the range [0, 1]. + @@ -106,17 +109,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a GDK Gdk.RGBA. + A Gdk.RGBA with channel values normalized to the range [0, 1]. + @@ -126,17 +130,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene Graphene.Point. + A Graphene.Point with the same X and Y coordinates. + @@ -146,17 +151,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene Graphene.Point3D. + A Graphene.Point3D with the same X, Y, and Z coordinates. + @@ -166,17 +172,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene Graphene.Rect. + A Graphene.Rect with the same origin and size. + @@ -186,17 +193,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a Graphene Graphene.Size. + A Graphene.Size with the same width and height. + @@ -487,17 +495,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Gdk.RGBA to convert. + Converts a GDK Gdk.RGBA to an . + An with channel values converted from the [0, 1] range to [0, 255]. + @@ -507,17 +516,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Gdk.RGBA to convert. + Converts a GDK Gdk.RGBA to an . + An with the same floating-point channel values. + @@ -590,17 +600,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Point to convert. + Converts a Graphene Graphene.Point to an . + An with the same X and Y coordinates. + @@ -610,17 +621,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Point3D to convert. + Converts a Graphene Graphene.Point3D to an . + An with the same X, Y, and Z coordinates. + @@ -661,17 +673,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Rect to convert. + Converts a Graphene Graphene.Rect to an . + An with the same origin and size. + @@ -694,6 +707,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -716,17 +730,18 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - + - To be added. - To be added. - To be added. - To be added. + The Graphene.Size to convert. + Converts a Graphene Graphene.Size to an . + An with the same width and height. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml index e23eec26..d5fc2cfb 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml @@ -12,6 +12,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -43,6 +44,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -66,6 +68,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -84,13 +87,14 @@ Method SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 - To be added. - To be added. + Releases the resources used by the current instance of the class. + @@ -160,6 +164,7 @@ SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 @@ -223,6 +228,7 @@ protected override void OnPaintSurface (SKPaintSurfaceEventArgs e) SkiaSharp.Views.Gtk4 + 3.119.0.0 4.147.0.0 diff --git a/SkiaSharpAPI/SkiaSharp/GRContext.xml b/SkiaSharpAPI/SkiaSharp/GRContext.xml index df621b5a..24af57e7 100644 --- a/SkiaSharpAPI/SkiaSharp/GRContext.xml +++ b/SkiaSharpAPI/SkiaSharp/GRContext.xml @@ -516,6 +516,48 @@ + + + + + Method + + SkiaSharp + 4.147.0.0 + + + System.Void + + + + + + The image whose pending GPU work should be flushed. + Flushes any pending GPU work associated with the specified image. + + + + + + + + Method + + SkiaSharp + 4.147.0.0 + + + System.Void + + + + + + The surface whose pending GPU work 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 5b97eaa9..9c908803 100644 --- a/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml +++ b/SkiaSharpAPI/SkiaSharp/GRD3DBackendContext.xml @@ -37,21 +37,15 @@ - + - Property SkiaSharp 3.119.0.0 4.147.0.0 - - - [System.Runtime.CompilerServices.NativeInteger] - - System.IntPtr @@ -62,21 +56,15 @@ - + - Property SkiaSharp 3.119.0.0 4.147.0.0 - - - [System.Runtime.CompilerServices.NativeInteger] - - System.IntPtr @@ -152,21 +140,15 @@ - + - Property SkiaSharp 3.119.0.0 4.147.0.0 - - - [System.Runtime.CompilerServices.NativeInteger] - - System.IntPtr diff --git a/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml b/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml index 5bca59c8..137f04b3 100644 --- a/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GRD3DTextureResourceInfo.xml @@ -140,21 +140,15 @@ - + - Property SkiaSharp 3.119.0.0 4.147.0.0 - - - [System.Runtime.CompilerServices.NativeInteger] - - System.IntPtr diff --git a/SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml b/SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml index 476cbc6e..15e8bc3c 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml @@ -472,9 +472,11 @@ - - + + + + Property SkiaSharp @@ -490,7 +492,8 @@ - SkiaSharp.GrVkYcbcrConversionInfo + SkiaSharp.GrVkYcbcrConversionInfo + SkiaSharp.GRVkYcbcrConversionInfo Gets or sets the YCbCr conversion information for the Vulkan image. diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml index c216be8c..7b2410e4 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,29 @@ - To be added. - To be added. + Specifies the Vulkan component swizzle mapping for a YCbCr sampler conversion. + and is used when creating +GPU surfaces that wrap Vulkan YCbCr sampler conversions. + +## Examples + +```csharp +var components = new GRVkYcbcrComponents +{ + R = 0u, // VK_COMPONENT_SWIZZLE_IDENTITY + G = 0u, // VK_COMPONENT_SWIZZLE_IDENTITY + B = 0u, // VK_COMPONENT_SWIZZLE_IDENTITY + A = 0u, // VK_COMPONENT_SWIZZLE_IDENTITY +}; +``` +]]> @@ -37,9 +58,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the alpha channel. + A raw VkComponentSwizzle value. + @@ -60,9 +81,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the blue channel. + A raw VkComponentSwizzle value. + @@ -89,10 +110,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all component swizzle values are equal; otherwise, . + @@ -116,10 +137,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with equal component swizzle values; otherwise, . + @@ -140,9 +161,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the green channel. + A raw VkComponentSwizzle value. + @@ -164,9 +185,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -186,11 +207,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal component swizzle values; otherwise, . + @@ -210,11 +231,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + @@ -235,9 +256,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the Vulkan component swizzle for the red channel. + A raw VkComponentSwizzle value. + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml new file mode 100644 index 00000000..2c7b9229 --- /dev/null +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrConversionInfo.xml @@ -0,0 +1,450 @@ + + + + + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + System.ValueType + + + + System.IEquatable<SkiaSharp.GRVkYcbcrConversionInfo> + + + + Configuration information for Vulkan YCbCr color space conversion. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the chroma filter mode used for upsampling chroma components. + The VkFilter value for chroma filtering. + + + + + + + + Property + + SkiaSharp + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + SkiaSharp.GRVkYcbcrComponents + + + Gets or sets the component swizzle mapping for the YCbCr conversion. + A value specifying how image channels are swizzled. + + + + + + + + Method + + M:System.IEquatable`1.Equals(`0) + + + SkiaSharp + 4.147.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all fields are equal; otherwise, . + + + + + + + + Method + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + + + + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + + if the specified object is equal to the current instance; otherwise, . + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt64 + + + Gets or sets the external format when using VK_ANDROID_external_memory_android_hardware_buffer. + The external format value, or 0 if not using an external format. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets a value indicating whether to force explicit chroma reconstruction. + Non-zero to force explicit reconstruction. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Vulkan format of the image. + The VkFormat value. + + + + + + + + Method + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.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.147.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal fields; otherwise, . + + + + + + + + Method + + SkiaSharp + 4.147.0.0 + + + System.Boolean + + + + + + + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.147.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's min/mag filter must equal the chroma filter; otherwise, . + + + + + + + + Property + + SkiaSharp + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.Boolean + + + Gets or sets a value indicating whether the Vulkan implementation supports linear filtering for this YCbCr conversion. + if linear filtering is supported; otherwise, . + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the X chroma offset for downsampled chroma channels. + The VkChromaLocation value for the X offset. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the YCbCr model used for color conversion. + The VkSamplerYcbcrModelConversion value. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the YCbCr range for color conversion. + The VkSamplerYcbcrRange value. + + + + + + + + Property + + SkiaSharp + 2.80.0.0 + 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + + + + System.UInt32 + + + Gets or sets the Y chroma offset for downsampled chroma channels. + The VkChromaLocation value for the Y offset. + + + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKBlender.xml b/SkiaSharpAPI/SkiaSharp/SKBlender.xml index 00d4ad84..4cc92054 100644 --- a/SkiaSharpAPI/SkiaSharp/SKBlender.xml +++ b/SkiaSharpAPI/SkiaSharp/SKBlender.xml @@ -13,10 +13,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..35a1c5a1 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml @@ -570,10 +570,10 @@ using (var surface = SKSurface.Create(info)) { 4.147.0.0 - + [System.Runtime.CompilerServices.Nullable(2)] - + [get: System.Runtime.CompilerServices.NullableContext(2)] @@ -3000,12 +3000,12 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The destination point at which to draw the top-left corner of the surface. + The sampling options to use when scaling or filtering the surface image. + The paint to apply, or to use default settings. + Draws the contents of a surface onto the canvas at the specified point. + @@ -3059,13 +3059,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The x-coordinate of the destination point. + The y-coordinate of the destination point. + The sampling options to use when scaling or filtering the surface image. + The paint to apply, or to use default settings. + Draws the contents of a surface onto the canvas at the specified coordinates. + @@ -4677,7 +4677,7 @@ safely ignored. 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -4709,7 +4709,7 @@ safely ignored. 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use - - - + + + Method SkiaSharp - 3.116.0.0 - 3.119.0.0 - 4.147.0.0 + 2.80.0.0 + 2.88.0.0 System.Void - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - + - The matrix to set as the current transformation matrix. + The matrix that will be copied into the current matrix. Replaces the current matrix with a copy of the specified matrix. - - - + + + Method SkiaSharp - 2.80.0.0 - 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 System.Void - + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + - The matrix that will be copied into the current matrix. + The matrix to set as the current transformation matrix. Replaces the current matrix with a copy of the specified matrix. @@ -4993,10 +4993,10 @@ guaranteed to happen. If exact clipping is desired, use 4.147.0.0 - + [System.Runtime.CompilerServices.Nullable(2)] - + [get: System.Runtime.CompilerServices.NullableContext(2)] diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml b/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml index c7171d0d..4b2dc888 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml @@ -12,10 +12,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(2)] diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index 9e7e0d87..64f2ee5f 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml @@ -36,11 +36,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + One of the enumeration values that specifies the CICP color primaries. + One of the enumeration values that specifies the CICP transfer function. + Creates a color space from ITU-T H.273 (CICP) color primaries and transfer characteristics. + A new , or if the combination is not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..e5a1dfe4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + A 4-channel format with blue, green, red, and alpha stored as 10-bit extended-range (XR) values, packed as BGRA (64 bits per pixel). @@ -234,7 +234,7 @@ 27 - To be added. + A single-channel format with a 16-bit unsigned normalized red value (2 bytes per pixel). @@ -519,7 +519,7 @@ 26 - To be added. + A 3-channel opaque format with red, green, and blue stored as 16-bit floats plus a padding component (8 bytes per pixel). The fourth component is unused. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..7723424c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,23 @@ System.Enum - To be added. - To be added. + Specifies the color primaries of a color space as defined by ITU-T H.273 (CICP). + to create a +color space matching a specific standard. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> @@ -28,7 +43,7 @@ 8 - To be added. + Generic film color primaries based on the CIE 1931 equal energy point (CICP value 8). @@ -45,7 +60,7 @@ 22 - To be added. + EBU Tech 3213-E color primaries as defined by ITU-T H.273 value 22 (CICP value 22). @@ -62,7 +77,7 @@ 9 - To be added. + ITU-R BT.2020 color primaries, used for UHD and HDR video (CICP value 9). @@ -79,7 +94,7 @@ 5 - To be added. + ITU-R BT.470 System B/G color primaries (CICP value 5). @@ -96,7 +111,7 @@ 4 - To be added. + ITU-R BT.470 System M color primaries (CICP value 4). @@ -113,7 +128,7 @@ 6 - To be added. + ITU-R BT.601 color primaries, used for SD video (CICP value 6). @@ -130,7 +145,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for HD video (CICP value 1). @@ -147,7 +162,7 @@ 12 - To be added. + SMPTE EG 432-1 (Display P3) color primaries (CICP value 12). @@ -164,7 +179,7 @@ 11 - To be added. + SMPTE RP 431-2 (P3-DCI) color primaries (CICP value 11). @@ -181,7 +196,7 @@ 7 - To be added. + SMPTE ST 240 color primaries (CICP value 7). @@ -198,7 +213,7 @@ 10 - To be added. + SMPTE ST 428-1 (CIE 1931 XYZ) color primaries (CICP value 10). @@ -215,7 +230,7 @@ 0 - To be added. + Unspecified or unknown color primaries (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index bddb849d..12a23cc0 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,23 @@ System.Enum - To be added. - To be added. + Specifies the electro-optical transfer function of a color space as defined by ITU-T H.273 (CICP). + to create a +color space with the appropriate electro-optical transfer characteristics. + +## Examples + +```csharp +var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +43,7 @@ 18 - To be added. + ITU-R BT.2100 Hybrid Log-Gamma (HLG) transfer function for HDR (CICP value 18). @@ -45,7 +60,7 @@ 13 - To be added. + IEC 61966-2-1 sRGB transfer function (CICP value 13). @@ -62,7 +77,7 @@ 11 - To be added. + IEC 61966-2-4 extended gamut transfer function (CICP value 11). @@ -79,7 +94,7 @@ 8 - To be added. + Linear transfer function with no gamma encoding (CICP value 8). @@ -96,7 +111,7 @@ 16 - To be added. + SMPTE ST 2084 Perceptual Quantizer (PQ) transfer function for HDR (CICP value 16). @@ -113,7 +128,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer function (CICP value 14). @@ -130,7 +145,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer function (CICP value 15). @@ -147,7 +162,7 @@ 5 - To be added. + ITU-R BT.470 System B/G gamma transfer function (CICP value 5). @@ -164,7 +179,7 @@ 4 - To be added. + ITU-R BT.470 System M gamma transfer function (CICP value 4). @@ -181,7 +196,7 @@ 6 - To be added. + ITU-R BT.601 transfer function, used for SD video (CICP value 6). @@ -198,7 +213,7 @@ 1 - To be added. + ITU-R BT.709 transfer function, used for HD video (CICP value 1). @@ -215,7 +230,7 @@ 7 - To be added. + SMPTE ST 240 transfer function (CICP value 7). @@ -232,7 +247,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer function (CICP value 17). @@ -249,7 +264,7 @@ 0 - To be added. + Unspecified or unknown transfer function (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocument.xml b/SkiaSharpAPI/SkiaSharp/SKDocument.xml index 165df8f5..81a0b141 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocument.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocument.xml @@ -489,6 +489,30 @@ canvas, and then complete the page with a call to + + + + + Method + + SkiaSharp + 4.147.0.0 + + + SkiaSharp.SKDocument + + + + + + + The to write the XPS document to. + The controlling encoding behavior. + Creates an XPS document that writes to the specified SkiaSharp write stream using the given options. + A new for creating the XPS file, or on failure. + + + @@ -517,6 +541,30 @@ canvas, and then complete the page with a call to XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. + + + + + Method + + SkiaSharp + 4.147.0.0 + + + SkiaSharp.SKDocument + + + + + + + The to write the XPS document to. + The controlling encoding behavior. + Creates an XPS document that writes to the specified managed stream using the given options. + A new for creating the XPS file, or on failure. + + + @@ -545,6 +593,30 @@ canvas, and then complete the page with a call to XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. + + + + + Method + + SkiaSharp + 4.147.0.0 + + + SkiaSharp.SKDocument + + + + + + + The file path to write the XPS document to. + The controlling encoding behavior. + Creates an XPS document that writes to the specified file path using the given options. + A new for creating the XPS file, or on failure. + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..43be5973 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,36 @@ - To be added. - To be added. + Provides options for controlling XPS document encoding. + . Set the desired properties before passing this +struct to the factory method. + +`SKDocumentXpsOptions` is a value type and does not require disposal. + +## Examples + +```csharp +var options = new SKDocumentXpsOptions +{ + Dpi = 96, + AllowNoPngs = false, +}; + +using var stream = File.OpenWrite("output.xps"); +using var document = SKDocument.CreateXps(stream, options); +using var canvas = document.BeginPage(595, 842); + +using var paint = new SKPaint { Color = SKColors.Black }; +canvas.DrawText("Hello, XPS!", 50, 100, paint); + +document.EndPage(); +document.Close(); +``` +]]> @@ -37,15 +65,15 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the encoder may omit PNG images when a higher-quality alternative is available. + to allow the encoder to skip PNG encoding; otherwise, . + - - - - + + + + Property SkiaSharp @@ -60,9 +88,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the raster resolution in dots per inch used when rasterizing content. + The DPI value for rasterized content. + @@ -89,10 +117,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all fields are equal; otherwise, . + @@ -116,10 +144,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with equal field values; otherwise, . + @@ -141,9 +169,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -163,11 +191,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal field values; otherwise, . + @@ -187,11 +215,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 57ae755b..7b303a69 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,38 @@ - To be added. - To be added. + Provides arguments for customizing a typeface clone, including variation design position and color palette settings. + . It lets you +specify a variation design position, a color palette index, and per-color overrides +all in a single argument. + +Because `SKFontArguments` is a `ref struct`, it cannot be stored as a class field or +used in async methods. It holds `ReadOnlySpan` views into external memory that must +remain valid for the lifetime of the struct. + +## Examples + +```csharp +// Clone a variable typeface at a specific design position +var coordinate = new SKFontVariationPositionCoordinate +{ + Axis = SKFourByteTag.Parse("wght"), + Value = 700f, +}; + +var args = new SKFontArguments +{ + VariationDesignPosition = new[] { coordinate }, + PaletteIndex = 0, +}; + +SKTypeface boldFace = typeface.Clone(args); +``` +]]> @@ -41,9 +71,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the font within a font collection. + The index of the desired font within a TTC or other collection file. + @@ -64,9 +94,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the zero-based index of the color palette to use. + The index into the font's CPAL color palette table. + @@ -87,9 +117,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-entry color overrides for the selected palette. + A read-only span of values specifying colors to override in the selected palette. + @@ -110,9 +140,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation design position as a set of axis-value coordinates. + A read-only span of values, one per axis to position. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..db87c11b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,37 @@ - To be added. - To be added. + Specifies a color override for a single entry in a font color palette. + to +override specific palette entries when cloning a typeface. + +The field stores an +value (ARGB format: `0xAARRGGBB`). + +`SKFontPaletteOverride` is a value type and does not require disposal. + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red }, + new SKFontPaletteOverride { Index = 1, Color = (uint)SKColors.Blue }, +}; + +var args = new SKFontArguments +{ + PaletteIndex = 0, + PaletteOverrides = overrides, +}; + +SKTypeface customFace = typeface.Clone(args); +``` +]]> @@ -37,9 +66,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) to substitute for the palette entry at . + @@ -66,10 +95,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both the index and color are equal; otherwise, . + @@ -93,10 +122,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with equal fields; otherwise, . + @@ -118,9 +147,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -141,9 +170,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 within the font's CPAL palette. + @@ -163,11 +192,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal fields; otherwise, . + @@ -187,11 +216,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 8696fae6..b0b1b0a0 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,30 @@ - To be added. - To be added. + Describes a single variation axis of an OpenType variable font. + or + to retrieve the axes available +in a typeface. + +`SKFontVariationAxis` is a value type and does not require disposal. + +## Examples + +```csharp +foreach (var axis in typeface.VariationDesignParameters) +{ + Console.WriteLine($"{axis.Tag}: [{axis.Min}, {axis.Max}], default={axis.Default}"); +} +``` +]]> @@ -37,9 +59,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default value of the variation axis. + The default axis value in design space. + @@ -66,10 +88,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if all fields are equal; otherwise, . + @@ -93,10 +115,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with equal fields; otherwise, . + @@ -118,9 +140,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -141,9 +163,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this axis should be hidden from direct user interaction. + if the axis is marked as hidden; otherwise, . + @@ -164,9 +186,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum allowed value for the variation axis. + The maximum axis value in design space. + @@ -187,9 +209,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum allowed value for the variation axis. + The minimum axis value in design space. + @@ -209,11 +231,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal fields; otherwise, . + @@ -233,11 +255,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + @@ -258,9 +280,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte OpenType tag that identifies the variation axis. + The identifying the axis (for example, wght for weight). + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..05648dc8 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,33 @@ - To be added. - To be added. + Specifies a design-space coordinate for a single variation axis. + or set them in + to create a typeface at a +specific point in the variation space. + +`SKFontVariationPositionCoordinate` is a value type and does not require disposal. + +## Examples + +```csharp +var coords = new SKFontVariationPositionCoordinate[] +{ + new SKFontVariationPositionCoordinate + { + Axis = SKFourByteTag.Parse("wght"), + Value = 700f, + }, +}; + +SKTypeface bold = typeface.Clone(coords); +``` +]]> @@ -37,9 +62,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte OpenType tag identifying the variation axis. + The of the axis (for example, wght for weight). + @@ -66,10 +91,10 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both the axis tag and value are equal; otherwise, . + @@ -93,10 +118,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with equal fields; otherwise, . + @@ -118,9 +143,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -140,11 +165,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are equal. + if both instances have equal fields; otherwise, . + @@ -164,11 +189,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first value to compare. + The second value to compare. + Returns a value indicating whether two instances are not equal. + if the instances differ; otherwise, . + @@ -189,9 +214,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the variation axis. + The axis value in design space. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..6cee9dd6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,34 @@ - To be added. - To be added. + Represents a four-byte OpenType tag encoded as a packed 32-bit unsigned integer. + @@ -37,9 +63,9 @@ - To be added. - To be added. - To be added. + The packed tag value with characters encoded as (byte)c1 << 24 | (byte)c2 << 16 | (byte)c3 << 8 | (byte)c4. + Initializes a new instance of the struct from a raw packed value. + @@ -58,12 +84,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The first character (most significant byte). + The second character. + The third character. + The fourth character (least significant byte). + Initializes a new instance of the struct from four ASCII characters. + @@ -85,14 +111,14 @@ - To be added. - To be added. - To be added. - To be added. + The to compare with the current instance. + Determines whether the specified is equal to the current instance. + if both tags have the same packed value; otherwise, . + - + Method @@ -102,7 +128,7 @@ - [System.Runtime.CompilerServices.NullableContext(1)] + [System.Runtime.CompilerServices.NullableContext(2)] @@ -112,10 +138,10 @@ - To be added. - To be added. - To be added. - To be added. + The object to compare with the current instance. + Determines whether the specified object is equal to the current instance. + if is a with the same packed value; otherwise, . + @@ -132,9 +158,9 @@ - To be added. - To be added. - To be added. + Returns the hash code for the current instance. + A hash code for the current . + @@ -154,11 +180,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. + Returns a value indicating whether two instances are equal. + if both tags have the same packed value; otherwise, . + @@ -177,10 +203,10 @@ - To be added. - To be added. - To be added. - To be added. + The tag to convert. + Implicitly converts an to its raw unsigned integer representation. + The packed 32-bit unsigned integer representation of the tag. + @@ -199,10 +225,10 @@ - To be added. - To be added. - To be added. - To be added. + The packed 32-bit unsigned integer to convert. + Implicitly converts a raw unsigned integer to an . + An whose packed value equals . + @@ -222,11 +248,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. + Returns a value indicating whether two instances are not equal. + if the tags differ; otherwise, . + @@ -250,10 +276,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. If or empty, a zero tag is returned. Only the first four characters are used; shorter strings are right-padded with spaces. + Parses a string of up to four ASCII characters into an , padding with spaces if necessary. + An whose characters correspond to the first four characters of . + @@ -275,9 +301,9 @@ - To be added. - To be added. - To be added. + Returns the four-character string representation of the tag. + A four-character string with each character corresponding to one byte of the packed value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml index a2932421..406dfd04 100644 --- a/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml +++ b/SkiaSharpAPI/SkiaSharp/SKImageFilter.xml @@ -15,10 +15,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -134,7 +134,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -166,7 +166,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -248,7 +248,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -297,7 +297,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -331,7 +331,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -363,14 +363,14 @@ - + [System.Runtime.CompilerServices.Nullable(2)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -399,7 +399,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -438,14 +438,14 @@ - + [System.Runtime.CompilerServices.Nullable(2)] - + [System.Runtime.CompilerServices.Nullable(2)] @@ -506,7 +506,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -577,7 +577,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -672,7 +672,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -711,7 +711,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -781,7 +781,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -844,7 +844,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -906,7 +906,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -998,7 +998,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1092,7 +1092,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1163,7 +1163,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1237,7 +1237,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1351,7 +1351,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1425,7 +1425,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1501,7 +1501,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1579,7 +1579,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1656,7 +1656,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1734,7 +1734,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1856,7 +1856,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -1934,7 +1934,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2002,7 +2002,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2096,7 +2096,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2383,7 +2383,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2421,7 +2421,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2576,7 +2576,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2604,7 +2604,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -2647,7 +2647,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -2664,7 +2664,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2736,7 +2736,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -2753,7 +2753,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -2884,7 +2884,7 @@ - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] @@ -2911,7 +2911,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -2998,7 +2998,7 @@ - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] @@ -3025,7 +3025,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -3035,7 +3035,7 @@ - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] @@ -3092,7 +3092,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -3236,7 +3236,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3302,7 +3302,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3499,7 +3499,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3573,7 +3573,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3649,7 +3649,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3727,7 +3727,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3766,7 +3766,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3798,7 +3798,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3858,7 +3858,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -3938,7 +3938,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -4024,7 +4024,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -4112,7 +4112,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -4202,7 +4202,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -4274,7 +4274,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] diff --git a/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml b/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml index 72b1ea8b..119595b8 100644 --- a/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml +++ b/SkiaSharpAPI/SkiaSharp/SKMaskFilter.xml @@ -329,6 +329,28 @@ + + + + + Method + + SkiaSharp + 4.147.0.0 + + + SkiaSharp.SKMaskFilter + + + + + + The shader whose luminance channel is used to produce the mask. + Creates a mask filter that uses the luminance of a shader as the mask. + A new backed by the provided shader. + + + diff --git a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml index 7c0d12f2..c24b20c9 100644 --- a/SkiaSharpAPI/SkiaSharp/SKMatrix.xml +++ b/SkiaSharpAPI/SkiaSharp/SKMatrix.xml @@ -1571,9 +1571,9 @@ - - - + + + Method SkiaSharp @@ -1593,7 +1593,7 @@ - + The target matrix. @@ -1603,9 +1603,9 @@ - - - + + + Method SkiaSharp @@ -1625,7 +1625,7 @@ - + The target matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKPaint.xml b/SkiaSharpAPI/SkiaSharp/SKPaint.xml index 9ed1121c..61f97d86 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPaint.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPaint.xml @@ -1446,11 +1446,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + Computes the filled path for the source path using the current paint settings. + if the resulting path is non-empty; otherwise, . + @@ -1633,12 +1633,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + The transform matrix to apply to the path before computing the fill. + Computes the filled path for the source path using the specified transform matrix. + if the resulting path is non-empty; otherwise, . + @@ -1659,12 +1659,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + A rectangle used to limit the output to only the portions that intersect this area. + Computes the filled path for the source path, limiting output to the specified cull rectangle. + if the resulting path is non-empty; otherwise, . + @@ -1685,12 +1685,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + The resolution scale factor; higher values produce more detailed path approximations. + Computes the filled path for the source path at the specified resolution scale. + if the resulting path is non-empty; otherwise, . + @@ -1844,13 +1844,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + A rectangle used to limit the output to only the portions that intersect this area. + The transform matrix to apply to the path before computing the fill. + Computes the filled path for the source path, applying a cull rectangle and a transform matrix. + if the resulting path is non-empty; otherwise, . + @@ -1872,13 +1872,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path to fill. + The that receives the resulting filled path. + A rectangle used to limit the output to only the portions that intersect this area. + The resolution scale factor; higher values produce more detailed path approximations. + Computes the filled path for the source path, applying a cull rectangle and a resolution scale. + if the resulting path is non-empty; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..6153b61c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPath.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPath.xml @@ -1582,9 +1582,9 @@ the first point is automatically set to (0, 0). System.IntPtr - To be added. - To be added. - To be added. + Gets the native handle for this path object. + The pointer to the underlying native Skia path resource. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..b9f6c731 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,32 @@ - To be added. - To be added. + Provides a mutable builder for constructing objects incrementally. + objects +incrementally. Add contours using move-to, line-to, curve-to, arc-to, and shape-add +methods, then call to obtain an immutable +`SKPath` snapshot or to transfer ownership of +the path and reset the builder. + +This type wraps a native Skia resource and implements `IDisposable`. Always dispose +of it when done, either with a `using` statement or by calling `Dispose()` directly. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(10, 10); +builder.LineTo(100, 10); +builder.LineTo(100, 100); +builder.Close(); + +using SKPath path = builder.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +50,8 @@ - To be added. - To be added. + Initializes a new empty instance of the class. + @@ -43,9 +67,9 @@ - To be added. - To be added. - To be added. + The whose contours are copied into this builder. + Initializes a new instance of the class with a copy of an existing path. + @@ -66,11 +90,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The angle in degrees at which the arc begins. + The sweep angle in degrees. + Adds a complete arc of an oval to the path as a new contour. + @@ -92,12 +116,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 center. + The y-coordinate of the circle center. + The radius of the circle. + One of the enumeration values specifying the winding direction. + Adds a circle contour to the path. + @@ -117,10 +141,10 @@ - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + One of the enumeration values specifying the winding direction. + Adds an oval contour to the path. + @@ -140,10 +164,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + One of the enumeration values specifying how the path is added. + Appends the contours of another path to this builder. + @@ -170,11 +194,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + The transform matrix to apply to the appended path. + One of the enumeration values specifying how the path is added. + Appends the contours of another path to this builder, applying a transform matrix. + @@ -196,12 +220,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended. + The x-axis offset applied to the appended path. + The y-axis offset applied to the appended path. + One of the enumeration values specifying how the path is added. + Appends the contours of another path offset by the specified amounts. + @@ -221,10 +245,10 @@ - To be added. - To be added. - To be added. - To be added. + An array of points that define the vertices of the polygon. + to close the polygon by connecting the last point to the first; otherwise, . + Adds a polygon contour defined by an array of points. + @@ -244,10 +268,10 @@ - To be added. - To be added. - To be added. - To be added. + A read-only span of points that define the vertices of the polygon. + to close the polygon by connecting the last point to the first; otherwise, . + Adds a polygon contour defined by a span of points. + @@ -267,10 +291,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values specifying the winding direction. + Adds a rectangle contour to the path. + @@ -291,11 +315,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add. + One of the enumeration values specifying the winding direction. + The zero-based index of the rectangle corner at which to start (0 = top-left, 1 = top-right, 2 = bottom-right, 3 = bottom-left). + Adds a rectangle contour to the path, starting from the specified corner index. + @@ -315,10 +339,10 @@ - To be added. - To be added. - To be added. - To be added. + The round rectangle to add. + One of the enumeration values specifying the winding direction. + Adds a round rectangle contour to the path. + @@ -339,11 +363,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The round rectangle to add. + One of the enumeration values specifying the winding direction. + The zero-based index of the corner at which to start. + Adds a round rectangle contour to the path, starting from the specified corner index. + @@ -365,12 +389,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle. + The x-axis radius of the rounded corners. + The y-axis radius of the rounded corners. + One of the enumeration values specifying the winding direction. + Adds a round rectangle contour to the path using separate x and y radii. + @@ -391,11 +415,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The end point of the first tangent line (also the start point of the second tangent line). + The end point of the second tangent line. + The radius of the arc. + Appends a tangent arc between two lines defined by three points. + @@ -417,12 +441,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + The angle in degrees at which the arc begins. + The sweep angle in degrees. + to start a new contour at the arc start; to connect with the current contour. + Appends an arc of an oval, optionally forcing a move-to at the arc start. + @@ -445,13 +469,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius and y-radius of the ellipse as a point. + The rotation angle in degrees of the ellipse's x-axis. + One of the enumeration values specifying whether to draw the larger of the two arcs. + One of the enumeration values specifying the sweep direction. + The end point of the arc. + Appends an SVG-style elliptical arc using radii and control flags specified as points and scalars. + @@ -474,13 +498,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the end point of the first tangent line. + The y-coordinate of the end point of the first tangent line. + The x-coordinate of the end point of the second tangent line. + The y-coordinate of the end point of the second tangent line. + The radius of the arc. + Appends a tangent arc between two lines defined by scalar coordinates. + @@ -505,15 +529,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius of the ellipse. + The y-radius of the ellipse. + The rotation angle in degrees of the ellipse's x-axis. + One of the enumeration values specifying whether to draw the larger of the two arcs. + One of the enumeration values specifying the sweep direction. + The x-coordinate of the arc end point. + The y-coordinate of the arc end point. + Appends an SVG-style elliptical arc using scalar radii and control flags. + @@ -530,8 +554,8 @@ - To be added. - To be added. + Closes the current open contour by appending a line back to the first point of the contour. + @@ -552,11 +576,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic. + The end point of the conic. + The weight of the conic, controlling the curvature. + Appends a conic (rational quadratic Bézier) curve from the current point. + @@ -579,13 +603,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + The weight of the conic, controlling the curvature. + Appends a conic (rational quadratic Bézier) curve from the current point using scalar coordinates. + @@ -606,11 +630,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point of the cubic Bézier. + The second control point of the cubic Bézier. + The end point of the cubic Bézier. + Appends a cubic Bézier curve from the current point. + @@ -634,14 +658,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first control point. + The y-coordinate of the first control point. + The x-coordinate of the second control point. + The y-coordinate of the second control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a cubic Bézier curve from the current point using scalar coordinates. + @@ -658,9 +682,9 @@ - To be added. - To be added. - To be added. + Returns the current path and resets the builder to an empty state. + A new containing all contours added so far. The builder is reset to empty after this call. + @@ -679,9 +703,9 @@ - To be added. - To be added. - To be added. + to release both managed and unmanaged resources; to release only unmanaged resources. + Called by the and methods to release the managed and unmanaged resources used by the current instance of the class. + @@ -698,8 +722,8 @@ - To be added. - To be added. + Releases the underlying native Skia path builder resource. + @@ -715,9 +739,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type used when the built path is drawn as a filled shape. + One of the values that specifies how overlapping contours are filled. + @@ -736,9 +760,9 @@ - To be added. - To be added. - To be added. + The end point of the line. + Appends a straight line from the current point to the specified point. + @@ -758,10 +782,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a straight line from the current point to the specified coordinates. + @@ -780,9 +804,9 @@ - To be added. - To be added. - To be added. + The starting point of the new contour. + Begins a new contour at the specified point. + @@ -802,10 +826,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the starting point. + The y-coordinate of the starting point. + Begins a new contour at the specified coordinates. + @@ -825,10 +849,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point of the quadratic Bézier curve. + The end point of the quadratic Bézier curve. + Appends a quadratic Bézier curve from the current point using a control point and an end point. + @@ -850,12 +874,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the control point. + The y-coordinate of the control point. + The x-coordinate of the end point. + The y-coordinate of the end point. + Appends a quadratic Bézier curve from the current point using scalar control and end point coordinates. + @@ -878,13 +902,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius and y-radius of the ellipse as a point. + The rotation angle in degrees of the ellipse's x-axis. + One of the enumeration values specifying whether to draw the larger of the two arcs. + One of the enumeration values specifying the sweep direction. + The end point offset from the current point. + Appends an SVG-style elliptical arc using offsets from the current point, specified as points. + @@ -909,15 +933,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-radius of the ellipse. + The y-radius of the ellipse. + The rotation angle in degrees of the ellipse's x-axis. + One of the enumeration values specifying whether to draw the larger of the two arcs. + One of the enumeration values specifying the sweep direction. + The x-axis offset from the current point to the arc end point. + The y-axis offset from the current point to the arc end point. + Appends an SVG-style elliptical arc using scalar radii and offsets from the current point. + @@ -938,11 +962,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the control point. + The offset from the current point to the end point. + The weight of the conic. + Appends a conic curve using offsets from the current point. + @@ -965,13 +989,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-axis offset from the current point to the control point. + The y-axis offset from the current point to the control point. + The x-axis offset from the current point to the end point. + The y-axis offset from the current point to the end point. + The weight of the conic. + Appends a conic curve using scalar offsets from the current point. + @@ -992,11 +1016,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the first control point. + The offset from the current point to the second control point. + The offset from the current point to the end point. + Appends a cubic Bézier curve using offsets from the current point. + @@ -1020,14 +1044,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-axis offset from the current point to the first control point. + The y-axis offset from the current point to the first control point. + The x-axis offset from the current point to the second control point. + The y-axis offset from the current point to the second control point. + The x-axis offset from the current point to the end point. + The y-axis offset from the current point to the end point. + Appends a cubic Bézier curve using scalar offsets from the current point. + @@ -1044,8 +1068,8 @@ - To be added. - To be added. + Removes all contours and resets the builder to an empty state. + @@ -1064,9 +1088,9 @@ - To be added. - To be added. - To be added. + The path whose contours are appended in reverse. + Appends the contours of another path in reverse order. + @@ -1085,9 +1109,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the end point. + Appends a straight line from the current point to a point offset by the specified amount. + @@ -1107,10 +1131,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. + Appends a straight line from the current point to a point offset by the specified amounts. + @@ -1129,9 +1153,9 @@ - To be added. - To be added. - To be added. + The offset from the current point to the new contour start. + Begins a new contour at a point offset from the current point. + @@ -1151,10 +1175,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. + Begins a new contour at a point offset from the current point by the specified amounts. + @@ -1174,10 +1198,10 @@ - To be added. - To be added. - To be added. - To be added. + The offset from the current point to the control point. + The offset from the current point to the end point. + Appends a quadratic Bézier curve using offsets from the current point. + @@ -1199,12 +1223,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-axis offset from the current point to the control point. + The y-axis offset from the current point to the control point. + The x-axis offset from the current point to the end point. + The y-axis offset from the current point to the end point. + Appends a quadratic Bézier curve using scalar offsets from the current point. + @@ -1221,9 +1245,9 @@ - To be added. - To be added. - To be added. + Returns a snapshot of the current path without modifying the builder. + A new that is a read-only snapshot of the current contours. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..5a3d99a4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -345,13 +345,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The distance along the path at which the segment begins. + The distance along the path at which the segment ends. + The to append the segment to. + to prepend a move-to command to the start of the segment; otherwise, . + Extracts the path segment between the specified distances from the start of the path. + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml index 627bf7d8..4ac8eb08 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPixmap.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPixmap.xml @@ -15,10 +15,10 @@ - + [System.Runtime.CompilerServices.Nullable(0)] - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -250,10 +250,10 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.Nullable(2)] - + [get: System.Runtime.CompilerServices.NullableContext(2)] @@ -421,7 +421,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -453,7 +453,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -485,7 +485,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -517,7 +517,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -1092,7 +1092,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -1284,7 +1284,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -1311,7 +1311,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -1344,7 +1344,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -1359,7 +1359,7 @@ System.ValueType - + [System.Runtime.CompilerServices.IsUnmanaged] @@ -1385,7 +1385,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(0)] @@ -1400,7 +1400,7 @@ System.ValueType - + [System.Runtime.CompilerServices.IsUnmanaged] diff --git a/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml b/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml index 040630d1..4efce096 100644 --- a/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml +++ b/SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml @@ -20,7 +20,7 @@ [System.Runtime.CompilerServices.IsReadOnly] - + [System.Runtime.CompilerServices.CompilerFeatureRequired("RefStructs")] diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..c8424a79 100644 --- a/SkiaSharpAPI/SkiaSharp/SKStream.xml +++ b/SkiaSharpAPI/SkiaSharp/SKStream.xml @@ -33,9 +33,9 @@ - To be added. - To be added. - To be added. + Returns the entire stream contents as an object. + An containing all bytes in the stream, or if the stream does not support this operation. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..38f21ea4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -2826,12 +2826,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination canvas to draw onto. + The destination point at which to draw the top-left corner of the surface. + The sampling options to use when scaling or filtering the surface image. + The paint to apply, or to use default settings. + Draws this surface's contents onto the specified canvas at the given point. + @@ -2885,13 +2885,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination canvas to draw onto. + The x-coordinate of the destination point. + The y-coordinate of the destination point. + The sampling options to use when scaling or filtering the surface image. + The paint to apply, or to use default settings. + Draws this surface's contents onto the specified canvas at the given coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml b/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml index 8b19ae7b..2b19dbc4 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTextBlob.xml @@ -56,7 +56,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] @@ -98,7 +98,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -129,7 +129,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -172,7 +172,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -204,7 +204,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -250,7 +250,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -283,7 +283,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -295,7 +295,7 @@ - + [System.Runtime.CompilerServices.Nullable(0)] @@ -334,7 +334,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -376,7 +376,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -411,7 +411,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -421,7 +421,7 @@ - + [System.Runtime.CompilerServices.Nullable(0)] @@ -457,7 +457,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -497,7 +497,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -507,7 +507,7 @@ - + [System.Runtime.CompilerServices.Nullable(0)] @@ -545,7 +545,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -595,7 +595,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -626,7 +626,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -638,7 +638,7 @@ - + [System.Runtime.CompilerServices.Nullable(0)] @@ -675,7 +675,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -715,7 +715,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -754,7 +754,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -785,7 +785,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -797,7 +797,7 @@ - + [System.Runtime.CompilerServices.Nullable(0)] @@ -834,7 +834,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -874,7 +874,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -933,7 +933,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -945,7 +945,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] @@ -983,7 +983,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] diff --git a/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml index 15026356..d7736e12 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTextBlobBuilder.xml @@ -130,7 +130,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -489,7 +489,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -498,7 +498,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -604,7 +604,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -945,7 +945,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -980,7 +980,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -1438,7 +1438,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -1586,7 +1586,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -1658,7 +1658,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -1798,7 +1798,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -1838,7 +1838,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -1874,7 +1874,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -1912,7 +1912,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -1946,7 +1946,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -1982,7 +1982,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -2016,7 +2016,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -2052,7 +2052,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -2090,7 +2090,7 @@ - + [System.Runtime.CompilerServices.Nullable(1)] @@ -2150,7 +2150,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -2183,7 +2183,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -2257,7 +2257,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -2413,7 +2413,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(1)] @@ -2455,7 +2455,7 @@ 4.147.0.0 - + [System.Runtime.CompilerServices.NullableContext(2)] diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index b0f4c2f3..5727e974 100644 --- a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml @@ -118,10 +118,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The specifying the variation design position, palette index, and palette overrides. + Creates a new typeface that applies the specified font arguments, including variation position and palette settings. + A new customized with the provided arguments. + @@ -140,10 +140,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the CPAL color palette to select. + Creates a new typeface that uses the specified color palette index. + A new using the specified palette. + @@ -162,10 +162,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + A read-only span of values, one per axis to position. + Creates a new typeface positioned at the specified variation design coordinates. + A new at the specified design position. + @@ -686,9 +686,9 @@ Typeface objects are immutable, and so they can be shared between threads. SkiaSharp.SKTypeface - To be added. - To be added. - To be added. + Gets a typeface that has no glyphs, used as a safe default or null-object substitute. + The shared empty instance. + @@ -1745,10 +1745,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + The span to fill with values. + Fills a span with information about all variation axes defined in the typeface. + The number of axis entries written to . + @@ -1767,10 +1767,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + The span to fill with values. + Fills a span with the current design-space coordinates for all variation axes. + The number of coordinate entries written to . + @@ -1859,9 +1859,9 @@ A typeface is understood to be bold when the weight is greater than or equal to System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether this typeface contains no glyphs. + if the typeface has a glyph count of zero; otherwise, . + @@ -2219,9 +2219,9 @@ A typeface is understood to be italic when it has a slant of either System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes defined in the typeface. + The total number of variation axes. + @@ -2237,9 +2237,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationAxis[] - To be added. - To be added. - To be added. + Gets an array of information about all variation axes defined in the typeface. + An array of values describing each axis. + @@ -2255,9 +2255,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationPositionCoordinate[] - To be added. - To be added. - To be added. + Gets an array of the current design-space coordinates for all variation axes. + An array of values for each axis. + @@ -2273,9 +2273,9 @@ A typeface is understood to be italic when it has a slant of either System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes for which a design position is defined. + The total number of variation axis coordinates. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..4d96e302 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,30 @@ - To be added. - To be added. + Provides static methods for encoding pixel data to the WebP image format. + @@ -42,11 +64,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The source pixel map to encode. + The encoding options, including compression type and quality. + Encodes the specified pixel map to WebP and returns the result as an object. + A new containing the encoded WebP bytes, or if encoding failed. + @@ -72,12 +94,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to write the encoded WebP data to. + The source pixel map to encode. + The encoding options, including compression type and quality. + Encodes the specified pixel map to WebP and writes the result to a SkiaSharp write stream. + if encoding succeeded; otherwise, . + @@ -103,12 +125,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to write the encoded WebP data to. + The source pixel map to encode. + The encoding options, including compression type and quality. + Encodes the specified pixel map to WebP and writes the result to a managed stream. + if encoding succeeded; otherwise, . + @@ -133,11 +155,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A read-only span of values defining the animation frames. + The encoding options, including compression type and quality. + Encodes a sequence of frames to an animated WebP and returns the result as an object. + A new containing the animated WebP bytes, or if encoding failed. + @@ -164,12 +186,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to write the animated WebP data to. + A read-only span of values defining the animation frames. + The encoding options, including compression type and quality. + Encodes a sequence of frames to an animated WebP and writes the result to a SkiaSharp write stream. + if encoding succeeded; otherwise, . + @@ -196,12 +218,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The to write the animated WebP data to. + A read-only span of values defining the animation frames. + The encoding options, including compression type and quality. + Encodes a sequence of frames to an animated WebP and writes the result to a managed stream. + if encoding succeeded; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..cca51ca5 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,35 @@ - To be added. - To be added. + Represents a single frame in an animated WebP sequence. + ) with a display duration. +Use `SKWebpEncoderFrame` with to create +animated WebP files. + +`SKWebpEncoderFrame` is a value type. The constructors that accept + or copy the pixel reference internally; +the source must remain alive during encoding. + +## Examples + +```csharp +var frames = new[] +{ + new SKWebpEncoderFrame(bitmap1, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(bitmap2, TimeSpan.FromMilliseconds(100)), + new SKWebpEncoderFrame(bitmap3, TimeSpan.FromMilliseconds(200)), +}; + +var options = new SKWebpEncoderOptions(SKWebpEncoderCompression.Lossy, 90); +using var data = SKWebpEncoder.EncodeAnimated(frames, options); +if (data is not null) + File.WriteAllBytes("animation.webp", data.ToArray()); +``` +]]> @@ -29,10 +56,10 @@ - To be added. - To be added. - To be added. - To be added. + The that provides the pixel data for this frame. + The display duration of this frame in the animation. + Initializes a new instance of the struct from a bitmap. + @@ -49,10 +76,10 @@ - To be added. - To be added. - To be added. - To be added. + The that provides the pixel data for this frame. + The display duration of this frame in the animation. + Initializes a new instance of the struct from an image. + @@ -69,10 +96,10 @@ - To be added. - To be added. - To be added. - To be added. + The that provides the pixel data for this frame. + The display duration of this frame in the animation. + Initializes a new instance of the struct from a pixel map. + @@ -93,9 +120,9 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the display duration of this frame. + The amount of time this frame is displayed during animation playback. + @@ -116,9 +143,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixel data for this frame. + An containing the pixel data to encode for this frame. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..d7c1cbd7 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -140,6 +140,7 @@ + @@ -212,6 +213,7 @@ + @@ -435,6 +437,7 @@ + @@ -750,12 +753,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -812,13 +815,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -846,13 +849,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -912,14 +915,14 @@ System.Void - - - - - - - - + + + + + + + + The canvas to draw on. @@ -948,11 +951,11 @@ System.Void - - - - - + + + + + The canvas to draw on. @@ -1006,12 +1009,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1038,12 +1041,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1100,13 +1103,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -1121,6 +1124,126 @@ + + + + + + + + + ExtensionMethod + + HarfBuzzSharp.HBColor + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + + + ExtensionMethod + + HarfBuzzSharp.HBColor + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + + + ExtensionMethod + + SkiaSharp.SKColor + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + + + ExtensionMethod + + SkiaSharp.SKColorF + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + + + ExtensionMethod + + SkiaSharp.SKColor[] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + @@ -1204,7 +1327,7 @@ System.Int32 - + The color type to query. @@ -1556,7 +1679,7 @@ SkiaSharp.SKSamplingOptions - + The filter quality to convert. @@ -3124,7 +3247,7 @@ ExtensionMethod - + To be added. @@ -3146,7 +3269,7 @@ ExtensionMethod - + To be added. @@ -3168,7 +3291,7 @@ ExtensionMethod - + To be added. @@ -3190,7 +3313,7 @@ ExtensionMethod - + To be added. @@ -3212,7 +3335,7 @@ ExtensionMethod - + To be added. @@ -3234,7 +3357,7 @@ ExtensionMethod - + To be added. @@ -3256,7 +3379,7 @@ ExtensionMethod - + To be added. @@ -3478,7 +3601,7 @@ ExtensionMethod - + To be added. @@ -3500,7 +3623,7 @@ ExtensionMethod - + To be added. @@ -3568,7 +3691,7 @@ ExtensionMethod - + To be added. @@ -3590,7 +3713,7 @@ ExtensionMethod - + To be added. @@ -3634,7 +3757,7 @@ ExtensionMethod - + To be added. @@ -3678,7 +3801,7 @@ ExtensionMethod - + To be added. @@ -4860,9 +4983,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -4960,10 +5083,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -5036,9 +5159,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap. @@ -6276,12 +6399,12 @@ - - - + + + ExtensionMethod - Microsoft.Maui.Hosting.MauiAppBuilder + Microsoft.Maui.Hosting.MauiAppBuilder @@ -6992,7 +7115,7 @@ SkiaSharp.SKColorF - + The Tizen NUI color. @@ -7036,7 +7159,7 @@ SkiaSharp.SKPoint - + The Tizen NUI position. @@ -7080,7 +7203,7 @@ SkiaSharp.SKPointI - + The Tizen NUI 2D position. @@ -7124,7 +7247,7 @@ SkiaSharp.SKRect - + The Tizen NUI rectangle. @@ -7168,7 +7291,7 @@ SkiaSharp.SKRectI - + The Tizen NUI rectangle. @@ -7212,7 +7335,7 @@ SkiaSharp.SKSize - + The Tizen NUI size. @@ -7256,7 +7379,7 @@ SkiaSharp.SKSizeI - + The Tizen NUI 2D size. @@ -8414,9 +8537,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -8514,10 +8637,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -8590,9 +8713,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap.