From 78cd692517f0a95d40b510d2505a9001332afcbd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 20 May 2026 21:57:38 +0000 Subject: [PATCH 1/2] Fill all documentation placeholder fields in 27 API docs work files Complete all 'To be added.' fields with accurate .NET XML documentation for SkiaSharp and HarfBuzzSharp APIs. Covers: - HarfBuzzSharp: Face (21 entries), Font (6 entries) - SkiaSharp: GRVkYcbcrComponents, GrVkYcbcrConversionInfo, SKCanvas, SKColorSpace, SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp, SKColorType, SKDocumentXpsOptions, SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag, SKPaint, SKPath, SKPathBuilder (51 entries), SKPathMeasure, SKStream, SKSurface, SKTypeface, SKWebpEncoder, SKWebpEncoderFrame - SkiaSharp.Views.Blazor: _Imports - SkiaSharp.Views.Gtk: GTKExtensions (13 entries), SKDrawingArea Also fixes a LineTo/MoveTo summary swap in SKPathBuilder.json. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- output/docs-work/HarfBuzzSharp__Face.json | 276 +++++++ output/docs-work/HarfBuzzSharp__Font.json | 83 ++ .../SkiaSharp.Views.Blazor___Imports.json | 16 + .../SkiaSharp.Views.Gtk__GTKExtensions.json | 188 +++++ .../SkiaSharp.Views.Gtk__SKDrawingArea.json | 16 + .../SkiaSharp__GRVkYcbcrComponents.json | 128 +++ .../SkiaSharp__GrVkYcbcrConversionInfo.json | 39 + output/docs-work/SkiaSharp__SKCanvas.json | 39 + output/docs-work/SkiaSharp__SKColorSpace.json | 21 + output/docs-work/SkiaSharp__SKColorType.json | 33 + .../SkiaSharp__SKColorspacePrimariesCicp.json | 123 +++ ...SkiaSharp__SKColorspaceTransferFnCicp.json | 141 ++++ .../SkiaSharp__SKDocumentXpsOptions.json | 106 +++ .../docs-work/SkiaSharp__SKFontArguments.json | 59 ++ .../SkiaSharp__SKFontPaletteOverride.json | 106 +++ .../SkiaSharp__SKFontVariationAxis.json | 139 ++++ ...rp__SKFontVariationPositionCoordinate.json | 106 +++ .../docs-work/SkiaSharp__SKFourByteTag.json | 166 ++++ output/docs-work/SkiaSharp__SKPaint.json | 103 +++ output/docs-work/SkiaSharp__SKPath.json | 61 ++ .../docs-work/SkiaSharp__SKPathBuilder.json | 737 ++++++++++++++++++ .../docs-work/SkiaSharp__SKPathMeasure.json | 23 + output/docs-work/SkiaSharp__SKStream.json | 17 + output/docs-work/SkiaSharp__SKSurface.json | 39 + output/docs-work/SkiaSharp__SKTypeface.json | 142 ++++ .../docs-work/SkiaSharp__SKWebpEncoder.json | 108 +++ .../SkiaSharp__SKWebpEncoderFrame.json | 78 ++ output/docs-work/manifest.json | 164 ++++ 28 files changed, 3257 insertions(+) create mode 100644 output/docs-work/HarfBuzzSharp__Face.json create mode 100644 output/docs-work/HarfBuzzSharp__Font.json create mode 100644 output/docs-work/SkiaSharp.Views.Blazor___Imports.json create mode 100644 output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json create mode 100644 output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json create mode 100644 output/docs-work/SkiaSharp__GRVkYcbcrComponents.json create mode 100644 output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json create mode 100644 output/docs-work/SkiaSharp__SKCanvas.json create mode 100644 output/docs-work/SkiaSharp__SKColorSpace.json create mode 100644 output/docs-work/SkiaSharp__SKColorType.json create mode 100644 output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json create mode 100644 output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json create mode 100644 output/docs-work/SkiaSharp__SKDocumentXpsOptions.json create mode 100644 output/docs-work/SkiaSharp__SKFontArguments.json create mode 100644 output/docs-work/SkiaSharp__SKFontPaletteOverride.json create mode 100644 output/docs-work/SkiaSharp__SKFontVariationAxis.json create mode 100644 output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json create mode 100644 output/docs-work/SkiaSharp__SKFourByteTag.json create mode 100644 output/docs-work/SkiaSharp__SKPaint.json create mode 100644 output/docs-work/SkiaSharp__SKPath.json create mode 100644 output/docs-work/SkiaSharp__SKPathBuilder.json create mode 100644 output/docs-work/SkiaSharp__SKPathMeasure.json create mode 100644 output/docs-work/SkiaSharp__SKStream.json create mode 100644 output/docs-work/SkiaSharp__SKSurface.json create mode 100644 output/docs-work/SkiaSharp__SKTypeface.json create mode 100644 output/docs-work/SkiaSharp__SKWebpEncoder.json create mode 100644 output/docs-work/SkiaSharp__SKWebpEncoderFrame.json create mode 100644 output/docs-work/manifest.json diff --git a/output/docs-work/HarfBuzzSharp__Face.json b/output/docs-work/HarfBuzzSharp__Face.json new file mode 100644 index 00000000..a54d26ef --- /dev/null +++ b/output/docs-work/HarfBuzzSharp__Face.json @@ -0,0 +1,276 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "An array of design coordinate values for the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "summary": "Returns all design coordinate values for the specified named instance." + }, + "signature": "public float[] GetNamedInstanceDesignCoords (int instanceIndex);", + "memberName": "GetNamedInstanceDesignCoords", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoords(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The number of design coordinates written into .", + "params": { + "instanceIndex": "The zero-based index of the named instance.", + "coords": "A span that receives the design coordinate values." + }, + "summary": "Fills the provided span with design coordinate values for the specified named instance." + }, + "signature": "public int GetNamedInstanceDesignCoords (int instanceIndex, Span coords);", + "memberName": "GetNamedInstanceDesignCoords", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoords(System.Int32,System.Span{System.Single})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The number of design coordinates associated with the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "summary": "Returns the number of design coordinates for the specified named instance." + }, + "signature": "public int GetNamedInstanceDesignCoordsCount (int instanceIndex);", + "memberName": "GetNamedInstanceDesignCoordsCount", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceDesignCoordsCount(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The name ID of the PostScript name for the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "summary": "Returns the OpenType name ID of the PostScript name for the specified named instance." + }, + "signature": "public HarfBuzzSharp.OpenTypeNameId GetNamedInstancePostScriptNameId (int instanceIndex);", + "memberName": "GetNamedInstancePostScriptNameId", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstancePostScriptNameId(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The name ID of the subfamily name for the specified named instance.", + "params": { + "instanceIndex": "The zero-based index of the named instance." + }, + "summary": "Returns the OpenType name ID of the subfamily name for the specified named instance." + }, + "signature": "public HarfBuzzSharp.OpenTypeNameId GetNamedInstanceSubfamilyNameId (int instanceIndex);", + "memberName": "GetNamedInstanceSubfamilyNameId", + "docId": "M:HarfBuzzSharp.Face.GetNamedInstanceSubfamilyNameId(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The OpenType name ID for the color at the specified index.", + "params": { + "colorIndex": "The zero-based index of the color entry." + }, + "summary": "Returns the OpenType name ID for the specified color entry in the font's color palette." + }, + "signature": "public HarfBuzzSharp.OpenTypeNameId GetPaletteColorNameId (int colorIndex);", + "memberName": "GetPaletteColorNameId", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColorNameId(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An array of colors in the specified palette, encoded as hb_color_t values (BGRA byte order: blue in the high byte, alpha in the low byte).", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "summary": "Returns all colors in the specified color palette." + }, + "signature": "public uint[] GetPaletteColors (int paletteIndex);", + "memberName": "GetPaletteColors", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColors(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The number of colors written into .", + "params": { + "colors": "A span that receives the palette colors, encoded as hb_color_t values (BGRA byte order: blue in the high byte, alpha in the low byte).", + "paletteIndex": "The zero-based index of the color palette." + }, + "summary": "Fills the provided span with colors from the specified color palette." + }, + "signature": "public int GetPaletteColors (int paletteIndex, Span colors);", + "memberName": "GetPaletteColors", + "docId": "M:HarfBuzzSharp.Face.GetPaletteColors(System.Int32,System.Span{System.UInt32})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A bitwise combination of values describing the palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "summary": "Returns the flags associated with the specified color palette." + }, + "signature": "public HarfBuzzSharp.OpenTypeColorPaletteFlags GetPaletteFlags (int paletteIndex);", + "memberName": "GetPaletteFlags", + "docId": "M:HarfBuzzSharp.Face.GetPaletteFlags(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The OpenType name ID for the specified palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette." + }, + "summary": "Returns the OpenType name ID for the specified color palette." + }, + "signature": "public HarfBuzzSharp.OpenTypeNameId GetPaletteNameId (int paletteIndex);", + "memberName": "GetPaletteNameId", + "docId": "M:HarfBuzzSharp.Face.GetPaletteNameId(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The number of axis info entries written into .", + "params": { + "axes": "A span that receives the variation axis information." + }, + "summary": "Fills the provided span with information about the font's variation axes." + }, + "signature": "public int GetVariationAxisInfos (Span axes);", + "memberName": "GetVariationAxisInfos", + "docId": "M:HarfBuzzSharp.Face.GetVariationAxisInfos(System.Span{HarfBuzzSharp.OpenTypeVarAxisInfo})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": " if the font contains a COLR table with layered glyph color data; otherwise, .", + "summary": "Gets a value indicating whether the font contains color layer data (COLR table)." + }, + "signature": "public bool HasColorLayers { get; }", + "memberName": "HasColorLayers", + "docId": "P:HarfBuzzSharp.Face.HasColorLayers", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if the font contains PNG color glyph data; otherwise, .", + "summary": "Gets a value indicating whether the font contains PNG color glyph data." + }, + "signature": "public bool HasColorPng { get; }", + "memberName": "HasColorPng", + "docId": "P:HarfBuzzSharp.Face.HasColorPng", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if the font contains SVG color glyph data; otherwise, .", + "summary": "Gets a value indicating whether the font contains SVG color glyph data." + }, + "signature": "public bool HasColorSvg { get; }", + "memberName": "HasColorSvg", + "docId": "P:HarfBuzzSharp.Face.HasColorSvg", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if the font contains a CPAL table with color palettes; otherwise, .", + "summary": "Gets a value indicating whether the font contains color palettes (CPAL table)." + }, + "signature": "public bool HasPalettes { get; }", + "memberName": "HasPalettes", + "docId": "P:HarfBuzzSharp.Face.HasPalettes", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if the font contains OpenType variable font data; otherwise, .", + "summary": "Gets a value indicating whether the font contains OpenType variation data." + }, + "signature": "public bool HasVariationData { get; }", + "memberName": "HasVariationData", + "docId": "P:HarfBuzzSharp.Face.HasVariationData", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The total number of named instances defined in the font's variation data.", + "summary": "Gets the number of named instances defined in the font." + }, + "signature": "public int NamedInstanceCount { get; }", + "memberName": "NamedInstanceCount", + "docId": "P:HarfBuzzSharp.Face.NamedInstanceCount", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The total number of color palettes defined in the font's CPAL table.", + "summary": "Gets the number of color palettes available in the font." + }, + "signature": "public int PaletteCount { get; }", + "memberName": "PaletteCount", + "docId": "P:HarfBuzzSharp.Face.PaletteCount", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if a variation axis with the specified tag was found; otherwise, .", + "params": { + "tag": "The four-byte tag identifying the variation axis to search for.", + "axisInfo": "When this method returns, contains information about the located axis if found. This parameter is treated as uninitialized." + }, + "summary": "Attempts to find a variation axis by its tag." + }, + "signature": "public bool TryFindVariationAxis (HarfBuzzSharp.Tag tag, out HarfBuzzSharp.OpenTypeVarAxisInfo axisInfo);", + "memberName": "TryFindVariationAxis", + "docId": "M:HarfBuzzSharp.Face.TryFindVariationAxis(HarfBuzzSharp.Tag,HarfBuzzSharp.OpenTypeVarAxisInfo@)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The total number of variation axes defined in the font.", + "summary": "Gets the number of variation axes defined in the font." + }, + "signature": "public int VariationAxisCount { get; }", + "memberName": "VariationAxisCount", + "docId": "P:HarfBuzzSharp.Face.VariationAxisCount", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "An array containing information about each variation axis, or an empty array if the font has no variation data.", + "summary": "Gets information about all variation axes defined in the font." + }, + "signature": "public HarfBuzzSharp.OpenTypeVarAxisInfo[] VariationAxisInfos { get; }", + "memberName": "VariationAxisInfos", + "docId": "P:HarfBuzzSharp.Face.VariationAxisInfos", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/HarfBuzzSharp/Face.xml", + "typeName": "HarfBuzzSharp.Face" +} diff --git a/output/docs-work/HarfBuzzSharp__Font.json b/output/docs-work/HarfBuzzSharp__Font.json new file mode 100644 index 00000000..723094ff --- /dev/null +++ b/output/docs-work/HarfBuzzSharp__Font.json @@ -0,0 +1,83 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "The number of normalized coordinates written into .", + "params": { + "coords": "A span that receives the normalized variation coordinates." + }, + "summary": "Fills the provided span with the current normalized variation coordinates of the font." + }, + "signature": "public int GetVariationCoordsNormalized (Span coords);", + "memberName": "GetVariationCoordsNormalized", + "docId": "M:HarfBuzzSharp.Font.GetVariationCoordsNormalized(System.Span{System.Int32})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "coords": "A read-only span of design-space coordinate values, one per variation axis." + }, + "summary": "Sets the font's variation coordinates using design-space values." + }, + "signature": "public void SetVariationCoordsDesign (ReadOnlySpan coords);", + "memberName": "SetVariationCoordsDesign", + "docId": "M:HarfBuzzSharp.Font.SetVariationCoordsDesign(System.ReadOnlySpan{System.Single})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "coords": "A read-only span of normalized variation coordinate values (typically in the range -16384 to 16384), one per variation axis." + }, + "summary": "Sets the font's variation coordinates using pre-normalized values." + }, + "signature": "public void SetVariationCoordsNormalized (ReadOnlySpan coords);", + "memberName": "SetVariationCoordsNormalized", + "docId": "M:HarfBuzzSharp.Font.SetVariationCoordsNormalized(System.ReadOnlySpan{System.Int32})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "instanceIndex": "The zero-based index of the named instance to apply." + }, + "summary": "Sets the font's variation coordinates to match the specified named instance." + }, + "signature": "public void SetVariationNamedInstance (int instanceIndex);", + "memberName": "SetVariationNamedInstance", + "docId": "M:HarfBuzzSharp.Font.SetVariationNamedInstance(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "variations": "A read-only span of values specifying the axis tags and their desired design-space values." + }, + "summary": "Sets the font's variation axes to the specified design-space values." + }, + "signature": "public void SetVariations (ReadOnlySpan variations);", + "memberName": "SetVariations", + "docId": "M:HarfBuzzSharp.Font.SetVariations(System.ReadOnlySpan{HarfBuzzSharp.Variation})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "An array of normalized variation coordinates, one per axis, or an empty array if no variation coordinates are set.", + "summary": "Gets the current normalized variation coordinates of the font." + }, + "signature": "public int[] VariationCoordsNormalized { get; }", + "memberName": "VariationCoordsNormalized", + "docId": "P:HarfBuzzSharp.Font.VariationCoordsNormalized", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/HarfBuzzSharp/Font.xml", + "typeName": "HarfBuzzSharp.Font" +} diff --git a/output/docs-work/SkiaSharp.Views.Blazor___Imports.json b/output/docs-work/SkiaSharp.Views.Blazor___Imports.json new file mode 100644 index 00000000..675acdb9 --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Blazor___Imports.json @@ -0,0 +1,16 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "summary": "This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code." + }, + "signature": "protected void Execute ();", + "memberName": "Execute", + "docId": "M:SkiaSharp.Views.Blazor._Imports.Execute", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml", + "typeName": "SkiaSharp.Views.Blazor._Imports" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json b/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json new file mode 100644 index 00000000..11b8636a --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Gtk__GTKExtensions.json @@ -0,0 +1,188 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "rect": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Gdk.Rectangle ToGdkRectangle (this SkiaSharp.SKRectI rect);", + "memberName": "ToGdkRectangle", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRectangle(SkiaSharp.SKRectI)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "color": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Gdk.RGBA ToGdkRGBA (this SkiaSharp.SKColor color);", + "memberName": "ToGdkRGBA", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRGBA(SkiaSharp.SKColor)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "color": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Gdk.RGBA ToGdkRGBA (this SkiaSharp.SKColorF color);", + "memberName": "ToGdkRGBA", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGdkRGBA(SkiaSharp.SKColorF)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "point": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Graphene.Point ToGraphenePoint (this SkiaSharp.SKPoint point);", + "memberName": "ToGraphenePoint", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGraphenePoint(SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "point": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Graphene.Point3D ToGraphenePoint3D (this SkiaSharp.SKPoint3 point);", + "memberName": "ToGraphenePoint3D", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGraphenePoint3D(SkiaSharp.SKPoint3)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "rect": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Graphene.Rect ToGrapheneRect (this SkiaSharp.SKRect rect);", + "memberName": "ToGrapheneRect", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGrapheneRect(SkiaSharp.SKRect)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A equivalent to the specified .", + "params": { + "size": "The to convert." + }, + "summary": "Converts an to a ." + }, + "signature": "public static Graphene.Size ToGrapheneSize (this SkiaSharp.SKSize size);", + "memberName": "ToGrapheneSize", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToGrapheneSize(SkiaSharp.SKSize)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "color": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKColor ToSKColor (this Gdk.RGBA color);", + "memberName": "ToSKColor", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKColor(Gdk.RGBA)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "color": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKColorF ToSKColorF (this Gdk.RGBA color);", + "memberName": "ToSKColorF", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKColorF(Gdk.RGBA)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "point": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKPoint ToSKPoint (this Graphene.Point point);", + "memberName": "ToSKPoint", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKPoint(Graphene.Point)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "point": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKPoint3 ToSKPoint3 (this Graphene.Point3D point);", + "memberName": "ToSKPoint3", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKPoint3(Graphene.Point3D)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "rect": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKRect ToSKRect (this Graphene.Rect rect);", + "memberName": "ToSKRect", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKRect(Graphene.Rect)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An equivalent to the specified .", + "params": { + "size": "The to convert." + }, + "summary": "Converts a to an ." + }, + "signature": "public static SkiaSharp.SKSize ToSKSize (this Graphene.Size size);", + "memberName": "ToSKSize", + "docId": "M:SkiaSharp.Views.Gtk.GTKExtensions.ToSKSize(Graphene.Size)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml", + "typeName": "SkiaSharp.Views.Gtk.GTKExtensions" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json b/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json new file mode 100644 index 00000000..dc4d5d32 --- /dev/null +++ b/output/docs-work/SkiaSharp.Views.Gtk__SKDrawingArea.json @@ -0,0 +1,16 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "summary": "Releases the resources used by the current instance of the class." + }, + "signature": "public override void Dispose ();", + "memberName": "Dispose", + "docId": "M:SkiaSharp.Views.Gtk.SKDrawingArea.Dispose", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml", + "typeName": "SkiaSharp.Views.Gtk.SKDrawingArea" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json b/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json new file mode 100644 index 00000000..dbfc5b21 --- /dev/null +++ b/output/docs-work/SkiaSharp__GRVkYcbcrComponents.json @@ -0,0 +1,128 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "remarksRequired": true, + "summary": "Describes the component swizzle mapping for each channel used in a Vulkan YCbCr color conversion." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": "The Vulkan component swizzle value for the alpha channel.", + "summary": "Gets or sets the swizzle value for the alpha (A) component." + }, + "signature": "public uint A { get; set; }", + "memberName": "A", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.A", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The Vulkan component swizzle value for the blue channel.", + "summary": "Gets or sets the swizzle value for the blue (B) component." + }, + "signature": "public uint B { get; set; }", + "memberName": "B", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.B", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if the two instances are equal; otherwise, .", + "params": { + "obj": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public readonly bool Equals (SkiaSharp.GRVkYcbcrComponents obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.Equals(SkiaSharp.GRVkYcbcrComponents)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override readonly bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The Vulkan component swizzle value for the green channel.", + "summary": "Gets or sets the swizzle value for the green (G) component." + }, + "signature": "public uint G { get; set; }", + "memberName": "G", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.G", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override readonly int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.GRVkYcbcrComponents left, SkiaSharp.GRVkYcbcrComponents right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.op_Equality(SkiaSharp.GRVkYcbcrComponents,SkiaSharp.GRVkYcbcrComponents)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.GRVkYcbcrComponents left, SkiaSharp.GRVkYcbcrComponents right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.GRVkYcbcrComponents.op_Inequality(SkiaSharp.GRVkYcbcrComponents,SkiaSharp.GRVkYcbcrComponents)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The Vulkan component swizzle value for the red channel.", + "summary": "Gets or sets the swizzle value for the red (R) component." + }, + "signature": "public uint R { get; set; }", + "memberName": "R", + "docId": "P:SkiaSharp.GRVkYcbcrComponents.R", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml", + "typeName": "SkiaSharp.GRVkYcbcrComponents" +} diff --git a/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json b/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json new file mode 100644 index 00000000..b4e519dc --- /dev/null +++ b/output/docs-work/SkiaSharp__GrVkYcbcrConversionInfo.json @@ -0,0 +1,39 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "value": "The describing the Vulkan component swizzle mapping for this conversion.", + "summary": "Gets or sets the component swizzle mapping used by this YCbCr conversion." + }, + "signature": "public SkiaSharp.GRVkYcbcrComponents Components { get; set; }", + "memberName": "Components", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.Components", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if the sampler filter must match the chroma filter; otherwise, .", + "summary": "Gets or sets a value indicating whether the sampler filter must match the chroma filter." + }, + "signature": "public bool SamplerFilterMustMatchChromaFilter { get; set; }", + "memberName": "SamplerFilterMustMatchChromaFilter", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.SamplerFilterMustMatchChromaFilter", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": " if linear filtering is supported for this YCbCr conversion; otherwise, .", + "summary": "Gets or sets a value indicating whether linear filtering is supported for this YCbCr conversion." + }, + "signature": "public bool SupportsLinearFilter { get; set; }", + "memberName": "SupportsLinearFilter", + "docId": "P:SkiaSharp.GrVkYcbcrConversionInfo.SupportsLinearFilter", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml", + "typeName": "SkiaSharp.GrVkYcbcrConversionInfo" +} diff --git a/output/docs-work/SkiaSharp__SKCanvas.json b/output/docs-work/SkiaSharp__SKCanvas.json new file mode 100644 index 00000000..0b511570 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKCanvas.json @@ -0,0 +1,39 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "params": { + "sampling": "The sampling options to use when drawing the surface.", + "paint": "The paint to use when drawing the surface, or to use the default paint.", + "p": "The position at which to draw the surface.", + "surface": "The surface to draw." + }, + "summary": "Draws the surface onto the canvas at the specified point using the given sampling options." + }, + "signature": "public void DrawSurface (SkiaSharp.SKSurface surface, SkiaSharp.SKPoint p, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "memberName": "DrawSurface", + "docId": "M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,SkiaSharp.SKPoint,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x": "The x-coordinate of the position at which to draw the surface.", + "sampling": "The sampling options to use when drawing the surface.", + "paint": "The paint to use when drawing the surface, or to use the default paint.", + "y": "The y-coordinate of the position at which to draw the surface.", + "surface": "The surface to draw." + }, + "summary": "Draws the surface onto the canvas at the specified coordinates using the given sampling options." + }, + "signature": "public void DrawSurface (SkiaSharp.SKSurface surface, float x, float y, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "memberName": "DrawSurface", + "docId": "M:SkiaSharp.SKCanvas.DrawSurface(SkiaSharp.SKSurface,System.Single,System.Single,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKCanvas.xml", + "typeName": "SkiaSharp.SKCanvas" +} diff --git a/output/docs-work/SkiaSharp__SKColorSpace.json b/output/docs-work/SkiaSharp__SKColorSpace.json new file mode 100644 index 00000000..7650f93f --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorSpace.json @@ -0,0 +1,21 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "A new representing the color space defined by the specified CICP primaries and transfer characteristics, or if the combination is not supported.", + "params": { + "transferCharacteristics": "One of the enumeration values that specifies the CICP-defined transfer function.", + "colorPrimaries": "One of the enumeration values that specifies the CICP-defined color primaries." + }, + "summary": "Creates a color space from the specified CICP (Coding-Independent Code Points) color primaries and transfer characteristics." + }, + "signature": "public static SkiaSharp.SKColorSpace CreateCicp (SkiaSharp.SKColorspacePrimariesCicp colorPrimaries, SkiaSharp.SKColorspaceTransferFnCicp transferCharacteristics);", + "memberName": "CreateCicp", + "docId": "M:SkiaSharp.SKColorSpace.CreateCicp(SkiaSharp.SKColorspacePrimariesCicp,SkiaSharp.SKColorspaceTransferFnCicp)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml", + "typeName": "SkiaSharp.SKColorSpace" +} diff --git a/output/docs-work/SkiaSharp__SKColorType.json b/output/docs-work/SkiaSharp__SKColorType.json new file mode 100644 index 00000000..84cf201e --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorType.json @@ -0,0 +1,33 @@ +{ + "entries": [ + { + "fields": { + "summary": "Four 10-bit unsigned integer channels (B, G, R, A) packed into 40 bits with extended-range support for wide-gamut HDR content (value 25)." + }, + "signature": "Bgra10101010XR", + "memberName": "Bgra10101010XR", + "docId": "F:SkiaSharp.SKColorType.Bgra10101010XR", + "memberType": "Field" + }, + { + "fields": { + "summary": "A single 16-bit unsigned normalized integer channel representing red (value 27). Each pixel uses 2 bytes." + }, + "signature": "R16Unorm", + "memberName": "R16Unorm", + "docId": "F:SkiaSharp.SKColorType.R16Unorm", + "memberType": "Field" + }, + { + "fields": { + "summary": "Three 16-bit floating-point channels (R, G, B) with a fourth padding channel (x), totaling 8 bytes per pixel. The padding channel is not used for alpha (value 26)." + }, + "signature": "RgbF16F16F16x", + "memberName": "RgbF16F16F16x", + "docId": "F:SkiaSharp.SKColorType.RgbF16F16F16x", + "memberType": "Field" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKColorType.xml", + "typeName": "SkiaSharp.SKColorType" +} diff --git a/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json b/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json new file mode 100644 index 00000000..d148c0fd --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json @@ -0,0 +1,123 @@ +{ + "entries": [ + { + "fields": { + "remarks": " to create a color space from standardized primaries.\n\nThis enumeration is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nusing var colorSpace = SKColorSpace.CreateCicp(\n SKColorspacePrimariesCicp.Rec709,\n SKColorspaceTransferFnCicp.Rec709);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies color primaries as defined by the CICP (Coding-Independent Code Points) standard." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "summary": "Generic film primaries (CICP value 8)." + }, + "signature": "GenericFilm", + "memberName": "GenericFilm", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.GenericFilm", + "memberType": "Field" + }, + { + "fields": { + "summary": "Color primaries defined by ITU-T H.273 for value 22." + }, + "signature": "ItuTH273Value22", + "memberName": "ItuTH273Value22", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.ItuTH273Value22", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.2020 and BT.2100 color primaries (CICP value 9)." + }, + "signature": "Rec2020", + "memberName": "Rec2020", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec2020", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.470 System B/G color primaries (CICP value 5)." + }, + "signature": "Rec470SystemBg", + "memberName": "Rec470SystemBg", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec470SystemBg", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.470 System M color primaries (CICP value 4)." + }, + "signature": "Rec470SystemM", + "memberName": "Rec470SystemM", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec470SystemM", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.601 color primaries (CICP value 6)." + }, + "signature": "Rec601", + "memberName": "Rec601", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec601", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.709 color primaries, used for HDTV and sRGB (CICP value 1)." + }, + "signature": "Rec709", + "memberName": "Rec709", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Rec709", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE EG 432-1 color primaries, used for DCI-P3 (CICP value 12)." + }, + "signature": "SmpteEg4321", + "memberName": "SmpteEg4321", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteEg4321", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE RP 431-2 color primaries (CICP value 11)." + }, + "signature": "SmpteRp4312", + "memberName": "SmpteRp4312", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteRp4312", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE ST 240 color primaries (CICP value 7)." + }, + "signature": "SmpteSt240", + "memberName": "SmpteSt240", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteSt240", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE ST 428-1 color primaries (CICP value 10)." + }, + "signature": "SmpteSt4281", + "memberName": "SmpteSt4281", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.SmpteSt4281", + "memberType": "Field" + }, + { + "fields": { + "summary": "Unknown or unspecified color primaries (CICP value 0)." + }, + "signature": "Unknown", + "memberName": "Unknown", + "docId": "F:SkiaSharp.SKColorspacePrimariesCicp.Unknown", + "memberType": "Field" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml", + "typeName": "SkiaSharp.SKColorspacePrimariesCicp" +} diff --git a/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json b/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json new file mode 100644 index 00000000..dd30ae99 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json @@ -0,0 +1,141 @@ +{ + "entries": [ + { + "fields": { + "remarks": " to create a color space from standardized transfer characteristics.\n\nThis enumeration is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nusing var colorSpace = SKColorSpace.CreateCicp(\n SKColorspacePrimariesCicp.Rec2020,\n SKColorspaceTransferFnCicp.Pq);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies transfer function characteristics as defined by the CICP (Coding-Independent Code Points) standard." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "summary": "Hybrid Log-Gamma (HLG) transfer function (CICP value 18)." + }, + "signature": "Hlg", + "memberName": "Hlg", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Hlg", + "memberType": "Field" + }, + { + "fields": { + "summary": "IEC 61966-2-1 (sRGB) transfer function (CICP value 13)." + }, + "signature": "Iec6196621", + "memberName": "Iec6196621", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Iec6196621", + "memberType": "Field" + }, + { + "fields": { + "summary": "IEC 61966-2-4 transfer function (CICP value 11)." + }, + "signature": "Iec6196624", + "memberName": "Iec6196624", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Iec6196624", + "memberType": "Field" + }, + { + "fields": { + "summary": "Linear transfer function with no gamma encoding (CICP value 8)." + }, + "signature": "Linear", + "memberName": "Linear", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Linear", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE ST 2084 (Perceptual Quantizer) HDR transfer function (CICP value 16)." + }, + "signature": "Pq", + "memberName": "Pq", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Pq", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.2020 10-bit transfer function (CICP value 14)." + }, + "signature": "Rec202010bit", + "memberName": "Rec202010bit", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec202010bit", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.2020 12-bit transfer function (CICP value 15)." + }, + "signature": "Rec202012bit", + "memberName": "Rec202012bit", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec202012bit", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.470 System B/G transfer function with assumed gamma 2.8 (CICP value 5)." + }, + "signature": "Rec470SystemBg", + "memberName": "Rec470SystemBg", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec470SystemBg", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.470 System M transfer function with assumed gamma 2.2 (CICP value 4)." + }, + "signature": "Rec470SystemM", + "memberName": "Rec470SystemM", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec470SystemM", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.601 transfer function (CICP value 6)." + }, + "signature": "Rec601", + "memberName": "Rec601", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec601", + "memberType": "Field" + }, + { + "fields": { + "summary": "ITU-R BT.709 transfer function, used for HDTV (CICP value 1)." + }, + "signature": "Rec709", + "memberName": "Rec709", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Rec709", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE ST 240 transfer function (CICP value 7)." + }, + "signature": "SmpteSt240", + "memberName": "SmpteSt240", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.SmpteSt240", + "memberType": "Field" + }, + { + "fields": { + "summary": "SMPTE ST 428-1 transfer function (CICP value 17)." + }, + "signature": "SmpteSt4281", + "memberName": "SmpteSt4281", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.SmpteSt4281", + "memberType": "Field" + }, + { + "fields": { + "summary": "Unknown or unspecified transfer function (CICP value 0)." + }, + "signature": "Unknown", + "memberName": "Unknown", + "docId": "F:SkiaSharp.SKColorspaceTransferFnCicp.Unknown", + "memberType": "Field" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml", + "typeName": "SkiaSharp.SKColorspaceTransferFnCicp" +} diff --git a/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json b/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json new file mode 100644 index 00000000..72d32e83 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKDocumentXpsOptions.json @@ -0,0 +1,106 @@ +{ + "entries": [ + { + "fields": { + "remarks": ". Set the desired raster DPI and other options before passing the struct to the factory method.\n\nThis struct is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar options = new SKDocumentXpsOptions\n{\n DPI = 300,\n AllowNoPngs = false,\n};\nusing var stream = File.OpenWrite(\"output.xps\");\nusing var document = SKDocument.CreateXps(stream, options);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies the options used when creating an XPS document." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": " if the XPS document may omit PNG image resources; otherwise, .", + "summary": "Gets or sets a value indicating whether PNG image resources may be omitted from the XPS document." + }, + "signature": "public bool AllowNoPngs { get; set; }", + "memberName": "AllowNoPngs", + "docId": "P:SkiaSharp.SKDocumentXpsOptions.AllowNoPngs", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The raster image resolution in dots per inch.", + "summary": "Gets or sets the resolution in dots per inch (DPI) used for rasterizing content in the XPS document." + }, + "signature": "public float DPI { get; set; }", + "memberName": "DPI", + "docId": "P:SkiaSharp.SKDocumentXpsOptions.DPI", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if the two instances are equal; otherwise, .", + "params": { + "obj": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public readonly bool Equals (SkiaSharp.SKDocumentXpsOptions obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.Equals(SkiaSharp.SKDocumentXpsOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override readonly bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override readonly int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.SKDocumentXpsOptions left, SkiaSharp.SKDocumentXpsOptions right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.op_Equality(SkiaSharp.SKDocumentXpsOptions,SkiaSharp.SKDocumentXpsOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.SKDocumentXpsOptions left, SkiaSharp.SKDocumentXpsOptions right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKDocumentXpsOptions.op_Inequality(SkiaSharp.SKDocumentXpsOptions,SkiaSharp.SKDocumentXpsOptions)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml", + "typeName": "SkiaSharp.SKDocumentXpsOptions" +} diff --git a/output/docs-work/SkiaSharp__SKFontArguments.json b/output/docs-work/SkiaSharp__SKFontArguments.json new file mode 100644 index 00000000..857ada5b --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontArguments.json @@ -0,0 +1,59 @@ +{ + "entries": [ + { + "fields": { + "remarks": " to produce a customized typeface.\n\nThis is a `ref struct` and cannot be boxed or stored on the heap.\n\n## Examples\n\n```csharp\nvar args = new SKFontArguments\n{\n CollectionIndex = 0,\n VariationDesignPosition = new SKFontVariationPositionCoordinate[]\n {\n new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse(\"wght\"), Value = 700 },\n },\n};\nusing var boldFace = typeface.Clone(args);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies the arguments used to create or clone a typeface with custom settings." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": "The zero-based index of the font within a font collection (TTC file). The default value is 0.", + "summary": "Gets or sets the index of the desired font face within a font collection." + }, + "signature": "public int CollectionIndex { get; set; }", + "memberName": "CollectionIndex", + "docId": "P:SkiaSharp.SKFontArguments.CollectionIndex", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The zero-based index of the color palette to select. The default value is 0.", + "summary": "Gets or sets the index of the color palette to use for a color font." + }, + "signature": "public int PaletteIndex { get; set; }", + "memberName": "PaletteIndex", + "docId": "P:SkiaSharp.SKFontArguments.PaletteIndex", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "A read-only span of values that override individual palette colors.", + "summary": "Gets or sets the per-color overrides applied to the selected color palette." + }, + "signature": "public ReadOnlySpan PaletteOverrides { get; set; }", + "memberName": "PaletteOverrides", + "docId": "P:SkiaSharp.SKFontArguments.PaletteOverrides", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "A read-only span of values, each specifying an axis tag and a design-space coordinate value.", + "summary": "Gets or sets the variation design position used to configure variable font axes." + }, + "signature": "public ReadOnlySpan VariationDesignPosition { get; set; }", + "memberName": "VariationDesignPosition", + "docId": "P:SkiaSharp.SKFontArguments.VariationDesignPosition", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml", + "typeName": "SkiaSharp.SKFontArguments" +} diff --git a/output/docs-work/SkiaSharp__SKFontPaletteOverride.json b/output/docs-work/SkiaSharp__SKFontPaletteOverride.json new file mode 100644 index 00000000..20354d1b --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontPaletteOverride.json @@ -0,0 +1,106 @@ +{ + "entries": [ + { + "fields": { + "remarks": " to customize individual colors in the selected palette when cloning a typeface.\n\nThe `Color` property stores an `SKColor` value in ARGB format (`0xAARRGGBB`).\n\n## Examples\n\n```csharp\nvar overrides = new SKFontPaletteOverride[]\n{\n new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red },\n};\nvar args = new SKFontArguments { PaletteOverrides = overrides };\nusing var face = typeface.Clone(args);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies a replacement color for a single entry in a color font palette." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": "The replacement color for the palette entry, stored as an packed into a 32-bit unsigned integer in ARGB format (0xAARRGGBB).", + "summary": "Gets or sets the replacement color for the palette entry." + }, + "signature": "public uint Color { get; set; }", + "memberName": "Color", + "docId": "P:SkiaSharp.SKFontPaletteOverride.Color", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if the two instances are equal; otherwise, .", + "params": { + "obj": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public readonly bool Equals (SkiaSharp.SKFontPaletteOverride obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontPaletteOverride.Equals(SkiaSharp.SKFontPaletteOverride)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override readonly bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontPaletteOverride.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override readonly int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontPaletteOverride.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The zero-based index of the palette entry to override.", + "summary": "Gets or sets the index of the palette color entry to replace." + }, + "signature": "public ushort Index { get; set; }", + "memberName": "Index", + "docId": "P:SkiaSharp.SKFontPaletteOverride.Index", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.SKFontPaletteOverride left, SkiaSharp.SKFontPaletteOverride right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontPaletteOverride.op_Equality(SkiaSharp.SKFontPaletteOverride,SkiaSharp.SKFontPaletteOverride)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.SKFontPaletteOverride left, SkiaSharp.SKFontPaletteOverride right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontPaletteOverride.op_Inequality(SkiaSharp.SKFontPaletteOverride,SkiaSharp.SKFontPaletteOverride)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml", + "typeName": "SkiaSharp.SKFontPaletteOverride" +} diff --git a/output/docs-work/SkiaSharp__SKFontVariationAxis.json b/output/docs-work/SkiaSharp__SKFontVariationAxis.json new file mode 100644 index 00000000..880518b1 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontVariationAxis.json @@ -0,0 +1,139 @@ +{ + "entries": [ + { + "fields": { + "remarks": " or to retrieve the axes for a typeface.\n\nThis struct is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar axes = typeface.VariationDesignParameters;\nforeach (var axis in axes)\n{\n Console.WriteLine($\"{axis.Tag}: [{axis.Min}, {axis.Max}], default={axis.Default}\");\n}\n```\n]]>", + "remarksRequired": true, + "summary": "Describes a single variation axis in an OpenType variable font." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": "The default design-space value for this variation axis.", + "summary": "Gets or sets the default value for this variation axis." + }, + "signature": "public float Default { get; set; }", + "memberName": "Default", + "docId": "P:SkiaSharp.SKFontVariationAxis.Default", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if the two instances are equal; otherwise, .", + "params": { + "obj": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public readonly bool Equals (SkiaSharp.SKFontVariationAxis obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationAxis.Equals(SkiaSharp.SKFontVariationAxis)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override readonly bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationAxis.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override readonly int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontVariationAxis.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": " if this axis should be hidden in user interfaces; otherwise, .", + "summary": "Gets or sets a value indicating whether this variation axis is hidden from user interfaces." + }, + "signature": "public bool IsHidden { get; set; }", + "memberName": "IsHidden", + "docId": "P:SkiaSharp.SKFontVariationAxis.IsHidden", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The maximum design-space value allowed for this variation axis.", + "summary": "Gets or sets the maximum value for this variation axis." + }, + "signature": "public float Max { get; set; }", + "memberName": "Max", + "docId": "P:SkiaSharp.SKFontVariationAxis.Max", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The minimum design-space value allowed for this variation axis.", + "summary": "Gets or sets the minimum value for this variation axis." + }, + "signature": "public float Min { get; set; }", + "memberName": "Min", + "docId": "P:SkiaSharp.SKFontVariationAxis.Min", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.SKFontVariationAxis left, SkiaSharp.SKFontVariationAxis right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontVariationAxis.op_Equality(SkiaSharp.SKFontVariationAxis,SkiaSharp.SKFontVariationAxis)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.SKFontVariationAxis left, SkiaSharp.SKFontVariationAxis right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontVariationAxis.op_Inequality(SkiaSharp.SKFontVariationAxis,SkiaSharp.SKFontVariationAxis)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The four-byte tag that uniquely identifies this variation axis (for example, wght for weight or wdth for width).", + "summary": "Gets or sets the four-byte tag that identifies this variation axis." + }, + "signature": "public SkiaSharp.SKFourByteTag Tag { get; set; }", + "memberName": "Tag", + "docId": "P:SkiaSharp.SKFontVariationAxis.Tag", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml", + "typeName": "SkiaSharp.SKFontVariationAxis" +} diff --git a/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json b/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json new file mode 100644 index 00000000..0684c608 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json @@ -0,0 +1,106 @@ +{ + "entries": [ + { + "fields": { + "remarks": " to position a typeface clone along one or more axes.\n\nThis struct is a value type and does not require disposal.\n\n## Examples\n\n```csharp\nvar coords = new SKFontVariationPositionCoordinate[]\n{\n new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse(\"wght\"), Value = 700 },\n new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse(\"ital\"), Value = 1 },\n};\nvar args = new SKFontArguments { VariationDesignPosition = coords };\nusing var face = typeface.Clone(args);\n```\n]]>", + "remarksRequired": true, + "summary": "Specifies a design-space coordinate for a single variation axis in a variable font." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "value": "The four-byte tag identifying the variation axis.", + "summary": "Gets or sets the tag of the variation axis this coordinate applies to." + }, + "signature": "public SkiaSharp.SKFourByteTag Axis { get; set; }", + "memberName": "Axis", + "docId": "P:SkiaSharp.SKFontVariationPositionCoordinate.Axis", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": " if the two instances are equal; otherwise, .", + "params": { + "obj": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public readonly bool Equals (SkiaSharp.SKFontVariationPositionCoordinate obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.Equals(SkiaSharp.SKFontVariationPositionCoordinate)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override readonly bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override readonly int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.SKFontVariationPositionCoordinate left, SkiaSharp.SKFontVariationPositionCoordinate right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.op_Equality(SkiaSharp.SKFontVariationPositionCoordinate,SkiaSharp.SKFontVariationPositionCoordinate)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.SKFontVariationPositionCoordinate left, SkiaSharp.SKFontVariationPositionCoordinate right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFontVariationPositionCoordinate.op_Inequality(SkiaSharp.SKFontVariationPositionCoordinate,SkiaSharp.SKFontVariationPositionCoordinate)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "The design-space value for the axis identified by .", + "summary": "Gets or sets the design-space value for the variation axis." + }, + "signature": "public float Value { get; set; }", + "memberName": "Value", + "docId": "P:SkiaSharp.SKFontVariationPositionCoordinate.Value", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml", + "typeName": "SkiaSharp.SKFontVariationPositionCoordinate" +} diff --git a/output/docs-work/SkiaSharp__SKFourByteTag.json b/output/docs-work/SkiaSharp__SKFourByteTag.json new file mode 100644 index 00000000..6f16f82f --- /dev/null +++ b/output/docs-work/SkiaSharp__SKFourByteTag.json @@ -0,0 +1,166 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "remarksRequired": true, + "summary": "Represents a four-byte tag (FourCC) used to identify OpenType font tables, variation axes, and other resources." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "params": { + "value": "The raw 32-bit unsigned integer value of the tag." + }, + "summary": "Initializes a new instance of the struct from a raw 32-bit value." + }, + "signature": "public SKFourByteTag (uint value);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKFourByteTag.#ctor(System.UInt32)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "params": { + "c1": "The first character (most-significant byte).", + "c2": "The second character.", + "c3": "The third character.", + "c4": "The fourth character (least-significant byte)." + }, + "summary": "Initializes a new instance of the struct from four characters." + }, + "signature": "public SKFourByteTag (char c1, char c2, char c3, char c4);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKFourByteTag.#ctor(System.Char,System.Char,System.Char,System.Char)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "returns": " if the two tags are equal; otherwise, .", + "params": { + "other": "The to compare with the current instance." + }, + "summary": "Determines whether the specified is equal to the current instance." + }, + "signature": "public bool Equals (SkiaSharp.SKFourByteTag other);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFourByteTag.Equals(SkiaSharp.SKFourByteTag)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the specified object is a equal to the current instance; otherwise, .", + "params": { + "obj": "The object to compare with the current instance." + }, + "summary": "Determines whether the specified object is equal to the current instance." + }, + "signature": "public override bool Equals (object obj);", + "memberName": "Equals", + "docId": "M:SkiaSharp.SKFourByteTag.Equals(System.Object)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A hash code for the current instance.", + "summary": "Returns a hash code for the current instance." + }, + "signature": "public override int GetHashCode ();", + "memberName": "GetHashCode", + "docId": "M:SkiaSharp.SKFourByteTag.GetHashCode", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if equals ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are equal." + }, + "signature": "public static bool operator == (SkiaSharp.SKFourByteTag left, SkiaSharp.SKFourByteTag right);", + "memberName": "op_Equality", + "docId": "M:SkiaSharp.SKFourByteTag.op_Equality(SkiaSharp.SKFourByteTag,SkiaSharp.SKFourByteTag)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The tag's packed 32-bit unsigned integer value.", + "params": { + "tag": "The to convert." + }, + "summary": "Implicitly converts a to a 32-bit unsigned integer." + }, + "signature": "public static implicit operator uint (SkiaSharp.SKFourByteTag tag);", + "memberName": "op_Implicit", + "docId": "M:SkiaSharp.SKFourByteTag.op_Implicit(SkiaSharp.SKFourByteTag)~System.UInt32", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An with the given raw value.", + "params": { + "tag": "The raw 32-bit unsigned integer to convert." + }, + "summary": "Implicitly converts a 32-bit unsigned integer to a ." + }, + "signature": "public static implicit operator SkiaSharp.SKFourByteTag (uint tag);", + "memberName": "op_Implicit", + "docId": "M:SkiaSharp.SKFourByteTag.op_Implicit(System.UInt32)~SkiaSharp.SKFourByteTag", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if does not equal ; otherwise, .", + "params": { + "left": "The left operand.", + "right": "The right operand." + }, + "summary": "Determines whether two instances are not equal." + }, + "signature": "public static bool operator != (SkiaSharp.SKFourByteTag left, SkiaSharp.SKFourByteTag right);", + "memberName": "op_Inequality", + "docId": "M:SkiaSharp.SKFourByteTag.op_Inequality(SkiaSharp.SKFourByteTag,SkiaSharp.SKFourByteTag)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An parsed from the string. If is or empty, returns a tag with the value zero. Strings shorter than four characters are padded with spaces; longer strings are truncated.", + "params": { + "tag": "The string to parse. Only the first four characters are used; shorter strings are padded with spaces." + }, + "summary": "Parses a string into a ." + }, + "signature": "public static SkiaSharp.SKFourByteTag Parse (string? tag);", + "memberName": "Parse", + "docId": "M:SkiaSharp.SKFourByteTag.Parse(System.String)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A four-character string representation of the tag.", + "summary": "Returns the four-character string representation of this tag." + }, + "signature": "public override string ToString ();", + "memberName": "ToString", + "docId": "M:SkiaSharp.SKFourByteTag.ToString", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml", + "typeName": "SkiaSharp.SKFourByteTag" +} diff --git a/output/docs-work/SkiaSharp__SKPaint.json b/output/docs-work/SkiaSharp__SKPaint.json new file mode 100644 index 00000000..f8ebbbda --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPaint.json @@ -0,0 +1,103 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry.", + "matrix": "The transformation matrix to apply when computing the fill path." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings and the specified transformation matrix, and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKMatrix matrix);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKMatrix)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry.", + "cullRect": "The rectangle used to cull portions of the path that fall outside its bounds." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings, culled to the specified rectangle, and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry.", + "resScale": "The resolution scale factor used to determine the precision of curves in the fill path." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings at the specified resolution scale, and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, float resScale);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry.", + "cullRect": "The rectangle used to cull portions of the path that fall outside its bounds.", + "matrix": "The transformation matrix to apply when computing the fill path." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings, applying the specified cull rectangle and transformation matrix, and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect, SkiaSharp.SKMatrix matrix);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect,SkiaSharp.SKMatrix)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if the fill path was successfully computed; otherwise, .", + "params": { + "src": "The source path to fill.", + "dst": "The that receives the filled path geometry.", + "cullRect": "The rectangle used to cull portions of the path that fall outside its bounds.", + "resScale": "The resolution scale factor used to determine the precision of curves in the fill path." + }, + "summary": "Computes the filled geometry of the source path using the current paint settings, applying the specified cull rectangle and resolution scale, and writes the result into the destination builder." + }, + "signature": "public bool GetFillPath (SkiaSharp.SKPath src, SkiaSharp.SKPathBuilder dst, SkiaSharp.SKRect cullRect, float resScale);", + "memberName": "GetFillPath", + "docId": "M:SkiaSharp.SKPaint.GetFillPath(SkiaSharp.SKPath,SkiaSharp.SKPathBuilder,SkiaSharp.SKRect,System.Single)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKPaint.xml", + "typeName": "SkiaSharp.SKPaint" +} diff --git a/output/docs-work/SkiaSharp__SKPath.json b/output/docs-work/SkiaSharp__SKPath.json new file mode 100644 index 00000000..5a42d01e --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPath.json @@ -0,0 +1,61 @@ +{ + "entries": [ + { + "fields": { + "params": { + "other": "The path containing the elements to be added to the current path." + } + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "params": { + "other": "The path containing the elements to be added to the current path." + } + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, ref SkiaSharp.SKMatrix matrix, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,SkiaSharp.SKMatrix@,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "params": { + "other": "The path containing the elements to be added to the current path." + } + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, float dx, float dy, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPath.AddPath(SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "params": { + "other": "The path containing the elements to be added to the current path." + } + }, + "signature": "public void AddPathReverse (SkiaSharp.SKPath other);", + "memberName": "AddPathReverse", + "docId": "M:SkiaSharp.SKPath.AddPathReverse(SkiaSharp.SKPath)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "A pointer to the underlying native Skia path object.", + "summary": "Gets or sets the handle to the underlying native object." + }, + "signature": "public override IntPtr Handle { get; protected set; }", + "memberName": "Handle", + "docId": "P:SkiaSharp.SKPath.Handle", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKPath.xml", + "typeName": "SkiaSharp.SKPath" +} diff --git a/output/docs-work/SkiaSharp__SKPathBuilder.json b/output/docs-work/SkiaSharp__SKPathBuilder.json new file mode 100644 index 00000000..40650b65 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPathBuilder.json @@ -0,0 +1,737 @@ +{ + "entries": [ + { + "fields": { + "remarks": " incrementally. Add contours, arcs, curves, and shapes, then call to obtain an immutable snapshot or to transfer ownership of the path.\n\nThis 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.\n\n## Examples\n\n```csharp\nusing var builder = new SKPathBuilder();\nbuilder.MoveTo(10, 10);\nbuilder.LineTo(100, 10);\nbuilder.LineTo(100, 100);\nbuilder.Close();\nusing var path = builder.Detach();\ncanvas.DrawPath(path, paint);\n```\n]]>", + "remarksRequired": true, + "summary": "Provides a mutable builder for constructing an incrementally." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "summary": "Initializes a new instance of the class." + }, + "signature": "public SKPathBuilder ();", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKPathBuilder.#ctor", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "params": { + "path": "The path whose contours are copied into the new builder." + }, + "summary": "Initializes a new instance of the class with the contents of an existing path." + }, + "signature": "public SKPathBuilder (SkiaSharp.SKPath path);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKPathBuilder.#ctor(SkiaSharp.SKPath)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "params": { + "sweepAngle": "The sweep angle in degrees, measured clockwise from .", + "oval": "The bounding rectangle of the oval that defines the arc.", + "startAngle": "The start angle in degrees, measured clockwise from the positive x-axis." + }, + "summary": "Appends an arc of the specified oval to the path as a new contour." + }, + "signature": "public void AddArc (SkiaSharp.SKRect oval, float startAngle, float sweepAngle);", + "memberName": "AddArc", + "docId": "M:SkiaSharp.SKPathBuilder.AddArc(SkiaSharp.SKRect,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x": "The x-coordinate of the center of the circle.", + "y": "The y-coordinate of the center of the circle.", + "radius": "The radius of the circle.", + "dir": "One of the enumeration values that specifies the winding direction of the circle contour." + }, + "summary": "Appends a closed circle contour to the path." + }, + "signature": "public void AddCircle (float x, float y, float radius, SkiaSharp.SKPathDirection dir = SkiaSharp.SKPathDirection.Clockwise);", + "memberName": "AddCircle", + "docId": "M:SkiaSharp.SKPathBuilder.AddCircle(System.Single,System.Single,System.Single,SkiaSharp.SKPathDirection)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The bounding rectangle of the oval.", + "direction": "One of the enumeration values that specifies the winding direction of the oval contour." + }, + "summary": "Appends a closed oval contour to the path." + }, + "signature": "public void AddOval (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "memberName": "AddOval", + "docId": "M:SkiaSharp.SKPathBuilder.AddOval(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "other": "The path whose contours are appended to the current path.", + "mode": "One of the enumeration values that specifies how the path is appended." + }, + "summary": "Appends the contours of another path to the current path." + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "mode": "One of the enumeration values that specifies how the path is appended.", + "matrix": "The transformation matrix applied to each point in the source path before appending.", + "other": "The path whose contours are appended to the current path." + }, + "summary": "Appends the contours of another path, transformed by the specified matrix, to the current path." + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, in SkiaSharp.SKMatrix matrix, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,SkiaSharp.SKMatrix@,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx": "The horizontal offset applied to each point in the source path before appending.", + "dy": "The vertical offset applied to each point in the source path before appending.", + "mode": "One of the enumeration values that specifies how the path is appended.", + "other": "The path whose contours are appended to the current path." + }, + "summary": "Appends the contours of another path, translated by the specified offset, to the current path." + }, + "signature": "public void AddPath (SkiaSharp.SKPath other, float dx, float dy, SkiaSharp.SKPathAddMode mode = SkiaSharp.SKPathAddMode.Append);", + "memberName": "AddPath", + "docId": "M:SkiaSharp.SKPathBuilder.AddPath(SkiaSharp.SKPath,System.Single,System.Single,SkiaSharp.SKPathAddMode)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "points": "The array of vertices that form the polygon.", + "close": " to close the polygon by adding a line back to the first point; otherwise, ." + }, + "summary": "Appends a polygon contour defined by the specified points to the path." + }, + "signature": "public void AddPoly (SkiaSharp.SKPoint[] points, bool close = true);", + "memberName": "AddPoly", + "docId": "M:SkiaSharp.SKPathBuilder.AddPoly(SkiaSharp.SKPoint[],System.Boolean)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "points": "The read-only span of vertices that form the polygon.", + "close": " to close the polygon by adding a line back to the first point; otherwise, ." + }, + "summary": "Appends a polygon contour defined by the specified points to the path." + }, + "signature": "public void AddPoly (ReadOnlySpan points, bool close = true);", + "memberName": "AddPoly", + "docId": "M:SkiaSharp.SKPathBuilder.AddPoly(System.ReadOnlySpan{SkiaSharp.SKPoint},System.Boolean)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The rectangle to add as a closed contour.", + "direction": "One of the enumeration values that specifies the winding direction of the rectangle contour." + }, + "summary": "Appends a closed rectangle contour to the path." + }, + "signature": "public void AddRect (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "memberName": "AddRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The rectangle to add as a closed contour.", + "direction": "One of the enumeration values that specifies the winding direction of the rectangle contour.", + "startIndex": "The zero-based corner index (0 through 3) at which the contour begins." + }, + "summary": "Appends a closed rectangle contour to the path, starting at the specified corner." + }, + "signature": "public void AddRect (SkiaSharp.SKRect rect, SkiaSharp.SKPathDirection direction, uint startIndex);", + "memberName": "AddRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRect(SkiaSharp.SKRect,SkiaSharp.SKPathDirection,System.UInt32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The rounded rectangle to add as a closed contour.", + "direction": "One of the enumeration values that specifies the winding direction of the contour." + }, + "summary": "Appends a closed rounded-rectangle contour to the path." + }, + "signature": "public void AddRoundRect (SkiaSharp.SKRoundRect rect, SkiaSharp.SKPathDirection direction = SkiaSharp.SKPathDirection.Clockwise);", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The rounded rectangle to add as a closed contour.", + "direction": "One of the enumeration values that specifies the winding direction of the contour.", + "startIndex": "The zero-based corner index at which the contour begins." + }, + "summary": "Appends a closed rounded-rectangle contour to the path, starting at the specified corner." + }, + "signature": "public void AddRoundRect (SkiaSharp.SKRoundRect rect, SkiaSharp.SKPathDirection direction, uint startIndex);", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRoundRect,SkiaSharp.SKPathDirection,System.UInt32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rect": "The bounding rectangle of the rounded rectangle.", + "rx": "The x-axis radius of the corner ellipses.", + "ry": "The y-axis radius of the corner ellipses.", + "dir": "One of the enumeration values that specifies the winding direction of the contour." + }, + "summary": "Appends a closed rounded-rectangle contour with uniform corner radii to the path." + }, + "signature": "public void AddRoundRect (SkiaSharp.SKRect rect, float rx, float ry, SkiaSharp.SKPathDirection dir = SkiaSharp.SKPathDirection.Clockwise);", + "memberName": "AddRoundRect", + "docId": "M:SkiaSharp.SKPathBuilder.AddRoundRect(SkiaSharp.SKRect,System.Single,System.Single,SkiaSharp.SKPathDirection)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point1": "The first tangent point.", + "point2": "The second tangent point.", + "radius": "The radius of the tangent arc." + }, + "summary": "Appends a tangent arc between two lines to the current contour." + }, + "signature": "public void ArcTo (SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2, float radius);", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "oval": "The bounding rectangle of the oval that defines the arc.", + "startAngle": "The start angle in degrees, measured clockwise from the positive x-axis.", + "sweepAngle": "The sweep angle in degrees, measured clockwise from .", + "forceMoveTo": " to add a move-to before the arc, starting a new contour; to connect the arc to the current point with a line." + }, + "summary": "Appends an arc of the specified oval to the current contour." + }, + "signature": "public void ArcTo (SkiaSharp.SKRect oval, float startAngle, float sweepAngle, bool forceMoveTo);", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKRect,System.Single,System.Single,System.Boolean)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "r": "The radii of the arc ellipse (x-radius and y-radius).", + "xAxisRotate": "The rotation of the ellipse x-axis relative to the current coordinate system, in degrees.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "sweep": "One of the enumeration values that specifies the winding direction of the arc.", + "xy": "The end point of the arc." + }, + "summary": "Appends an SVG-style elliptical arc to the current contour using the specified radii and end point." + }, + "signature": "public void ArcTo (SkiaSharp.SKPoint r, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, SkiaSharp.SKPoint xy);", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x1": "The x-coordinate of the first tangent point.", + "y1": "The y-coordinate of the first tangent point.", + "x2": "The x-coordinate of the second tangent point.", + "y2": "The y-coordinate of the second tangent point.", + "radius": "The radius of the tangent arc." + }, + "summary": "Appends a tangent arc between two lines to the current contour." + }, + "signature": "public void ArcTo (float x1, float y1, float x2, float y2, float radius);", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rx": "The x-radius of the arc ellipse.", + "ry": "The y-radius of the arc ellipse.", + "xAxisRotate": "The rotation of the ellipse x-axis relative to the current coordinate system, in degrees.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "sweep": "One of the enumeration values that specifies the winding direction of the arc.", + "x": "The x-coordinate of the end point of the arc.", + "y": "The y-coordinate of the end point of the arc." + }, + "summary": "Appends an SVG-style elliptical arc to the current contour using separate radius and end-point coordinates." + }, + "signature": "public void ArcTo (float rx, float ry, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, float x, float y);", + "memberName": "ArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.ArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "summary": "Closes the current contour by adding a line from the current point back to the starting point of the contour." + }, + "signature": "public void Close ();", + "memberName": "Close", + "docId": "M:SkiaSharp.SKPathBuilder.Close", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The control point of the conic curve.", + "point1": "The end point of the conic curve.", + "w": "The weight of the conic, which controls how much the curve is pulled toward the control point." + }, + "summary": "Appends a conic (rational quadratic Bezier) curve to the current contour." + }, + "signature": "public void ConicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, float w);", + "memberName": "ConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.ConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x0": "The x-coordinate of the control point.", + "y0": "The y-coordinate of the control point.", + "x1": "The x-coordinate of the end point.", + "y1": "The y-coordinate of the end point.", + "w": "The weight of the conic, which controls how much the curve is pulled toward the control point." + }, + "summary": "Appends a conic (rational quadratic Bezier) curve to the current contour." + }, + "signature": "public void ConicTo (float x0, float y0, float x1, float y1, float w);", + "memberName": "ConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.ConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The first control point of the cubic Bezier curve.", + "point1": "The second control point of the cubic Bezier curve.", + "point2": "The end point of the cubic Bezier curve." + }, + "summary": "Appends a cubic Bezier curve to the current contour." + }, + "signature": "public void CubicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2);", + "memberName": "CubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.CubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x0": "The x-coordinate of the first control point.", + "y0": "The y-coordinate of the first control point.", + "x1": "The x-coordinate of the second control point.", + "y1": "The y-coordinate of the second control point.", + "x2": "The x-coordinate of the end point.", + "y2": "The y-coordinate of the end point." + }, + "summary": "Appends a cubic Bezier curve to the current contour." + }, + "signature": "public void CubicTo (float x0, float y0, float x1, float y1, float x2, float y2);", + "memberName": "CubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.CubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A new containing the accumulated contours. The builder is reset after this call.", + "summary": "Detaches the accumulated path from the builder, returning it as a new and resetting the builder." + }, + "signature": "public SkiaSharp.SKPath Detach ();", + "memberName": "Detach", + "docId": "M:SkiaSharp.SKPathBuilder.Detach", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "disposing": " to release both managed and unmanaged resources; to release only unmanaged resources." + }, + "summary": "Releases the resources used by the current instance of the class." + }, + "signature": "protected override void Dispose (bool disposing);", + "memberName": "Dispose", + "docId": "M:SkiaSharp.SKPathBuilder.Dispose(System.Boolean)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "summary": "Releases the native resources held by the current instance of the class." + }, + "signature": "protected override void DisposeNative ();", + "memberName": "DisposeNative", + "docId": "M:SkiaSharp.SKPathBuilder.DisposeNative", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "One of the values that determines how the interior of the path is determined when it self-intersects.", + "summary": "Gets or sets the fill type used to determine the interior of the path." + }, + "signature": "public SkiaSharp.SKPathFillType FillType { get; set; }", + "memberName": "FillType", + "docId": "P:SkiaSharp.SKPathBuilder.FillType", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "params": { + "point": "The point to move to." + }, + "summary": "Appends a straight line from the current point to the specified point." + }, + "signature": "public void LineTo (SkiaSharp.SKPoint point);", + "memberName": "LineTo", + "docId": "M:SkiaSharp.SKPathBuilder.LineTo(SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x": "The x-coordinate of the end point.", + "y": "The y-coordinate of the end point." + }, + "summary": "Appends a straight line from the current point to the specified coordinates." + }, + "signature": "public void LineTo (float x, float y);", + "memberName": "LineTo", + "docId": "M:SkiaSharp.SKPathBuilder.LineTo(System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point": "The end point of the line." + }, + "summary": "Begins a new contour at the specified point." + }, + "signature": "public void MoveTo (SkiaSharp.SKPoint point);", + "memberName": "MoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.MoveTo(SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x": "The x-coordinate of the point to move to.", + "y": "The y-coordinate of the point to move to." + }, + "summary": "Begins a new contour at the specified coordinates." + }, + "signature": "public void MoveTo (float x, float y);", + "memberName": "MoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.MoveTo(System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The control point of the quadratic Bezier curve.", + "point1": "The end point of the quadratic Bezier curve." + }, + "summary": "Appends a quadratic Bezier curve to the current contour." + }, + "signature": "public void QuadTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1);", + "memberName": "QuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.QuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x0": "The x-coordinate of the control point.", + "y0": "The y-coordinate of the control point.", + "x1": "The x-coordinate of the end point.", + "y1": "The y-coordinate of the end point." + }, + "summary": "Appends a quadratic Bezier curve to the current contour." + }, + "signature": "public void QuadTo (float x0, float y0, float x1, float y1);", + "memberName": "QuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.QuadTo(System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "r": "The radii of the arc ellipse (x-radius and y-radius), specified relative to the current point.", + "xAxisRotate": "The rotation of the ellipse x-axis relative to the current coordinate system, in degrees.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "sweep": "One of the enumeration values that specifies the winding direction of the arc.", + "xy": "The end point of the arc, specified relative to the current point." + }, + "summary": "Appends a relative SVG-style elliptical arc to the current contour." + }, + "signature": "public void RArcTo (SkiaSharp.SKPoint r, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, SkiaSharp.SKPoint xy);", + "memberName": "RArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.RArcTo(SkiaSharp.SKPoint,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "rx": "The x-radius of the arc ellipse.", + "ry": "The y-radius of the arc ellipse.", + "xAxisRotate": "The rotation of the ellipse x-axis relative to the current coordinate system, in degrees.", + "largeArc": "One of the enumeration values that specifies whether to draw the large or small arc.", + "sweep": "One of the enumeration values that specifies the winding direction of the arc.", + "x": "The x-offset of the end point relative to the current point.", + "y": "The y-offset of the end point relative to the current point." + }, + "summary": "Appends a relative SVG-style elliptical arc to the current contour." + }, + "signature": "public void RArcTo (float rx, float ry, float xAxisRotate, SkiaSharp.SKPathArcSize largeArc, SkiaSharp.SKPathDirection sweep, float x, float y);", + "memberName": "RArcTo", + "docId": "M:SkiaSharp.SKPathBuilder.RArcTo(System.Single,System.Single,System.Single,SkiaSharp.SKPathArcSize,SkiaSharp.SKPathDirection,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The control point of the conic curve, relative to the current point.", + "point1": "The end point of the conic curve, relative to the current point.", + "w": "The weight of the conic." + }, + "summary": "Appends a relative conic (rational quadratic Bezier) curve to the current contour." + }, + "signature": "public void RConicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, float w);", + "memberName": "RConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RConicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx0": "The x-offset of the control point relative to the current point.", + "dy0": "The y-offset of the control point relative to the current point.", + "dx1": "The x-offset of the end point relative to the current point.", + "dy1": "The y-offset of the end point relative to the current point.", + "w": "The weight of the conic." + }, + "summary": "Appends a relative conic (rational quadratic Bezier) curve to the current contour." + }, + "signature": "public void RConicTo (float dx0, float dy0, float dx1, float dy1, float w);", + "memberName": "RConicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RConicTo(System.Single,System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The first control point, relative to the current point.", + "point1": "The second control point, relative to the current point.", + "point2": "The end point, relative to the current point." + }, + "summary": "Appends a relative cubic Bezier curve to the current contour." + }, + "signature": "public void RCubicTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1, SkiaSharp.SKPoint point2);", + "memberName": "RCubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RCubicTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx0": "The x-offset of the first control point relative to the current point.", + "dy0": "The y-offset of the first control point relative to the current point.", + "dx1": "The x-offset of the second control point relative to the current point.", + "dy1": "The y-offset of the second control point relative to the current point.", + "dx2": "The x-offset of the end point relative to the current point.", + "dy2": "The y-offset of the end point relative to the current point." + }, + "summary": "Appends a relative cubic Bezier curve to the current contour." + }, + "signature": "public void RCubicTo (float dx0, float dy0, float dx1, float dy1, float dx2, float dy2);", + "memberName": "RCubicTo", + "docId": "M:SkiaSharp.SKPathBuilder.RCubicTo(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "summary": "Resets the builder, removing all contours and restoring the default fill type." + }, + "signature": "public void Reset ();", + "memberName": "Reset", + "docId": "M:SkiaSharp.SKPathBuilder.Reset", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "other": "The path whose contours are appended in reverse order." + }, + "summary": "Appends the contours of another path to the current path in reverse order." + }, + "signature": "public void ReverseAddPath (SkiaSharp.SKPath other);", + "memberName": "ReverseAddPath", + "docId": "M:SkiaSharp.SKPathBuilder.ReverseAddPath(SkiaSharp.SKPath)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point": "The end point, specified relative to the current point." + }, + "summary": "Appends a straight line from the current point to a point at the specified relative offset." + }, + "signature": "public void RLineTo (SkiaSharp.SKPoint point);", + "memberName": "RLineTo", + "docId": "M:SkiaSharp.SKPathBuilder.RLineTo(SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx": "The x-offset of the end point relative to the current point.", + "dy": "The y-offset of the end point relative to the current point." + }, + "summary": "Appends a straight line from the current point to a point at the specified relative offset." + }, + "signature": "public void RLineTo (float dx, float dy);", + "memberName": "RLineTo", + "docId": "M:SkiaSharp.SKPathBuilder.RLineTo(System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point": "The offset from the current point at which the new contour begins." + }, + "summary": "Begins a new contour at a point offset from the current point." + }, + "signature": "public void RMoveTo (SkiaSharp.SKPoint point);", + "memberName": "RMoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.RMoveTo(SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx": "The x-offset from the current point.", + "dy": "The y-offset from the current point." + }, + "summary": "Begins a new contour at a point offset from the current point." + }, + "signature": "public void RMoveTo (float dx, float dy);", + "memberName": "RMoveTo", + "docId": "M:SkiaSharp.SKPathBuilder.RMoveTo(System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "point0": "The control point, relative to the current point.", + "point1": "The end point, relative to the current point." + }, + "summary": "Appends a relative quadratic Bezier curve to the current contour." + }, + "signature": "public void RQuadTo (SkiaSharp.SKPoint point0, SkiaSharp.SKPoint point1);", + "memberName": "RQuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.RQuadTo(SkiaSharp.SKPoint,SkiaSharp.SKPoint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "dx0": "The x-offset of the control point relative to the current point.", + "dy0": "The y-offset of the control point relative to the current point.", + "dx1": "The x-offset of the end point relative to the current point.", + "dy1": "The y-offset of the end point relative to the current point." + }, + "summary": "Appends a relative quadratic Bezier curve to the current contour." + }, + "signature": "public void RQuadTo (float dx0, float dy0, float dx1, float dy1);", + "memberName": "RQuadTo", + "docId": "M:SkiaSharp.SKPathBuilder.RQuadTo(System.Single,System.Single,System.Single,System.Single)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A new that is an immutable snapshot of the current contours. The builder retains its state and can continue to be used.", + "summary": "Returns an immutable snapshot of the current path without resetting the builder." + }, + "signature": "public SkiaSharp.SKPath Snapshot ();", + "memberName": "Snapshot", + "docId": "M:SkiaSharp.SKPathBuilder.Snapshot", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml", + "typeName": "SkiaSharp.SKPathBuilder" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp__SKPathMeasure.json b/output/docs-work/SkiaSharp__SKPathMeasure.json new file mode 100644 index 00000000..47b38432 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKPathMeasure.json @@ -0,0 +1,23 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": " if the segment was successfully extracted; otherwise, .", + "params": { + "start": "The distance along the path at which the segment begins.", + "dst": "The that receives the extracted path segment.", + "startWithMoveTo": " to begin the segment with a move-to, starting a new contour in the destination builder; to append the segment to the current contour.", + "stop": "The distance along the path at which the segment ends." + }, + "summary": "Extracts a segment of the path between the specified distances and appends it to the destination builder." + }, + "signature": "public bool GetSegment (float start, float stop, SkiaSharp.SKPathBuilder dst, bool startWithMoveTo);", + "memberName": "GetSegment", + "docId": "M:SkiaSharp.SKPathMeasure.GetSegment(System.Single,System.Single,SkiaSharp.SKPathBuilder,System.Boolean)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml", + "typeName": "SkiaSharp.SKPathMeasure" +} diff --git a/output/docs-work/SkiaSharp__SKStream.json b/output/docs-work/SkiaSharp__SKStream.json new file mode 100644 index 00000000..4465ec1e --- /dev/null +++ b/output/docs-work/SkiaSharp__SKStream.json @@ -0,0 +1,17 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "An instance containing the stream's data, or if the data cannot be retrieved.", + "summary": "Returns the stream's data as a new instance." + }, + "signature": "public SkiaSharp.SKData GetData ();", + "memberName": "GetData", + "docId": "M:SkiaSharp.SKStream.GetData", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKStream.xml", + "typeName": "SkiaSharp.SKStream" +} diff --git a/output/docs-work/SkiaSharp__SKSurface.json b/output/docs-work/SkiaSharp__SKSurface.json new file mode 100644 index 00000000..f38fa1de --- /dev/null +++ b/output/docs-work/SkiaSharp__SKSurface.json @@ -0,0 +1,39 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "params": { + "sampling": "The sampling options to use when drawing the surface.", + "paint": "The paint to apply when drawing the surface, or to use the default paint.", + "canvas": "The canvas onto which the surface is drawn.", + "p": "The position at which to draw the top-left corner of the surface." + }, + "summary": "Draws the surface onto the specified canvas at the given point using the specified sampling options." + }, + "signature": "public void Draw (SkiaSharp.SKCanvas canvas, SkiaSharp.SKPoint p, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "memberName": "Draw", + "docId": "M:SkiaSharp.SKSurface.Draw(SkiaSharp.SKCanvas,SkiaSharp.SKPoint,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "params": { + "x": "The x-coordinate of the position at which to draw the top-left corner of the surface.", + "sampling": "The sampling options to use when drawing the surface.", + "paint": "The paint to apply when drawing the surface, or to use the default paint.", + "canvas": "The canvas onto which the surface is drawn.", + "y": "The y-coordinate of the position at which to draw the top-left corner of the surface." + }, + "summary": "Draws the surface onto the specified canvas at the given coordinates using the specified sampling options." + }, + "signature": "public void Draw (SkiaSharp.SKCanvas canvas, float x, float y, SkiaSharp.SKSamplingOptions sampling, SkiaSharp.SKPaint paint = default);", + "memberName": "Draw", + "docId": "M:SkiaSharp.SKSurface.Draw(SkiaSharp.SKCanvas,System.Single,System.Single,SkiaSharp.SKSamplingOptions,SkiaSharp.SKPaint)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKSurface.xml", + "typeName": "SkiaSharp.SKSurface" +} diff --git a/output/docs-work/SkiaSharp__SKTypeface.json b/output/docs-work/SkiaSharp__SKTypeface.json new file mode 100644 index 00000000..b7acec7c --- /dev/null +++ b/output/docs-work/SkiaSharp__SKTypeface.json @@ -0,0 +1,142 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "returns": "A new instance configured according to the specified arguments.", + "params": { + "args": "The specifying the variation position, collection index, palette index, and palette overrides for the clone." + }, + "summary": "Creates a new typeface by cloning the current typeface with the specified font arguments." + }, + "signature": "public SkiaSharp.SKTypeface Clone (SkiaSharp.SKFontArguments args);", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(SkiaSharp.SKFontArguments)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A new instance using the specified color palette.", + "params": { + "paletteIndex": "The zero-based index of the color palette to use." + }, + "summary": "Creates a new typeface by cloning the current typeface with the specified color palette index." + }, + "signature": "public SkiaSharp.SKTypeface Clone (int paletteIndex);", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(System.Int32)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "A new instance at the specified variation design position.", + "params": { + "position": "A read-only span of values specifying the desired axis coordinates." + }, + "summary": "Creates a new typeface by cloning the current typeface at the specified variation design position." + }, + "signature": "public SkiaSharp.SKTypeface Clone (ReadOnlySpan position);", + "memberName": "Clone", + "docId": "M:SkiaSharp.SKTypeface.Clone(System.ReadOnlySpan{SkiaSharp.SKFontVariationPositionCoordinate})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": "A shared empty instance with no glyphs.", + "summary": "Gets a shared empty typeface that contains no glyphs." + }, + "signature": "public static SkiaSharp.SKTypeface Empty { get; }", + "memberName": "Empty", + "docId": "P:SkiaSharp.SKTypeface.Empty", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "returns": "The number of variation axis parameter descriptors written into .", + "params": { + "axes": "A span that receives the variation axis parameter descriptors." + }, + "summary": "Fills the provided span with the variation axis parameters for this typeface." + }, + "signature": "public int GetVariationDesignParameters (Span axes);", + "memberName": "GetVariationDesignParameters", + "docId": "M:SkiaSharp.SKTypeface.GetVariationDesignParameters(System.Span{SkiaSharp.SKFontVariationAxis})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "The number of variation coordinates written into .", + "params": { + "coordinates": "A span that receives the current variation design position coordinates." + }, + "summary": "Fills the provided span with the current variation design position of this typeface." + }, + "signature": "public int GetVariationDesignPosition (Span coordinates);", + "memberName": "GetVariationDesignPosition", + "docId": "M:SkiaSharp.SKTypeface.GetVariationDesignPosition(System.Span{SkiaSharp.SKFontVariationPositionCoordinate})", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "value": " if the typeface contains no glyphs; otherwise, .", + "summary": "Gets a value indicating whether the typeface is empty (contains no glyphs)." + }, + "signature": "public bool IsEmpty { get; }", + "memberName": "IsEmpty", + "docId": "P:SkiaSharp.SKTypeface.IsEmpty", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The total number of variation axes defined for this typeface.", + "summary": "Gets the number of variation axis parameters defined for this typeface." + }, + "signature": "public int VariationDesignParameterCount { get; }", + "memberName": "VariationDesignParameterCount", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignParameterCount", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "An array of values describing the available variation axes, or an empty array if no variation data is present.", + "summary": "Gets information about all variation axes defined for this typeface." + }, + "signature": "public SkiaSharp.SKFontVariationAxis[] VariationDesignParameters { get; }", + "memberName": "VariationDesignParameters", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignParameters", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "An array of values representing the current variation design position, or an empty array if no variation data is present.", + "summary": "Gets the current variation design position of this typeface." + }, + "signature": "public SkiaSharp.SKFontVariationPositionCoordinate[] VariationDesignPosition { get; }", + "memberName": "VariationDesignPosition", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignPosition", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The total number of variation coordinates in the current design position.", + "summary": "Gets the number of variation design position coordinates for this typeface." + }, + "signature": "public int VariationDesignPositionCount { get; }", + "memberName": "VariationDesignPositionCount", + "docId": "P:SkiaSharp.SKTypeface.VariationDesignPositionCount", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKTypeface.xml", + "typeName": "SkiaSharp.SKTypeface" +} diff --git a/output/docs-work/SkiaSharp__SKWebpEncoder.json b/output/docs-work/SkiaSharp__SKWebpEncoder.json new file mode 100644 index 00000000..4fe18cae --- /dev/null +++ b/output/docs-work/SkiaSharp__SKWebpEncoder.json @@ -0,0 +1,108 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "summary": "Provides static methods to encode images and animated sequences as WebP." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "returns": "An instance containing the encoded WebP image, or if encoding fails.", + "params": { + "src": "The source pixel data to encode.", + "options": "The encoding options, including quality and compression type." + }, + "summary": "Encodes the specified pixmap as a WebP image and returns the result as an instance." + }, + "signature": "public static SkiaSharp.SKData? Encode (SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if encoding was successful; otherwise, .", + "params": { + "options": "The encoding options, including quality and compression type.", + "src": "The source pixel data to encode.", + "dst": "The destination stream to which the encoded WebP image is written." + }, + "summary": "Encodes the specified pixmap as a WebP image and writes the result to a native stream." + }, + "signature": "public static bool Encode (SkiaSharp.SKWStream dst, SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(SkiaSharp.SKWStream,SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if encoding was successful; otherwise, .", + "params": { + "options": "The encoding options, including quality and compression type.", + "src": "The source pixel data to encode.", + "dst": "The destination stream to which the encoded WebP image is written." + }, + "summary": "Encodes the specified pixmap as a WebP image and writes the result to a managed stream." + }, + "signature": "public static bool Encode (System.IO.Stream dst, SkiaSharp.SKPixmap src, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "Encode", + "docId": "M:SkiaSharp.SKWebpEncoder.Encode(System.IO.Stream,SkiaSharp.SKPixmap,SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": "An instance containing the encoded animated WebP image, or if encoding fails.", + "params": { + "frames": "The sequence of frames to include in the animated WebP image.", + "options": "The encoding options, including quality and compression type." + }, + "summary": "Encodes the specified frames as an animated WebP image and returns the result as an instance." + }, + "signature": "public static SkiaSharp.SKData? EncodeAnimated (ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if encoding was successful; otherwise, .", + "params": { + "options": "The encoding options, including quality and compression type.", + "dst": "The destination native stream to which the encoded animated WebP image is written.", + "frames": "The sequence of frames to include in the animated WebP image." + }, + "summary": "Encodes the specified frames as an animated WebP image and writes the result to a native stream." + }, + "signature": "public static bool EncodeAnimated (SkiaSharp.SKWStream dst, ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(SkiaSharp.SKWStream,System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + }, + { + "fields": { + "remarks": "", + "returns": " if encoding was successful; otherwise, .", + "params": { + "options": "The encoding options, including quality and compression type.", + "dst": "The destination managed stream to which the encoded animated WebP image is written.", + "frames": "The sequence of frames to include in the animated WebP image." + }, + "summary": "Encodes the specified frames as an animated WebP image and writes the result to a managed stream." + }, + "signature": "public static bool EncodeAnimated (System.IO.Stream dst, ReadOnlySpan frames, SkiaSharp.SKWebpEncoderOptions options);", + "memberName": "EncodeAnimated", + "docId": "M:SkiaSharp.SKWebpEncoder.EncodeAnimated(System.IO.Stream,System.ReadOnlySpan{SkiaSharp.SKWebpEncoderFrame},SkiaSharp.SKWebpEncoderOptions)", + "memberType": "Method" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml", + "typeName": "SkiaSharp.SKWebpEncoder" +} \ No newline at end of file diff --git a/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json b/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json new file mode 100644 index 00000000..0392c618 --- /dev/null +++ b/output/docs-work/SkiaSharp__SKWebpEncoderFrame.json @@ -0,0 +1,78 @@ +{ + "entries": [ + { + "fields": { + "remarks": "", + "summary": "Represents a single frame in an animated WebP image, including the pixel data and display duration." + }, + "docId": null, + "memberType": "type" + }, + { + "fields": { + "remarks": "", + "params": { + "bitmap": "The source bitmap whose pixels will be used for this frame. The bitmap must remain valid for the lifetime of this frame.", + "duration": "The length of time this frame is displayed during animation playback." + }, + "summary": "Initializes a new instance of with the specified bitmap and display duration." + }, + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKBitmap bitmap, TimeSpan duration);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKBitmap,System.TimeSpan)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "params": { + "image": "The source image whose pixels will be used for this frame. The image must be raster-backed and remain valid for the lifetime of this frame.", + "duration": "The length of time this frame is displayed during animation playback." + }, + "summary": "Initializes a new instance of with the specified image and display duration." + }, + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKImage image, TimeSpan duration);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKImage,System.TimeSpan)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "params": { + "pixmap": "The source pixmap containing the pixel data for this frame.", + "duration": "The length of time this frame is displayed during animation playback." + }, + "summary": "Initializes a new instance of with the specified pixmap and display duration." + }, + "signature": "public SKWebpEncoderFrame (SkiaSharp.SKPixmap pixmap, TimeSpan duration);", + "memberName": ".ctor", + "docId": "M:SkiaSharp.SKWebpEncoderFrame.#ctor(SkiaSharp.SKPixmap,System.TimeSpan)", + "memberType": "Constructor" + }, + { + "fields": { + "remarks": "", + "value": "The amount of time this frame is displayed during animation playback.", + "summary": "Gets or sets the display duration of this frame." + }, + "signature": "public TimeSpan Duration { get; set; }", + "memberName": "Duration", + "docId": "P:SkiaSharp.SKWebpEncoderFrame.Duration", + "memberType": "Property" + }, + { + "fields": { + "remarks": "", + "value": "The containing the pixel data for this frame.", + "summary": "Gets or sets the pixel data for this frame." + }, + "signature": "public SkiaSharp.SKPixmap Pixmap { get; set; }", + "memberName": "Pixmap", + "docId": "P:SkiaSharp.SKWebpEncoderFrame.Pixmap", + "memberType": "Property" + } + ], + "file": "/home/runner/work/SkiaSharp-API-docs/SkiaSharp-API-docs/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml", + "typeName": "SkiaSharp.SKWebpEncoderFrame" +} \ No newline at end of file diff --git a/output/docs-work/manifest.json b/output/docs-work/manifest.json new file mode 100644 index 00000000..3af7bc1d --- /dev/null +++ b/output/docs-work/manifest.json @@ -0,0 +1,164 @@ +[ + { + "entryCount": 21, + "fieldCount": 75, + "file": "HarfBuzzSharp__Face.json", + "typeName": "HarfBuzzSharp.Face" + }, + { + "entryCount": 6, + "fieldCount": 19, + "file": "HarfBuzzSharp__Font.json", + "typeName": "HarfBuzzSharp.Font" + }, + { + "entryCount": 10, + "fieldCount": 34, + "file": "SkiaSharp__GRVkYcbcrComponents.json", + "typeName": "SkiaSharp.GRVkYcbcrComponents" + }, + { + "entryCount": 3, + "fieldCount": 9, + "file": "SkiaSharp__GrVkYcbcrConversionInfo.json", + "typeName": "SkiaSharp.GrVkYcbcrConversionInfo" + }, + { + "entryCount": 2, + "fieldCount": 6, + "file": "SkiaSharp__SKCanvas.json", + "typeName": "SkiaSharp.SKCanvas" + }, + { + "entryCount": 1, + "fieldCount": 4, + "file": "SkiaSharp__SKColorSpace.json", + "typeName": "SkiaSharp.SKColorSpace" + }, + { + "entryCount": 13, + "fieldCount": 15, + "file": "SkiaSharp__SKColorspacePrimariesCicp.json", + "typeName": "SkiaSharp.SKColorspacePrimariesCicp" + }, + { + "entryCount": 15, + "fieldCount": 17, + "file": "SkiaSharp__SKColorspaceTransferFnCicp.json", + "typeName": "SkiaSharp.SKColorspaceTransferFnCicp" + }, + { + "entryCount": 3, + "fieldCount": 3, + "file": "SkiaSharp__SKColorType.json", + "typeName": "SkiaSharp.SKColorType" + }, + { + "entryCount": 8, + "fieldCount": 28, + "file": "SkiaSharp__SKDocumentXpsOptions.json", + "typeName": "SkiaSharp.SKDocumentXpsOptions" + }, + { + "entryCount": 5, + "fieldCount": 15, + "file": "SkiaSharp__SKFontArguments.json", + "typeName": "SkiaSharp.SKFontArguments" + }, + { + "entryCount": 8, + "fieldCount": 28, + "file": "SkiaSharp__SKFontPaletteOverride.json", + "typeName": "SkiaSharp.SKFontPaletteOverride" + }, + { + "entryCount": 11, + "fieldCount": 37, + "file": "SkiaSharp__SKFontVariationAxis.json", + "typeName": "SkiaSharp.SKFontVariationAxis" + }, + { + "entryCount": 8, + "fieldCount": 28, + "file": "SkiaSharp__SKFontVariationPositionCoordinate.json", + "typeName": "SkiaSharp.SKFontVariationPositionCoordinate" + }, + { + "entryCount": 12, + "fieldCount": 43, + "file": "SkiaSharp__SKFourByteTag.json", + "typeName": "SkiaSharp.SKFourByteTag" + }, + { + "entryCount": 6, + "fieldCount": 24, + "file": "SkiaSharp__SKPaint.json", + "typeName": "SkiaSharp.SKPaint" + }, + { + "entryCount": 5, + "fieldCount": 7, + "file": "SkiaSharp__SKPath.json", + "typeName": "SkiaSharp.SKPath" + }, + { + "entryCount": 51, + "fieldCount": 149, + "file": "SkiaSharp__SKPathBuilder.json", + "typeName": "SkiaSharp.SKPathBuilder" + }, + { + "entryCount": 1, + "fieldCount": 4, + "file": "SkiaSharp__SKPathMeasure.json", + "typeName": "SkiaSharp.SKPathMeasure" + }, + { + "entryCount": 1, + "fieldCount": 3, + "file": "SkiaSharp__SKStream.json", + "typeName": "SkiaSharp.SKStream" + }, + { + "entryCount": 2, + "fieldCount": 6, + "file": "SkiaSharp__SKSurface.json", + "typeName": "SkiaSharp.SKSurface" + }, + { + "entryCount": 11, + "fieldCount": 38, + "file": "SkiaSharp__SKTypeface.json", + "typeName": "SkiaSharp.SKTypeface" + }, + { + "entryCount": 7, + "fieldCount": 27, + "file": "SkiaSharp__SKWebpEncoder.json", + "typeName": "SkiaSharp.SKWebpEncoder" + }, + { + "entryCount": 6, + "fieldCount": 18, + "file": "SkiaSharp__SKWebpEncoderFrame.json", + "typeName": "SkiaSharp.SKWebpEncoderFrame" + }, + { + "entryCount": 1, + "fieldCount": 2, + "file": "SkiaSharp.Views.Blazor___Imports.json", + "typeName": "SkiaSharp.Views.Blazor._Imports" + }, + { + "entryCount": 13, + "fieldCount": 52, + "file": "SkiaSharp.Views.Gtk__GTKExtensions.json", + "typeName": "SkiaSharp.Views.Gtk.GTKExtensions" + }, + { + "entryCount": 1, + "fieldCount": 2, + "file": "SkiaSharp.Views.Gtk__SKDrawingArea.json", + "typeName": "SkiaSharp.Views.Gtk.SKDrawingArea" + } +] From 5fc5d790f072b462db887bdf4496807d18fcd7ac Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 20 May 2026 21:57:40 +0000 Subject: [PATCH 2/2] Fill API documentation placeholders Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- SkiaSharpAPI/HarfBuzzSharp/Face.xml | 156 +++--- SkiaSharpAPI/HarfBuzzSharp/Font.xml | 38 +- .../SkiaSharp.Views.Blazor/_Imports.xml | 4 +- .../SkiaSharp.Views.Gtk/GTKExtensions.xml | 130 ++--- .../SkiaSharp.Views.Gtk/SKDrawingArea.xml | 4 +- .../SkiaSharp/GRVkYcbcrComponents.xml | 88 ++-- .../SkiaSharp/GrVkYcbcrConversionInfo.xml | 18 +- SkiaSharpAPI/SkiaSharp/SKCanvas.xml | 68 +-- SkiaSharpAPI/SkiaSharp/SKColorSpace.xml | 10 +- SkiaSharpAPI/SkiaSharp/SKColorType.xml | 6 +- .../SkiaSharp/SKColorspacePrimariesCicp.xml | 42 +- .../SkiaSharp/SKColorspaceTransferFnCicp.xml | 46 +- .../SkiaSharp/SKDocumentXpsOptions.xml | 76 ++- SkiaSharpAPI/SkiaSharp/SKFontArguments.xml | 48 +- .../SkiaSharp/SKFontPaletteOverride.xml | 75 ++- .../SkiaSharp/SKFontVariationAxis.xml | 92 ++-- .../SKFontVariationPositionCoordinate.xml | 76 ++- SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | 110 ++-- SkiaSharpAPI/SkiaSharp/SKMatrix.xml | 16 +- SkiaSharpAPI/SkiaSharp/SKPaint.xml | 74 +-- SkiaSharpAPI/SkiaSharp/SKPath.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml | 494 +++++++++--------- SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml | 14 +- SkiaSharpAPI/SkiaSharp/SKStream.xml | 6 +- SkiaSharpAPI/SkiaSharp/SKSurface.xml | 26 +- SkiaSharpAPI/SkiaSharp/SKTypeface.xml | 76 +-- SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml | 87 +-- SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml | 56 +- SkiaSharpAPI/index.xml | 196 +++---- 29 files changed, 1169 insertions(+), 969 deletions(-) diff --git a/SkiaSharpAPI/HarfBuzzSharp/Face.xml b/SkiaSharpAPI/HarfBuzzSharp/Face.xml index d97f97eb..beebd616 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Face.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Face.xml @@ -167,10 +167,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns all design coordinate values for the specified named instance. + An array of design coordinate values for the specified named instance. + @@ -190,11 +190,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + A span that receives the design coordinate values. + Fills the provided span with design coordinate values for the specified named instance. + The number of design coordinates written into . + @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the number of design coordinates for the specified named instance. + The number of design coordinates associated with the specified named instance. + @@ -235,10 +235,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name ID of the PostScript name for the specified named instance. + The name ID of the PostScript name for the specified named instance. + @@ -257,10 +257,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the named instance. + Returns the OpenType name ID of the subfamily name for the specified named instance. + The name ID of the subfamily name for the specified named instance. + @@ -279,10 +279,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color entry. + Returns the OpenType name ID for the specified color entry in the font's color palette. + The OpenType name ID for the color at the specified index. + @@ -301,10 +301,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns all colors in the specified color palette. + An array of colors in the specified palette, encoded as hb_color_t values (BGRA byte order: blue in the high byte, alpha in the low byte). + @@ -324,11 +324,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + A span that receives the palette colors, encoded as hb_color_t values (BGRA byte order: blue in the high byte, alpha in the low byte). + Fills the provided span with colors from the specified color palette. + The number of colors written into . + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns the flags associated with the specified color palette. + A bitwise combination of values describing the palette. + @@ -369,10 +369,10 @@ - To be added. - To be added. - To be added. - To be added. + The zero-based index of the color palette. + Returns the OpenType name ID for the specified color palette. + The OpenType name ID for the specified palette. + @@ -391,10 +391,10 @@ - To be added. - To be added. - To be added. - To be added. + A span that receives the variation axis information. + Fills the provided span with information about the font's variation axes. + The number of axis info entries written into . + @@ -428,9 +428,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains color layer data (COLR table). + if the font contains a COLR table with layered glyph color data; otherwise, . + @@ -446,9 +446,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains PNG color glyph data. + if the font contains PNG color glyph data; otherwise, . + @@ -464,9 +464,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains SVG color glyph data. + if the font contains SVG color glyph data; otherwise, . + @@ -482,9 +482,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains color palettes (CPAL table). + if the font contains a CPAL table with color palettes; otherwise, . + @@ -500,9 +500,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the font contains OpenType variation data. + if the font contains OpenType variable font 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 instances defined in the font's variation data. + @@ -591,9 +591,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of color palettes available in the font. + The total number of color palettes defined in the font's CPAL table. + @@ -653,11 +653,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The four-byte tag identifying the variation axis to search for. + When this method returns, contains information about the located axis if found. This parameter is treated as uninitialized. + Attempts to find a variation axis by its tag. + if a variation axis with the specified tag was found; otherwise, . + @@ -691,9 +691,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the number of variation axes defined in the font. + The total number of variation axes defined in the font. + @@ -709,9 +709,9 @@ HarfBuzzSharp.OpenTypeVarAxisInfo[] - To be added. - To be added. - To be added. + Gets information about all variation axes defined in the font. + An array containing information about each variation axis, or an empty array if the font has no variation data. + diff --git a/SkiaSharpAPI/HarfBuzzSharp/Font.xml b/SkiaSharpAPI/HarfBuzzSharp/Font.xml index b9693d38..65c4fccc 100644 --- a/SkiaSharpAPI/HarfBuzzSharp/Font.xml +++ b/SkiaSharpAPI/HarfBuzzSharp/Font.xml @@ -321,10 +321,10 @@ - To be added. - To be added. - To be added. - To be added. + A span that receives the normalized variation coordinates. + Fills the provided span with the current normalized variation coordinates of the font. + The number of normalized coordinates written into . + @@ -579,9 +579,9 @@ - To be added. - To be added. - To be added. + A read-only span of design-space coordinate values, one per variation axis. + Sets the font's variation coordinates using design-space values. + @@ -600,9 +600,9 @@ - To be added. - To be added. - To be added. + A read-only span of normalized variation coordinate values (typically in the range -16384 to 16384), one per variation axis. + Sets the font's variation coordinates using pre-normalized values. + @@ -621,9 +621,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the named instance to apply. + Sets the font's variation coordinates to match the specified named instance. + @@ -642,9 +642,9 @@ - To be added. - To be added. - To be added. + A read-only span of values specifying the axis tags and their desired design-space values. + Sets the font's variation axes to the specified design-space values. + @@ -1250,9 +1250,9 @@ System.Int32[] - To be added. - To be added. - To be added. + Gets the current normalized variation coordinates of the font. + An array of normalized variation coordinates, one per axis, or an empty array if no variation coordinates are set. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml index 719b610c..98cf2e75 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml @@ -73,8 +73,8 @@ - To be added. - To be added. + This member supports the SkiaSharp infrastructure and is not intended to be used directly from your code. + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml index f6a6007e..37abb5b2 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml @@ -70,13 +70,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -90,13 +90,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -110,13 +110,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -130,13 +130,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -150,13 +150,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -170,13 +170,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -190,13 +190,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts an to a . + A equivalent to the specified . + @@ -491,13 +491,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + @@ -511,13 +511,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + @@ -594,13 +594,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + @@ -614,13 +614,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + @@ -665,13 +665,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + @@ -720,13 +720,13 @@ - + - To be added. - To be added. - To be added. - To be added. + The to convert. + Converts a to an . + An equivalent to the specified . + diff --git a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml index e23eec26..b2ebbf17 100644 --- a/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml +++ b/SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml @@ -89,8 +89,8 @@ - To be added. - To be added. + Releases the resources used by the current instance of the class. + diff --git a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml index c216be8c..9b1b32d9 100644 --- a/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml +++ b/SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml @@ -15,8 +15,26 @@ - To be added. - To be added. + Describes the component swizzle mapping for each channel used in a Vulkan YCbCr color conversion. + @@ -37,9 +55,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle value for the alpha (A) component. + The Vulkan component swizzle value for the alpha channel. + @@ -60,9 +78,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle value for the blue (B) component. + The Vulkan component swizzle value for the blue channel. + @@ -89,10 +107,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 the two instances are equal; otherwise, . + @@ -116,10 +134,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 the specified object is a equal to the current instance; otherwise, . + @@ -140,9 +158,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle value for the green (G) component. + The Vulkan component swizzle value for the green channel. + @@ -164,9 +182,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -186,11 +204,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -210,11 +228,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + @@ -235,9 +253,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the swizzle value for the red (R) component. + The Vulkan component swizzle value for the red channel. + diff --git a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml index 0828f037..b25822f5 100644 --- a/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml +++ b/SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml @@ -68,9 +68,9 @@ SkiaSharp.GRVkYcbcrComponents - To be added. - To be added. - To be added. + Gets or sets the component swizzle mapping used by this YCbCr conversion. + The describing the Vulkan component swizzle mapping for this conversion. + @@ -351,9 +351,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether the sampler filter must match the chroma filter. + if the sampler filter must match the chroma filter; otherwise, . + @@ -374,9 +374,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether linear filtering is supported for this YCbCr conversion. + if linear filtering is supported for this YCbCr conversion; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml index 936510d8..77b05f6b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKCanvas.xml +++ b/SkiaSharpAPI/SkiaSharp/SKCanvas.xml @@ -3000,12 +3000,12 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The position at which to draw the surface. + The sampling options to use when drawing the surface. + The paint to use when drawing the surface, or to use the default paint. + Draws the surface onto the canvas at the specified point using the given sampling options. + @@ -3059,13 +3059,13 @@ contours intersect each other (think ). - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The surface to draw. + The x-coordinate of the position at which to draw the surface. + The y-coordinate of the position at which to draw the surface. + The sampling options to use when drawing the surface. + The paint to use when drawing the surface, or to use the default paint. + Draws the surface onto the canvas at the specified coordinates using the given sampling options. + @@ -4851,52 +4851,52 @@ guaranteed to happen. If exact clipping is desired, use - - - + + + Method SkiaSharp - 3.116.0.0 - 3.119.0.0 - 4.147.0.0 + 2.80.0.0 + 2.88.0.0 System.Void - - - - [System.Runtime.CompilerServices.IsReadOnly] - - - + - The matrix to set as the current transformation matrix. + The matrix that will be copied into the current matrix. Replaces the current matrix with a copy of the specified matrix. - - - + + + Method SkiaSharp - 2.80.0.0 - 2.88.0.0 + 3.116.0.0 + 3.119.0.0 + 4.147.0.0 System.Void - + + + + [System.Runtime.CompilerServices.IsReadOnly] + + + - The matrix that will be copied into the current matrix. + The matrix to set as the current transformation matrix. Replaces the current matrix with a copy of the specified matrix. diff --git a/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml b/SkiaSharpAPI/SkiaSharp/SKColorSpace.xml index 9e7e0d87..3b6f64f9 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-defined color primaries. + One of the enumeration values that specifies the CICP-defined transfer function. + Creates a color space from the specified CICP (Coding-Independent Code Points) color primaries and transfer characteristics. + A new representing the color space defined by the specified CICP primaries and transfer characteristics, or if the combination is not supported. + diff --git a/SkiaSharpAPI/SkiaSharp/SKColorType.xml b/SkiaSharpAPI/SkiaSharp/SKColorType.xml index 50e64301..9ddb0923 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorType.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorType.xml @@ -155,7 +155,7 @@ 25 - To be added. + Four 10-bit unsigned integer channels (B, G, R, A) stored in 64 bits (8 bytes per pixel) with extended-range support for wide-gamut HDR content (value 25). @@ -234,7 +234,7 @@ 27 - To be added. + A single 16-bit unsigned normalized integer channel representing red (value 27). Each pixel uses 2 bytes. @@ -519,7 +519,7 @@ 26 - To be added. + Three 16-bit floating-point channels (R, G, B) with a fourth padding channel (x), totaling 8 bytes per pixel. The padding channel is not used for alpha (value 26). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml index 6648c6d8..f80182dd 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml @@ -10,8 +10,22 @@ System.Enum - To be added. - To be added. + Specifies color primaries as defined by the CICP (Coding-Independent Code Points) standard. + to create a color space from standardized primaries. + +This enumeration is a value type and does not require disposal. + +## Examples + +```csharp +using var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec709, + SKColorspaceTransferFnCicp.Rec709); +``` +]]> @@ -28,7 +42,7 @@ 8 - To be added. + Generic film primaries (CICP value 8). @@ -45,7 +59,7 @@ 22 - To be added. + Color primaries defined by ITU-T H.273 for value 22. @@ -62,7 +76,7 @@ 9 - To be added. + ITU-R BT.2020 and BT.2100 color primaries (CICP value 9). @@ -79,7 +93,7 @@ 5 - To be added. + ITU-R BT.470 System B/G color primaries (CICP value 5). @@ -96,7 +110,7 @@ 4 - To be added. + ITU-R BT.470 System M color primaries (CICP value 4). @@ -113,7 +127,7 @@ 6 - To be added. + ITU-R BT.601 color primaries (CICP value 6). @@ -130,7 +144,7 @@ 1 - To be added. + ITU-R BT.709 color primaries, used for HDTV and sRGB (CICP value 1). @@ -147,7 +161,7 @@ 12 - To be added. + SMPTE EG 432-1 color primaries, used for DCI-P3 (CICP value 12). @@ -164,7 +178,7 @@ 11 - To be added. + SMPTE RP 431-2 color primaries (CICP value 11). @@ -181,7 +195,7 @@ 7 - To be added. + SMPTE ST 240 color primaries (CICP value 7). @@ -198,7 +212,7 @@ 10 - To be added. + SMPTE ST 428-1 color primaries (CICP value 10). @@ -215,7 +229,7 @@ 0 - To be added. + Unknown or unspecified color primaries (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml index bddb849d..39415f0b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml +++ b/SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml @@ -10,8 +10,22 @@ System.Enum - To be added. - To be added. + Specifies transfer function characteristics as defined by the CICP (Coding-Independent Code Points) standard. + to create a color space from standardized transfer characteristics. + +This enumeration is a value type and does not require disposal. + +## Examples + +```csharp +using var colorSpace = SKColorSpace.CreateCicp( + SKColorspacePrimariesCicp.Rec2020, + SKColorspaceTransferFnCicp.Pq); +``` +]]> @@ -28,7 +42,7 @@ 18 - To be added. + Hybrid Log-Gamma (HLG) transfer function (CICP value 18). @@ -45,7 +59,7 @@ 13 - To be added. + IEC 61966-2-1 (sRGB) transfer function (CICP value 13). @@ -62,7 +76,7 @@ 11 - To be added. + IEC 61966-2-4 transfer function (CICP value 11). @@ -79,7 +93,7 @@ 8 - To be added. + Linear transfer function with no gamma encoding (CICP value 8). @@ -96,7 +110,7 @@ 16 - To be added. + SMPTE ST 2084 (Perceptual Quantizer) HDR transfer function (CICP value 16). @@ -113,7 +127,7 @@ 14 - To be added. + ITU-R BT.2020 10-bit transfer function (CICP value 14). @@ -130,7 +144,7 @@ 15 - To be added. + ITU-R BT.2020 12-bit transfer function (CICP value 15). @@ -147,7 +161,7 @@ 5 - To be added. + ITU-R BT.470 System B/G transfer function with assumed gamma 2.8 (CICP value 5). @@ -164,7 +178,7 @@ 4 - To be added. + ITU-R BT.470 System M transfer function with assumed gamma 2.2 (CICP value 4). @@ -181,7 +195,7 @@ 6 - To be added. + ITU-R BT.601 transfer function (CICP value 6). @@ -198,7 +212,7 @@ 1 - To be added. + ITU-R BT.709 transfer function, used for HDTV (CICP value 1). @@ -215,7 +229,7 @@ 7 - To be added. + SMPTE ST 240 transfer function (CICP value 7). @@ -232,7 +246,7 @@ 17 - To be added. + SMPTE ST 428-1 transfer function (CICP value 17). @@ -249,7 +263,7 @@ 0 - To be added. + Unknown or unspecified transfer function (CICP value 0). diff --git a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml index c6d5588e..d643f719 100644 --- a/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml +++ b/SkiaSharpAPI/SkiaSharp/SKDocumentXpsOptions.xml @@ -15,8 +15,26 @@ - To be added. - To be added. + Specifies the options used when creating an XPS document. + . Set the desired raster DPI and other options before passing the struct to the factory method. + +This struct is a value type and does not require disposal. + +## Examples + +```csharp +var options = new SKDocumentXpsOptions +{ + DPI = 300, + AllowNoPngs = false, +}; +using var stream = File.OpenWrite("output.xps"); +using var document = SKDocument.CreateXps(stream, options); +``` +]]> @@ -37,9 +55,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether PNG image resources may be omitted from the XPS document. + if the XPS document may omit PNG image resources; otherwise, . + @@ -60,9 +78,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the resolution in dots per inch (DPI) used for rasterizing content in the XPS document. + The raster image resolution in dots per inch. + @@ -89,10 +107,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 the two instances are equal; otherwise, . + @@ -116,10 +134,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 the specified object is a equal to the current instance; otherwise, . + @@ -141,9 +159,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -163,11 +181,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -187,11 +205,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml index 57ae755b..ceb4c2c1 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontArguments.xml @@ -19,8 +19,28 @@ - To be added. - To be added. + Specifies the arguments used to create or clone a typeface with custom settings. + to produce a customized typeface. + +This is a `ref struct` and cannot be boxed or stored on the heap. + +## Examples + +```csharp +var args = new SKFontArguments +{ + CollectionIndex = 0, + VariationDesignPosition = new SKFontVariationPositionCoordinate[] + { + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + }, +}; +using var boldFace = typeface.Clone(args); +``` +]]> @@ -41,9 +61,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the index of the desired font face within a font collection. + The zero-based index of the font within a font collection (TTC file). The default value is 0. + @@ -64,9 +84,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the index of the color palette to use for a color font. + The zero-based index of the color palette to select. The default value is 0. + @@ -87,9 +107,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontPaletteOverride> - To be added. - To be added. - To be added. + Gets or sets the per-color overrides applied to the selected color palette. + A read-only span of values that override individual palette colors. + @@ -110,9 +130,9 @@ System.ReadOnlySpan<SkiaSharp.SKFontVariationPositionCoordinate> - To be added. - To be added. - To be added. + Gets or sets the variation design position used to configure variable font axes. + A read-only span of values, each specifying an axis tag and a design-space coordinate value. + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml index 64ca610d..49876fca 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml @@ -15,8 +15,25 @@ - To be added. - To be added. + Specifies a replacement color for a single entry in a color font palette. + to customize individual colors in the selected palette when cloning a typeface. + +The `Color` property stores an `SKColor` value in ARGB format (`0xAARRGGBB`). + +## Examples + +```csharp +var overrides = new SKFontPaletteOverride[] +{ + new SKFontPaletteOverride { Index = 0, Color = (uint)SKColors.Red }, +}; +var args = new SKFontArguments { PaletteOverrides = overrides }; +using var face = typeface.Clone(args); +``` +]]> @@ -37,9 +54,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets or sets the replacement color for the palette entry. + The replacement color for the palette entry, stored as an packed into a 32-bit unsigned integer in ARGB format (0xAARRGGBB). + @@ -66,10 +83,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 the two instances are equal; otherwise, . + @@ -93,10 +110,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 the specified object is a equal to the current instance; otherwise, . + @@ -118,9 +135,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +158,9 @@ System.UInt16 - To be added. - To be added. - To be added. + Gets or sets the index of the palette color entry to replace. + The zero-based index of the palette entry to override. + @@ -163,11 +180,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -187,11 +204,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml index 8696fae6..28dd9a7c 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml @@ -15,8 +15,24 @@ - To be added. - To be added. + Describes a single variation axis in an OpenType variable font. + or to retrieve the axes for a typeface. + +This struct is a value type and does not require disposal. + +## Examples + +```csharp +var axes = typeface.VariationDesignParameters; +foreach (var axis in axes) +{ + Console.WriteLine($"{axis.Tag}: [{axis.Min}, {axis.Max}], default={axis.Default}"); +} +``` +]]> @@ -37,9 +53,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the default value for this variation axis. + The default design-space value for this variation axis. + @@ -66,10 +82,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 the two instances are equal; otherwise, . + @@ -93,10 +109,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 the specified object is a equal to the current instance; otherwise, . + @@ -118,9 +134,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -141,9 +157,9 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether this variation axis is hidden from user interfaces. + if this axis should be hidden in user interfaces; otherwise, . + @@ -164,9 +180,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the maximum value for this variation axis. + The maximum design-space value allowed for this variation axis. + @@ -187,9 +203,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the minimum value for this variation axis. + The minimum design-space value allowed for this variation axis. + @@ -209,11 +225,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -233,11 +249,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + @@ -258,9 +274,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the four-byte tag that identifies this variation axis. + The four-byte tag that uniquely identifies this variation axis (for example, wght for weight or wdth for width). + diff --git a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml index bdaf5a82..50231af7 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml @@ -15,8 +15,26 @@ - To be added. - To be added. + Specifies a design-space coordinate for a single variation axis in a variable font. + to position a typeface clone along one or more axes. + +This struct is a value type and does not require disposal. + +## Examples + +```csharp +var coords = new SKFontVariationPositionCoordinate[] +{ + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("wght"), Value = 700 }, + new SKFontVariationPositionCoordinate { Axis = SKFourByteTag.Parse("ital"), Value = 1 }, +}; +var args = new SKFontArguments { VariationDesignPosition = coords }; +using var face = typeface.Clone(args); +``` +]]> @@ -37,9 +55,9 @@ SkiaSharp.SKFourByteTag - To be added. - To be added. - To be added. + Gets or sets the tag of the variation axis this coordinate applies to. + The four-byte tag identifying the variation axis. + @@ -66,10 +84,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 the two instances are equal; otherwise, . + @@ -93,10 +111,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 the specified object is a equal to the current instance; otherwise, . + @@ -118,9 +136,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -140,11 +158,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -164,11 +182,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + @@ -189,9 +207,9 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the design-space value for the variation axis. + The design-space value for the axis identified by . + diff --git a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml index 184c1aca..e8aecaa6 100644 --- a/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml +++ b/SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml @@ -20,8 +20,24 @@ - To be added. - To be added. + Represents a four-byte tag (FourCC) used to identify OpenType font tables, variation axes, and other resources. + @@ -37,9 +53,9 @@ - To be added. - To be added. - To be added. + The raw 32-bit unsigned integer value of the tag. + Initializes a new instance of the struct from a raw 32-bit value. + @@ -58,12 +74,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 characters. + @@ -85,10 +101,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 the two tags are equal; otherwise, . + @@ -112,10 +128,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 the specified object is a equal to the current instance; otherwise, . + @@ -132,9 +148,9 @@ - To be added. - To be added. - To be added. + Returns a hash code for the current instance. + A hash code for the current instance. + @@ -154,11 +170,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are equal. + if equals ; otherwise, . + @@ -177,10 +193,10 @@ - To be added. - To be added. - To be added. - To be added. + The to convert. + Implicitly converts a to a 32-bit unsigned integer. + The tag's packed 32-bit unsigned integer value. + @@ -199,10 +215,10 @@ - To be added. - To be added. - To be added. - To be added. + The raw 32-bit unsigned integer to convert. + Implicitly converts a 32-bit unsigned integer to a . + An with the given raw value. + @@ -222,11 +238,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The left operand. + The right operand. + Determines whether two instances are not equal. + if does not equal ; otherwise, . + @@ -250,10 +266,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to parse. Only the first four characters are used; shorter strings are padded with spaces. + Parses a string into a . + An parsed from the string. If is or empty, returns a tag with the value zero. Strings shorter than four characters are padded with spaces; longer strings are truncated. + @@ -275,9 +291,9 @@ - To be added. - To be added. - To be added. + Returns the four-character string representation of this tag. + A four-character string representation of the tag. + 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..c0ce2f3b 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 filled path geometry. + Computes the filled geometry of the source path using the current paint settings and writes the result into the destination builder. + if the fill path was successfully computed; 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 filled path geometry. + The transformation matrix to apply when computing the fill path. + Computes the filled geometry of the source path using the current paint settings and the specified transformation matrix, and writes the result into the destination builder. + if the fill path was successfully computed; 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 filled path geometry. + The rectangle used to cull portions of the path that fall outside its bounds. + Computes the filled geometry of the source path using the current paint settings, culled to the specified rectangle, and writes the result into the destination builder. + if the fill path was successfully computed; 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 filled path geometry. + The resolution scale factor used to determine the precision of curves in the fill path. + Computes the filled geometry of the source path using the current paint settings at the specified resolution scale, and writes the result into the destination builder. + if the fill path was successfully computed; 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 filled path geometry. + The rectangle used to cull portions of the path that fall outside its bounds. + The transformation matrix to apply when computing the fill path. + Computes the filled geometry of the source path using the current paint settings, applying the specified cull rectangle and transformation matrix, and writes the result into the destination builder. + if the fill path was successfully computed; 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 filled path geometry. + The rectangle used to cull portions of the path that fall outside its bounds. + The resolution scale factor used to determine the precision of curves in the fill path. + Computes the filled geometry of the source path using the current paint settings, applying the specified cull rectangle and resolution scale, and writes the result into the destination builder. + if the fill path was successfully computed; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKPath.xml b/SkiaSharpAPI/SkiaSharp/SKPath.xml index 43a0842d..0c8023fb 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 handle to the underlying native object. + A pointer to the underlying native Skia path object. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml index 4b53c0fb..a290027a 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml @@ -11,8 +11,26 @@ - To be added. - To be added. + Provides a mutable builder for constructing an incrementally. + incrementally. Add contours, arcs, curves, and shapes, then call to obtain a copy or to transfer ownership of the path. + +This type wraps a native Skia resource and implements `IDisposable`. Always dispose of it when done, either with a `using` statement or by calling `Dispose()` directly. + +## Examples + +```csharp +using var builder = new SKPathBuilder(); +builder.MoveTo(10, 10); +builder.LineTo(100, 10); +builder.LineTo(100, 100); +builder.Close(); +using var path = builder.Detach(); +canvas.DrawPath(path, paint); +``` +]]> @@ -26,8 +44,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + @@ -43,9 +61,9 @@ - To be added. - To be added. - To be added. + The path whose contours are copied into the new builder. + Initializes a new instance of the class with the contents of an existing path. + @@ -66,11 +84,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval that defines the arc. + The start angle in degrees, measured clockwise from the positive x-axis. + The sweep angle in degrees, measured clockwise from . + Appends an arc of the specified oval to the path as a new contour. + @@ -92,12 +110,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the center of the circle. + The y-coordinate of the center of the circle. + The radius of the circle. + One of the enumeration values that specifies the winding direction of the circle contour. + Appends a closed circle contour to the path. + @@ -117,10 +135,10 @@ - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval. + One of the enumeration values that specifies the winding direction of the oval contour. + Appends a closed oval contour to the path. + @@ -140,10 +158,10 @@ - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended to the current path. + One of the enumeration values that specifies how the path is appended. + Appends the contours of another path to the current path. + @@ -170,11 +188,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The path whose contours are appended to the current path. + The transformation matrix applied to each point in the source path before appending. + One of the enumeration values that specifies how the path is appended. + Appends the contours of another path, transformed by the specified matrix, to the current path. + @@ -196,12 +214,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 to the current path. + The horizontal offset applied to each point in the source path before appending. + The vertical offset applied to each point in the source path before appending. + One of the enumeration values that specifies how the path is appended. + Appends the contours of another path, translated by the specified offset, to the current path. + @@ -221,10 +239,10 @@ - To be added. - To be added. - To be added. - To be added. + The array of vertices that form the polygon. + to close the polygon by adding a line back to the first point; otherwise, . + Appends a polygon contour defined by the specified points to the path. + @@ -244,10 +262,10 @@ - To be added. - To be added. - To be added. - To be added. + The read-only span of vertices that form the polygon. + to close the polygon by adding a line back to the first point; otherwise, . + Appends a polygon contour defined by the specified points to the path. + @@ -267,10 +285,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to add as a closed contour. + One of the enumeration values that specifies the winding direction of the rectangle contour. + Appends a closed rectangle contour to the path. + @@ -291,11 +309,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rectangle to add as a closed contour. + One of the enumeration values that specifies the winding direction of the rectangle contour. + The zero-based corner index (0 through 3) at which the contour begins. + Appends a closed rectangle contour to the path, starting at the specified corner. + @@ -315,10 +333,10 @@ - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add as a closed contour. + One of the enumeration values that specifies the winding direction of the contour. + Appends a closed rounded-rectangle contour to the path. + @@ -339,11 +357,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The rounded rectangle to add as a closed contour. + One of the enumeration values that specifies the winding direction of the contour. + The zero-based corner index at which the contour begins. + Appends a closed rounded-rectangle contour to the path, starting at the specified corner. + @@ -365,12 +383,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the rounded rectangle. + The x-axis radius of the corner ellipses. + The y-axis radius of the corner ellipses. + One of the enumeration values that specifies the winding direction of the contour. + Appends a closed rounded-rectangle contour with uniform corner radii to the path. + @@ -391,11 +409,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first tangent point. + The second tangent point. + The radius of the tangent arc. + Appends a tangent arc between two lines to the current contour. + @@ -417,12 +435,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The bounding rectangle of the oval that defines the arc. + The start angle in degrees, measured clockwise from the positive x-axis. + The sweep angle in degrees, measured clockwise from . + to add a move-to before the arc, starting a new contour; to connect the arc to the current point with a line. + Appends an arc of the specified oval to the current contour. + @@ -445,13 +463,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The radii of the arc ellipse (x-radius and y-radius). + The rotation of the ellipse x-axis relative to the current coordinate system, in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the winding direction of the arc. + The end point of the arc. + Appends an SVG-style elliptical arc to the current contour using the specified radii and end point. + @@ -474,13 +492,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the first tangent point. + The y-coordinate of the first tangent point. + The x-coordinate of the second tangent point. + The y-coordinate of the second tangent point. + The radius of the tangent arc. + Appends a tangent arc between two lines to the current contour. + @@ -505,15 +523,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 arc ellipse. + The y-radius of the arc ellipse. + The rotation of the ellipse x-axis relative to the current coordinate system, in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the winding direction of the arc. + The x-coordinate of the end point of the arc. + The y-coordinate of the end point of the arc. + Appends an SVG-style elliptical arc to the current contour using separate radius and end-point coordinates. + @@ -530,8 +548,8 @@ - To be added. - To be added. + Closes the current contour by adding a line from the current point back to the starting point of the contour. + @@ -552,11 +570,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic curve. + The end point of the conic curve. + The weight of the conic, which controls how much the curve is pulled toward the control point. + Appends a conic (rational quadratic Bezier) curve to the current contour. + @@ -579,13 +597,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, which controls how much the curve is pulled toward the control point. + Appends a conic (rational quadratic Bezier) curve to the current contour. + @@ -606,11 +624,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point of the cubic Bezier curve. + The second control point of the cubic Bezier curve. + The end point of the cubic Bezier curve. + Appends a cubic Bezier curve to the current contour. + @@ -634,14 +652,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 Bezier curve to the current contour. + @@ -658,9 +676,9 @@ - To be added. - To be added. - To be added. + Detaches the accumulated path from the builder, returning it as a new and resetting the builder. + A new containing the accumulated contours. The builder is reset after this call. + @@ -679,9 +697,9 @@ - To be added. - To be added. - To be added. + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the resources used by the current instance of the class. + @@ -698,8 +716,8 @@ - To be added. - To be added. + Releases the native resources held by the current instance of the class. + @@ -715,9 +733,9 @@ SkiaSharp.SKPathFillType - To be added. - To be added. - To be added. + Gets or sets the fill type used to determine the interior of the path. + One of the values that determines how the interior of the path is determined when it self-intersects. + @@ -736,9 +754,9 @@ - To be added. - To be added. - To be added. + The point to move to. + Appends a straight line from the current point to the specified point. + @@ -758,10 +776,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 +798,9 @@ - To be added. - To be added. - To be added. + The end point of the line. + Begins a new contour at the specified point. + @@ -802,10 +820,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-coordinate of the point to move to. + The y-coordinate of the point to move to. + Begins a new contour at the specified coordinates. + @@ -825,10 +843,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point of the quadratic Bezier curve. + The end point of the quadratic Bezier curve. + Appends a quadratic Bezier curve to the current contour. + @@ -850,12 +868,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 Bezier curve to the current contour. + @@ -878,13 +896,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The radii of the arc ellipse (x-radius and y-radius), specified relative to the current point. + The rotation of the ellipse x-axis relative to the current coordinate system, in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the winding direction of the arc. + The end point of the arc, specified relative to the current point. + Appends a relative SVG-style elliptical arc to the current contour. + @@ -909,15 +927,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 arc ellipse. + The y-radius of the arc ellipse. + The rotation of the ellipse x-axis relative to the current coordinate system, in degrees. + One of the enumeration values that specifies whether to draw the large or small arc. + One of the enumeration values that specifies the winding direction of the arc. + The x-offset of the end point relative to the current point. + The y-offset of the end point relative to the current point. + Appends a relative SVG-style elliptical arc to the current contour. + @@ -938,11 +956,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The control point of the conic curve, relative to the current point. + The end point of the conic curve, relative to the current point. + The weight of the conic. + Appends a relative conic (rational quadratic Bezier) curve to the current contour. + @@ -965,13 +983,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset of the control point relative to the current point. + The y-offset of the control point relative to the current point. + The x-offset of the end point relative to the current point. + The y-offset of the end point relative to the current point. + The weight of the conic. + Appends a relative conic (rational quadratic Bezier) curve to the current contour. + @@ -992,11 +1010,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first control point, relative to the current point. + The second control point, relative to the current point. + The end point, relative to the current point. + Appends a relative cubic Bezier curve to the current contour. + @@ -1020,14 +1038,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset of the first control point relative to the current point. + The y-offset of the first control point relative to the current point. + The x-offset of the second control point relative to the current point. + The y-offset of the second control point relative to the current point. + The x-offset of the end point relative to the current point. + The y-offset of the end point relative to the current point. + Appends a relative cubic Bezier curve to the current contour. + @@ -1044,8 +1062,8 @@ - To be added. - To be added. + Resets the builder, removing all contours and restoring the default fill type. + @@ -1064,9 +1082,9 @@ - To be added. - To be added. - To be added. + The path whose contours are appended in reverse order. + Appends the contours of another path to the current path in reverse order. + @@ -1085,9 +1103,9 @@ - To be added. - To be added. - To be added. + The end point, specified relative to the current point. + Appends a straight line from the current point to a point at the specified relative offset. + @@ -1107,10 +1125,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-offset of the end point relative to the current point. + The y-offset of the end point relative to the current point. + Appends a straight line from the current point to a point at the specified relative offset. + @@ -1129,9 +1147,9 @@ - To be added. - To be added. - To be added. + The offset from the current point at which the new contour begins. + Begins a new contour at a point offset from the current point. + @@ -1151,10 +1169,10 @@ - To be added. - To be added. - To be added. - To be added. + The x-offset from the current point. + The y-offset from the current point. + Begins a new contour at a point offset from the current point. + @@ -1174,10 +1192,10 @@ - To be added. - To be added. - To be added. - To be added. + The control point, relative to the current point. + The end point, relative to the current point. + Appends a relative quadratic Bezier curve to the current contour. + @@ -1199,12 +1217,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The x-offset of the control point relative to the current point. + The y-offset of the control point relative to the current point. + The x-offset of the end point relative to the current point. + The y-offset of the end point relative to the current point. + Appends a relative quadratic Bezier curve to the current contour. + @@ -1221,9 +1239,9 @@ - To be added. - To be added. - To be added. + Returns a copy of the current path without resetting the builder. + A new containing a copy of the current contours. The builder retains its state and can continue to be used. + diff --git a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml index 6a11f5f7..ff5d85dd 100644 --- a/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml +++ b/SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml @@ -345,13 +345,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The distance along the path at which the segment begins. + The distance along the path at which the segment ends. + The that receives the extracted path segment. + to begin the segment with a move-to, starting a new contour in the destination builder; to append the segment to the current contour. + Extracts a segment of the path between the specified distances and appends it to the destination builder. + if the segment was successfully extracted; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKStream.xml b/SkiaSharpAPI/SkiaSharp/SKStream.xml index fc269d5a..9775c5e6 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 stream's data as a new instance. + An instance containing the stream's data, or if the data cannot be retrieved. + diff --git a/SkiaSharpAPI/SkiaSharp/SKSurface.xml b/SkiaSharpAPI/SkiaSharp/SKSurface.xml index 953c3d3b..177a7a90 100644 --- a/SkiaSharpAPI/SkiaSharp/SKSurface.xml +++ b/SkiaSharpAPI/SkiaSharp/SKSurface.xml @@ -2826,12 +2826,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas onto which the surface is drawn. + The position at which to draw the top-left corner of the surface. + The sampling options to use when drawing the surface. + The paint to apply when drawing the surface, or to use the default paint. + Draws the surface onto the specified canvas at the given point using the specified sampling options. + @@ -2885,13 +2885,13 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The canvas onto which the surface is drawn. + The x-coordinate of the position at which to draw the top-left corner of the surface. + The y-coordinate of the position at which to draw the top-left corner of the surface. + The sampling options to use when drawing the surface. + The paint to apply when drawing the surface, or to use the default paint. + Draws the surface onto the specified canvas at the given coordinates using the specified sampling options. + diff --git a/SkiaSharpAPI/SkiaSharp/SKTypeface.xml b/SkiaSharpAPI/SkiaSharp/SKTypeface.xml index b0f4c2f3..1ab5df2f 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 position, collection index, palette index, and palette overrides for the clone. + Creates a new typeface by cloning the current typeface with the specified font arguments. + A new instance configured according to the specified 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 color palette to use. + Creates a new typeface by cloning the current typeface with the specified color palette index. + A new instance using the specified color palette. + @@ -162,10 +162,10 @@ Typeface objects are immutable, and so they can be shared between threads. - To be added. - To be added. - To be added. - To be added. + A read-only span of values specifying the desired axis coordinates. + Creates a new typeface by cloning the current typeface at the specified variation design position. + A new instance at the specified variation 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 shared empty typeface that contains no glyphs. + A shared empty instance with no glyphs. + @@ -1745,10 +1745,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span that receives the variation axis parameter descriptors. + Fills the provided span with the variation axis parameters for this typeface. + The number of variation axis parameter descriptors written into . + @@ -1767,10 +1767,10 @@ using (var surface = SKSurface.Create(info)) { - To be added. - To be added. - To be added. - To be added. + A span that receives the current variation design position coordinates. + Fills the provided span with the current variation design position of this typeface. + The number of variation coordinates written into . + @@ -1859,9 +1859,9 @@ A typeface is understood to be bold when the weight is greater than or equal to System.Boolean - To be added. - To be added. - To be added. + Gets a value indicating whether the typeface is empty (contains no glyphs). + if the typeface contains no glyphs; 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 axis parameters defined for this typeface. + The total number of variation axes defined for this typeface. + @@ -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 information about all variation axes defined for this typeface. + An array of values describing the available variation axes, or an empty array if no variation data is present. + @@ -2255,9 +2255,9 @@ A typeface is understood to be italic when it has a slant of either SkiaSharp.SKFontVariationPositionCoordinate[] - To be added. - To be added. - To be added. + Gets the current variation design position of this typeface. + An array of values representing the current variation design position, or an empty array if no variation data is present. + @@ -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 design position coordinates for this typeface. + The total number of variation coordinates in the current design position. + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml index 7343b6e0..f474e669 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoder.xml @@ -11,8 +11,23 @@ - To be added. - To be added. + Provides static methods to encode images and animated sequences as WebP. + @@ -42,11 +57,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The source pixel data to encode. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and returns the result as an instance. + An instance containing the encoded WebP image, or if encoding fails. + @@ -72,12 +87,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination stream to which the encoded WebP image is written. + The source pixel data to encode. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and writes the result to a native stream. + if encoding was successful; otherwise, . + @@ -103,12 +118,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination stream to which the encoded WebP image is written. + The source pixel data to encode. + The encoding options, including quality and compression type. + Encodes the specified pixmap as a WebP image and writes the result to a managed stream. + if encoding was successful; otherwise, . + @@ -133,11 +148,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The sequence of frames to include in the animated WebP image. + The encoding options, including quality and compression type. + Encodes the specified frames as an animated WebP image and returns the result as an instance. + An instance containing the encoded animated WebP image, or if encoding fails. + @@ -164,12 +179,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination native stream to which the encoded animated WebP image is written. + The sequence of frames to include in the animated WebP image. + The encoding options, including quality and compression type. + Encodes the specified frames as an animated WebP image and writes the result to a native stream. + if encoding was successful; otherwise, . + @@ -196,12 +211,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The destination managed stream to which the encoded animated WebP image is written. + The sequence of frames to include in the animated WebP image. + The encoding options, including quality and compression type. + Encodes the specified frames as an animated WebP image and writes the result to a managed stream. + if encoding was successful; otherwise, . + diff --git a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml index ed712a08..14318f7b 100644 --- a/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml +++ b/SkiaSharpAPI/SkiaSharp/SKWebpEncoderFrame.xml @@ -11,8 +11,24 @@ - To be added. - To be added. + Represents a single frame in an animated WebP image, including the pixel data and display duration. + @@ -29,10 +45,10 @@ - To be added. - To be added. - To be added. - To be added. + The source bitmap whose pixels will be used for this frame. The bitmap must remain valid for the lifetime of this frame. + The length of time this frame is displayed during animation playback. + Initializes a new instance of with the specified bitmap and display duration. + @@ -49,10 +65,10 @@ - To be added. - To be added. - To be added. - To be added. + The source image whose pixels will be used for this frame. The image must be raster-backed and remain valid for the lifetime of this frame. + The length of time this frame is displayed during animation playback. + Initializes a new instance of with the specified image and display duration. + @@ -69,10 +85,10 @@ - To be added. - To be added. - To be added. - To be added. + The source pixmap containing the pixel data for this frame. + The length of time this frame is displayed during animation playback. + Initializes a new instance of with the specified pixmap and display duration. + @@ -93,9 +109,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 +132,9 @@ SkiaSharp.SKPixmap - To be added. - To be added. - To be added. + Gets or sets the pixel data for this frame. + The containing the pixel data for this frame. + diff --git a/SkiaSharpAPI/index.xml b/SkiaSharpAPI/index.xml index f8686330..6fcc1ca5 100644 --- a/SkiaSharpAPI/index.xml +++ b/SkiaSharpAPI/index.xml @@ -750,12 +750,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -812,13 +812,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -846,13 +846,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -912,14 +912,14 @@ System.Void - - - - - - - - + + + + + + + + The canvas to draw on. @@ -948,11 +948,11 @@ System.Void - - - - - + + + + + The canvas to draw on. @@ -1006,12 +1006,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1038,12 +1038,12 @@ System.Void - - - - - - + + + + + + The canvas to draw on. @@ -1100,13 +1100,13 @@ System.Void - - - - - - - + + + + + + + The canvas to draw on. @@ -1204,7 +1204,7 @@ System.Int32 - + The color type to query. @@ -1556,7 +1556,7 @@ SkiaSharp.SKSamplingOptions - + The filter quality to convert. @@ -3124,7 +3124,7 @@ ExtensionMethod - + To be added. @@ -3146,7 +3146,7 @@ ExtensionMethod - + To be added. @@ -3168,7 +3168,7 @@ ExtensionMethod - + To be added. @@ -3190,7 +3190,7 @@ ExtensionMethod - + To be added. @@ -3212,7 +3212,7 @@ ExtensionMethod - + To be added. @@ -3234,7 +3234,7 @@ ExtensionMethod - + To be added. @@ -3256,7 +3256,7 @@ ExtensionMethod - + To be added. @@ -3478,7 +3478,7 @@ ExtensionMethod - + To be added. @@ -3500,7 +3500,7 @@ ExtensionMethod - + To be added. @@ -3568,7 +3568,7 @@ ExtensionMethod - + To be added. @@ -3590,7 +3590,7 @@ ExtensionMethod - + To be added. @@ -3634,7 +3634,7 @@ ExtensionMethod - + To be added. @@ -3678,7 +3678,7 @@ ExtensionMethod - + To be added. @@ -4860,9 +4860,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -4960,10 +4960,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -5036,9 +5036,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap. @@ -6276,12 +6276,12 @@ - - - + + + ExtensionMethod - Microsoft.Maui.Hosting.MauiAppBuilder + Microsoft.Maui.Hosting.MauiAppBuilder @@ -6992,7 +6992,7 @@ SkiaSharp.SKColorF - + The Tizen NUI color. @@ -7036,7 +7036,7 @@ SkiaSharp.SKPoint - + The Tizen NUI position. @@ -7080,7 +7080,7 @@ SkiaSharp.SKPointI - + The Tizen NUI 2D position. @@ -7124,7 +7124,7 @@ SkiaSharp.SKRect - + The Tizen NUI rectangle. @@ -7168,7 +7168,7 @@ SkiaSharp.SKRectI - + The Tizen NUI rectangle. @@ -7212,7 +7212,7 @@ SkiaSharp.SKSize - + The Tizen NUI size. @@ -7256,7 +7256,7 @@ SkiaSharp.SKSizeI - + The Tizen NUI 2D size. @@ -8414,9 +8414,9 @@ UIKit.UIImage - - - + + + The SkiaSharp bitmap. @@ -8514,10 +8514,10 @@ UIKit.UIImage - - - - + + + + The SkiaSharp picture. @@ -8590,9 +8590,9 @@ UIKit.UIImage - - - + + + The SkiaSharp pixmap.