Skip to content

Commit 446af2f

Browse files
committed
methods
1 parent 646e0b8 commit 446af2f

29 files changed

+416
-148
lines changed

binding/HarfBuzzSharp/Buffer.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ internal Buffer (IntPtr handle)
2020
}
2121

2222
/// <summary>
23-
/// Creates a new <see cref="M:HarfBuzzSharp.Buffer.#ctor" /> with default values.
23+
/// Creates a new <see cref="Buffer.#ctor" /> with default values.
2424
/// </summary>
2525
public Buffer ()
2626
: this (HarfBuzzApi.hb_buffer_create ())
@@ -35,7 +35,7 @@ public ContentType ContentType {
3535
/// <summary>
3636
/// Get or sets the text flow direction of the buffer.
3737
/// </summary>
38-
/// <remarks>No shaping can happen without setting the direction, or invoking <see cref="M:HarfBuzzSharp.Buffer.GuessSegmentProperties" />.</remarks>
38+
/// <remarks>No shaping can happen without setting the direction, or invoking <see cref="Buffer.GuessSegmentProperties" />.</remarks>
3939
public Direction Direction {
4040
get => HarfBuzzApi.hb_buffer_get_direction (Handle);
4141
set => HarfBuzzApi.hb_buffer_set_direction (Handle, value);

binding/HarfBuzzSharp/DelegateProxies.font.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
namespace HarfBuzzSharp
77
{
88
/// <summary>
9-
/// The delegate that is invoked when <see cref="M:HarfBuzzSharp.Font.TryGetHorizontalFontExtents(HarfBuzzSharp.FontExtents@)" /> or <see cref="M:HarfBuzzSharp.Font.TryGetVerticalFontExtents(HarfBuzzSharp.FontExtents@)" /> is invoked.
9+
/// The delegate that is invoked when <see cref="Font.TryGetHorizontalFontExtents(HarfBuzzSharp.FontExtents@)" /> or <see cref="Font.TryGetVerticalFontExtents(HarfBuzzSharp.FontExtents@)" /> is invoked.
1010
/// </summary>
1111
/// <param name="font">The font.</param>
12-
/// <param name="fontData">The additional data passed to <see cref="M:HarfBuzzSharp.Font.SetFontFunctions(HarfBuzzSharp.FontFunctions,System.Object,HarfBuzzSharp.ReleaseDelegate)" /> when the functions were set.</param>
12+
/// <param name="fontData">The additional data passed to <see cref="Font.SetFontFunctions(HarfBuzzSharp.FontFunctions,System.Object,HarfBuzzSharp.ReleaseDelegate)" /> when the functions were set.</param>
1313
/// <param name="extents">The font extents.</param>
1414
/// <returns>Return true if the <see cref="Font" /> has extents, otherwise false.</returns>
1515
public delegate bool FontExtentsDelegate (Font font, object fontData, out FontExtents extents);
@@ -21,10 +21,10 @@ namespace HarfBuzzSharp
2121
public delegate bool VariationGlyphDelegate (Font font, object fontData, uint unicode, uint variationSelector, out uint glyph);
2222

2323
/// <summary>
24-
/// The delegate that is invoked when <see cref="M:HarfBuzzSharp.Font.GetHorizontalGlyphAdvance(System.UInt32)" /> or <see cref="M:HarfBuzzSharp.Font.GetVerticalGlyphAdvance(System.UInt32)" /> is invoked.
24+
/// The delegate that is invoked when <see cref="Font.GetHorizontalGlyphAdvance(System.UInt32)" /> or <see cref="Font.GetVerticalGlyphAdvance(System.UInt32)" /> is invoked.
2525
/// </summary>
2626
/// <param name="font">The font.</param>
27-
/// <param name="fontData">The additional data passed to <see cref="M:HarfBuzzSharp.Font.SetFontFunctions(HarfBuzzSharp.FontFunctions,System.Object,HarfBuzzSharp.ReleaseDelegate)" /> when the functions were set.</param>
27+
/// <param name="fontData">The additional data passed to <see cref="Font.SetFontFunctions(HarfBuzzSharp.FontFunctions,System.Object,HarfBuzzSharp.ReleaseDelegate)" /> when the functions were set.</param>
2828
/// <param name="glyph">The glyph.</param>
2929
/// <returns>Return the advance amount.</returns>
3030
public delegate int GlyphAdvanceDelegate (Font font, object fontData, uint glyph);

binding/HarfBuzzSharp/HarfBuzzApi.generated.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7301,7 +7301,7 @@ public enum BufferFlags {
73017301

73027302
// hb_buffer_serialize_flags_t
73037303
/// <summary>
7304-
/// The various flags that control what glyph information are serialized by <see cref="M:HarfBuzzSharp.Buffer.SerializeGlyphs(System.Int32,System.Int32,HarfBuzzSharp.Font,HarfBuzzSharp.SerializeFormat,HarfBuzzSharp.SerializeFlag)" />.
7304+
/// The various flags that control what glyph information are serialized by <see cref="Buffer.SerializeGlyphs(System.Int32,System.Int32,HarfBuzzSharp.Font,HarfBuzzSharp.SerializeFormat,HarfBuzzSharp.SerializeFlag)" />.
73057305
/// </summary>
73067306
[Flags]
73077307
public enum SerializeFlag {

binding/SkiaSharp/Definitions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ public static SKAlphaType GetAlphaType (this SKColorType colorType, SKAlphaType
331331
}
332332

333333
/// <summary>
334-
/// Additional options to pass to <see cref="M:SkiaSharp.SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)" /> or one of the overloads that accepts a <see cref="SKCodecOptions" />.
334+
/// Additional options to pass to <see cref="SKCodec.GetPixels(SkiaSharp.SKImageInfo,System.IntPtr,SkiaSharp.SKCodecOptions)" /> or one of the overloads that accepts a <see cref="SKCodecOptions" />.
335335
/// </summary>
336336
public struct SKCodecOptions : IEquatable<SKCodecOptions>
337337
{
@@ -839,7 +839,7 @@ public readonly override int GetHashCode ()
839839
}
840840

841841
/// <summary>
842-
/// High contrast configuration settings for use with <see cref="M:SkiaSharp.SKColorFilter.CreateHighContrast(SkiaSharp.SKHighContrastConfig)" />.
842+
/// High contrast configuration settings for use with <see cref="SKColorFilter.CreateHighContrast(SkiaSharp.SKHighContrastConfig)" />.
843843
/// </summary>
844844
public partial struct SKHighContrastConfig
845845
{

binding/SkiaSharp/DelegateProxies.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace SkiaSharp
2222
/// The delegate that is used when a <see cref="SKData" /> instance is about to be released.
2323
/// </summary>
2424
/// <param name="address">The pointer to the byte buffer.</param>
25-
/// <param name="context">The user state passed to <see cref="M:SkiaSharp.SKData.Create(System.IntPtr,System.Int32,SkiaSharp.SKDataReleaseDelegate,System.Object)" />.</param>
25+
/// <param name="context">The user state passed to <see cref="SKData.Create(System.IntPtr,System.Int32,SkiaSharp.SKDataReleaseDelegate,System.Object)" />.</param>
2626
public delegate void SKDataReleaseDelegate (IntPtr address, object context);
2727

2828
/// <summary>

binding/SkiaSharp/GRDefinitions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
namespace SkiaSharp
1010
{
1111
/// <summary>
12-
/// Various flags for the <see cref="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRGlBackendState)" /> method when using a <see cref="GRBackend.OpenGL" /> backend.
12+
/// Various flags for the <see cref="GRContext.ResetContext(SkiaSharp.GRGlBackendState)" /> method when using a <see cref="GRBackend.OpenGL" /> backend.
1313
/// </summary>
1414
[Flags]
1515
public enum GRGlBackendState : UInt32
@@ -73,7 +73,7 @@ public enum GRGlBackendState : UInt32
7373
}
7474

7575
/// <summary>
76-
/// Various flags for the <see cref="M:SkiaSharp.GRContext.ResetContext(SkiaSharp.GRBackendState)" /> method.
76+
/// Various flags for the <see cref="GRContext.ResetContext(SkiaSharp.GRBackendState)" /> method.
7777
/// </summary>
7878
[Flags]
7979
public enum GRBackendState : UInt32

binding/SkiaSharp/MathTypes.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace SkiaSharp
88
/// <summary>
99
/// Represents an ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane.
1010
/// </summary>
11-
/// <remarks>To convert a <see cref="SKPoint" /> to a <see cref="SKPointI" />, use <see cref="M:SkiaSharp.SKPointI.Round(SkiaSharp.SKPoint)" /> or <see cref="M:SkiaSharp.SKPointI.Truncate(SkiaSharp.SKPoint)" />.</remarks>
11+
/// <remarks>To convert a <see cref="SKPoint" /> to a <see cref="SKPointI" />, use <see cref="SKPointI.Round(SkiaSharp.SKPoint)" /> or <see cref="SKPointI.Truncate(SkiaSharp.SKPoint)" />.</remarks>
1212
public partial struct SKPoint
1313
{
1414
/// <summary>

binding/SkiaSharp/SKBitmap.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace SkiaSharp
1414
/// <summary>
1515
/// The <see cref="SKBitmap" /> specifies a raster bitmap.
1616
/// </summary>
17-
/// <remarks><para>A bitmap has an integer width and height, and a format (color type), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="SKCanvas" />, but they are also used to specify the target of a <see cref="SKCanvas" />' drawing operations.</para><para>A <see cref="SKBitmap" /> exposes <see cref="M:SkiaSharp.SKBitmap.GetPixels" />, which lets a caller write its pixels. To retrieve a pointer to the raw image data of the bitmap, call the <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> method, and then call the <see cref="M:SkiaSharp.SKBitmap.GetPixels" /> method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> method. The raw data is laid out in the format configured at the time that the bitmap was created.</para><para>(Note: As of SkiaSharp 1.60.0, calls to <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> and <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> are no longer required, and they no longer exist as part of the API.)</para></remarks>
17+
/// <remarks><para>A bitmap has an integer width and height, and a format (color type), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="SKCanvas" />, but they are also used to specify the target of a <see cref="SKCanvas" />' drawing operations.</para><para>A <see cref="SKBitmap" /> exposes <see cref="SKBitmap.GetPixels" />, which lets a caller write its pixels. To retrieve a pointer to the raw image data of the bitmap, call the <see cref="SKBitmap.LockPixels" /> method, and then call the <see cref="SKBitmap.GetPixels" /> method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the <see cref="SKBitmap.UnlockPixels" /> method. The raw data is laid out in the format configured at the time that the bitmap was created.</para><para>(Note: As of SkiaSharp 1.60.0, calls to <see cref="SKBitmap.LockPixels" /> and <see cref="SKBitmap.UnlockPixels" /> are no longer required, and they no longer exist as part of the API.)</para></remarks>
1818
public unsafe class SKBitmap : SKObject, ISKSkipObjectRegistration
1919
{
2020
private const string UnsupportedColorTypeMessage = "Setting the ColorTable is only supported for bitmaps with ColorTypes of Index8.";
@@ -211,7 +211,7 @@ public IntPtr GetAddress (int x, int y) =>
211211
/// </summary>
212212
/// <param name="x">The x-cordinate.</param>
213213
/// <param name="y">The y-cordinate.</param>
214-
/// <returns>Alpha only color types return black with the appropriate alpha set. The value is undefined for <see cref="SKColorType.Unknown" />, if the coordinates are out of bounds, if the bitmap does not have any pixels, or has not be locked with <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</returns>
214+
/// <returns>Alpha only color types return black with the appropriate alpha set. The value is undefined for <see cref="SKColorType.Unknown" />, if the coordinates are out of bounds, if the bitmap does not have any pixels, or has not be locked with <see cref="SKBitmap.LockPixels" />.</returns>
215215
/// <remarks>In most cases this will require unpremultiplying the color.</remarks>
216216
public SKColor GetPixel (int x, int y)
217217
{
@@ -240,7 +240,7 @@ public void SetPixel (int x, int y, SKColor color)
240240
// Copy
241241

242242
/// <summary>
243-
/// Returns true if this bitmap's pixels can be converted into the requested color type, such that <see cref="M:SkiaSharp.SKBitmap.Copy" /> or <see cref="M:SkiaSharp.SKBitmap.CopyTo(SkiaSharp.SKBitmap)" /> could succeed.
243+
/// Returns true if this bitmap's pixels can be converted into the requested color type, such that <see cref="SKBitmap.Copy" /> or <see cref="SKBitmap.CopyTo(SkiaSharp.SKBitmap)" /> could succeed.
244244
/// </summary>
245245
/// <param name="colorType">The color type to check with.</param>
246246
/// <returns>Returns true if this bitmap's pixels can be converted into the requested color type.</returns>

0 commit comments

Comments
 (0)