wieslawsoltes
/
SkiaSharp
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Updated the docs

This commit is contained in:
Matthew Leibowitz 2018-11-19 19:39:13 +02:00
Родитель f37999c009
Коммит e243c2a7f3
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 3650EBE4AA155AF9
21 изменённых файлов: 785 добавлений и 507 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

4
binding/Binding/MathTypes.cs
Просмотреть файл

@ -146,6 +146,10 @@ namespace SkiaSharp
public bool IsEmpty => this == Empty;
public int Length => (int)Math.Sqrt (x * x + y * y);
public int LengthSquared => x * x + y * y;
public void Offset (SKPointI p)
{
x += p.X;

2
docs/xml/FrameworksIndex/skiasharp-1.68.0.xml
Просмотреть файл

@ -2044,6 +2044,8 @@
<Member Id="M:SkiaSharp.SKPointI.ToString" />
<Member Id="M:SkiaSharp.SKPointI.Truncate(SkiaSharp.SKPoint)" />
<Member Id="P:SkiaSharp.SKPointI.IsEmpty" />
<Member Id="P:SkiaSharp.SKPointI.Length" />
<Member Id="P:SkiaSharp.SKPointI.LengthSquared" />
<Member Id="P:SkiaSharp.SKPointI.X" />
<Member Id="P:SkiaSharp.SKPointI.Y" />
</Type>

2
docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml
Просмотреть файл

@ -86,7 +86,7 @@
<param name="glContext">The rendering context in to which the OpenGL content should be rendered.</param>
<param name="pixelFormat">The pixel format used when the context was created.</param>
<param name="timeInterval">The current layer time.</param>
<param name="timeStamp">The display timestamp associated with the time interval. Can be null.</param>
<param name="timeStamp">The display timestamp associated with the time interval. Can be <see langword="null" />.</param>
<summary>Draws the OpenGL content for the specified time.</summary>
<remarks></remarks>
</Docs>

14
docs/xml/SkiaSharp/GRContext.xml
Просмотреть файл

@ -84,7 +84,7 @@
<Docs>
<param name="backend">The backend to use.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context using the default interface for the specified backend.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -112,7 +112,7 @@
<param name="backend">The backend to use.</param>
<param name="backendContext">The backend interface to use.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -145,7 +145,7 @@
<param name="backend">The backend to use.</param>
<param name="backendContext">The backend interface to use.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -174,7 +174,7 @@
<param name="backendContext">The backend interface to use.</param>
<param name="options">The context-creation options.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -203,7 +203,7 @@
<param name="backendContext">The backend interface to use.</param>
<param name="options">The context-creation options.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for a backend context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -222,7 +222,7 @@
<Parameters />
<Docs>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for an OpenGL context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -244,7 +244,7 @@
<Docs>
<param name="backendContext">The OpenGL interface to use.</param>
<summary>Creates a <see cref="T:SkiaSharp.GRContext" /> for an OpenGL context.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise null.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRContext" /> if one was created, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>

26
docs/xml/SkiaSharp/GRGlInterface.xml
Просмотреть файл

@ -41,7 +41,7 @@
<Docs>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -69,7 +69,7 @@
<param name="context">The user data to use in the delegate.</param>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an ANGLE <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -95,7 +95,7 @@
<Docs>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an OpenGL ES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -123,7 +123,7 @@
<param name="context">The user data to use in the delegate.</param>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an OpenGL ES <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -149,7 +149,7 @@
<Docs>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -177,7 +177,7 @@
<param name="context">The user data to use in the delegate.</param>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an OpenGL <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -203,7 +203,7 @@
<Docs>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -231,7 +231,7 @@
<param name="context">The user data to use in the delegate.</param>
<param name="get">The delegate used to locate entry points.</param>
<summary>Assemble an platform-specific <see cref="T:SkiaSharp.GRGlInterface" /> using the specified context and delegate.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -276,7 +276,7 @@
<Parameters />
<Docs>
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform-default OpenGL implementation.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks>On Windows, this is typically ANGLE, on mobile it is typically OpenGL ES and on desktop it is typically OpenGL.</remarks>
</Docs>
</Member>
@ -299,7 +299,7 @@
<Parameters />
<Docs>
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the ANGLE OpenGL implementation.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -322,7 +322,7 @@
<Docs>
<param name="evas">The pointer to the Evas_GL object to use.</param>
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the Evas OpenGL implementation.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -345,7 +345,7 @@
<Parameters />
<Docs>
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform OpenGL implementation.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -371,7 +371,7 @@
<Parameters />
<Docs>
<summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the platform OpenGL implementation.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or <see langword="null" /> if one could not be created.</returns>
<remarks></remarks>
</Docs>
</Member>

18
docs/xml/SkiaSharp/SKBlendMode.xml
Просмотреть файл

@ -16,9 +16,21 @@
<Docs>
<summary>Predefined blend modes.</summary>
<remarks>
<para>Porter Duff Compositing Operators - defined algebra of compositing. These operators control the results of mixing the four sub-pixel regions formed by the overlapping of graphical objects that have an alpha or pixel coverage channel/value.</para>
<para>Separable Blend Mode - each component of the result color is completely determined by the corresponding components of the constituent backdrop and source colors.</para>
<para>Non-Separable Blend Mode - considers all color components in combination as opposed to the separable ones that look at each component individually.</para>
<format type="text/markdown"><![CDATA[
## Remarks
- **Porter Duff Compositing Operators**
Defined algebra of compositing.
These operators control the results of mixing the four sub-pixel regions
formed by the overlapping of graphical objects that have an alpha or
pixel coverage channel/value.
- **Separable Blend Mode**
Each component of the result color is completely determined by the
corresponding components of the constituent backdrop and source colors.
- **Non-Separable Blend Mode**
Considers all color components in combination as opposed to the
separable ones that look at each component individually.
]]></format>
</remarks>
</Docs>
<Members>

12
docs/xml/SkiaSharp/SKCanvas.xml
Просмотреть файл

@ -2340,12 +2340,12 @@ The example above produces the following:
<Parameter Name="paint" Type="SkiaSharp.SKPaint" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="paint">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="text">The text blob to draw.</param>
<param name="x">The x-coordinate of the origin of the text being drawn.</param>
<param name="y">The y-coordinate of the origin of the text being drawn.</param>
<param name="paint">The paint to use when drawing the text.</param>
<summary>Draws a text blob on the canvas at the specified coordinates.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DrawText">

10
docs/xml/SkiaSharp/SKCodec.xml
Просмотреть файл

@ -41,7 +41,7 @@
<Docs>
<param name="data">The data to use when creating the codec.</param>
<summary>Creates a codec from the specified data.</summary>
<returns>Returns the new instance of the codec, or null if there was an error.</returns>
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -67,8 +67,8 @@
<Docs>
<param name="stream">The stream to use when creating the codec.</param>
<summary>Creates a codec from the specified stream.</summary>
<returns>Returns the new instance of the codec, or null if there was an error.</returns>
<remarks>If null is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
@ -91,8 +91,8 @@
<param name="stream">The stream to use when creating the codec.</param>
<param name="result">The result of the creation operation.</param>
<summary>Creates a codec from the specified stream.</summary>
<returns>Returns the new instance of the codec, or null if there was an error.</returns>
<remarks>If null is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
<returns>Returns the new instance of the codec, or <see langword="null" /> if there was an error.</returns>
<remarks>If <see langword="null" /> is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">

82
docs/xml/SkiaSharp/SKDocument.xml
Просмотреть файл

@ -168,10 +168,10 @@ canvas, and then complete the page with a call to
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
<returns>Returns the new PDF-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreatePdf">
@ -190,10 +190,10 @@ canvas, and then complete the page with a call to
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="path">The path of the file to write to.</param>
<summary>Create a PDF-backed document, writing the results into a file.</summary>
<returns>Returns the new PDF-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreatePdf">
@ -266,11 +266,11 @@ canvas, and then complete the page with a call to
<Parameter Name="metadata" Type="SkiaSharp.SKDocumentPdfMetadata" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="metadata">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<param name="metadata">The document metadata to include.</param>
<summary>Create a PDF-backed document with the specified metadata, writing the results into a stream.</summary>
<returns>Returns the new PDF-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreatePdf">
@ -290,11 +290,11 @@ canvas, and then complete the page with a call to
<Parameter Name="dpi" Type="System.Single" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="dpi">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<param name="dpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
<summary>Create a PDF-backed document, writing the results into a stream.</summary>
<returns>Returns the new PDF-backed document.</returns>
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs>
</Member>
<Member MemberName="CreatePdf">
@ -314,11 +314,11 @@ canvas, and then complete the page with a call to
<Parameter Name="metadata" Type="SkiaSharp.SKDocumentPdfMetadata" />
</Parameters>
<Docs>
<param name="path">To be added.</param>
<param name="metadata">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="path">The path of the file to write to.</param>
<param name="metadata">The document metadata to include.</param>
<summary>Create a PDF-backed document with the specified metadata, writing the results into a file.</summary>
<returns>Returns the new PDF-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreatePdf">
@ -401,10 +401,10 @@ canvas, and then complete the page with a call to
<Parameter Name="stream" Type="SkiaSharp.SKWStream" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
<returns>Returns the new XPS-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreateXps">
@ -423,10 +423,10 @@ canvas, and then complete the page with a call to
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
<returns>Returns the new XPS-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreateXps">
@ -445,10 +445,10 @@ canvas, and then complete the page with a call to
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="path">The path of the file to write to.</param>
<summary>Create a XPS-backed document, writing the results into a file.</summary>
<returns>Returns the new XPS-backed document.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreateXps">
@ -496,11 +496,11 @@ canvas, and then complete the page with a call to
<Parameter Name="dpi" Type="System.Single" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="dpi">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">The stream to write to.</param>
<param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
<returns>Returns the new XPS-backed document.</returns>
<remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs>
</Member>
<Member MemberName="CreateXps">
@ -531,7 +531,7 @@ canvas, and then complete the page with a call to
<Docs>
<param name="path">The path of the file to write to.</param>
<param name="dpi">The DPI (pixels-per-inch) at which features without native XPS support will be rasterized.</param>
<summary>Create a XPS-backed document, writing the results into a stream.</summary>
<summary>Create a XPS-backed document, writing the results into a file.</summary>
<returns>Returns the new XPS-backed document.</returns>
<remarks>XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs>

78
docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml
Просмотреть файл

@ -32,9 +32,9 @@
<Parameter Name="encodingQuality" Type="System.Int32" />
</Parameters>
<Docs>
<param name="encodingQuality">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="encodingQuality">The encoding quality.</param>
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified encoding quality.</summary>
<remarks>The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -50,9 +50,9 @@
<Parameter Name="rasterDpi" Type="System.Single" />
</Parameters>
<Docs>
<param name="rasterDpi">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="rasterDpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified raster DPI.</summary>
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -69,10 +69,10 @@
<Parameter Name="encodingQuality" Type="System.Int32" />
</Parameters>
<Docs>
<param name="rasterDpi">To be added.</param>
<param name="encodingQuality">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="rasterDpi">The DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</param>
<param name="encodingQuality">The encoding quality.</param>
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the specified raster DPI and encoding quality.</summary>
<remarks>PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding.</remarks>
</Docs>
</Member>
<Member MemberName="Author">
@ -154,8 +154,8 @@
<ReturnType>SkiaSharp.SKDocumentPdfMetadata</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a new instance of <see cref="T:SkiaSharp.SKDocumentPdfMetadata" /> with the values set to the defaults.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DefaultEncodingQuality">
@ -172,8 +172,8 @@
</ReturnValue>
<MemberValue>101</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets the default encoding quality (101% or lossless).</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DefaultRasterDpi">
@ -190,8 +190,8 @@
</ReturnValue>
<MemberValue>72</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets the default DPI (72.0 DPI).</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EncodingQuality">
@ -207,9 +207,18 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the encoding quality.</summary>
<value></value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Encoding quality controls the trade-off between size and quality. By default
this is set to 101 percent, which corresponds to lossless encoding. If this
value is set to a value <= 100, and the image is opaque, it will be encoded
(using JPEG) with that quality setting.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Keywords">
@ -269,9 +278,17 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets a value indicating whether or not make the document PDF/A-2b conformant.</summary>
<value></value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If true, include XMP metadata, a document UUID, and sRGB output intent
information. This adds length to the document and makes it non-reproducable,
but are necessary features for PDF/A-2b conformance.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Producer">
@ -309,9 +326,20 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the DPI (pixels-per-inch) at which features without native PDF support will be rasterized.</summary>
<value></value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.
A larger DPI would create a PDF that reflects the original intent with better
fidelity, but it can make for larger PDF files too, which would use more
memory while rendering, and it would be slower to be processed or sent online
or to printer.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Subject">

16
docs/xml/SkiaSharp/SKMaskFilter.xml
Просмотреть файл

@ -95,7 +95,7 @@
<param name="blurStyle">The style of blurring.</param>
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
<summary>Creates a mask filter that applies a blur.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -130,7 +130,7 @@
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
<param name="flags">The flags to apply when blurring.</param>
<summary>Creates a mask filter that applies a blur.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -160,7 +160,7 @@
<param name="sigma">The standard deviation (greater than 0) of the Gaussian blur to apply.</param>
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
<summary>Creates a mask filter that applies a blur.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -197,7 +197,7 @@
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
<param name="flags">The flags to apply when blurring.</param>
<summary>Creates a mask filter that applies a blur.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -225,7 +225,7 @@
<param name="occluder">The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object).</param>
<param name="respectCTM">Whether or not the blur's sigma is modified by the CTM.</param>
<summary>Creates a mask filter that applies a blur.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -253,7 +253,7 @@
<param name="min">The minimum alpha value.</param>
<param name="max">The maximum alpha value.</param>
<summary>Creates a mask filter that clips the alpha channel to the specified minimum and maximum alpha values.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -279,7 +279,7 @@
<Docs>
<param name="gamma">The gamma.</param>
<summary>Creates a mask filter that applies gamma.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -305,7 +305,7 @@
<Docs>
<param name="table">The lookup table with exactly 256 elements.</param>
<summary>Creates a mask filter that applies a table lookup on each of the alpha values in the mask.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or null on error.</returns>
<returns>Returns the new <see cref="T:SkiaSharp.SKMaskFilter" />, or <see langword="null" /> on error.</returns>
<remarks></remarks>
</Docs>
</Member>

520
docs/xml/SkiaSharp/SKPaint.xml
Просмотреть файл

@ -466,10 +466,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="ContainsGlyphs">
@ -488,10 +488,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="ContainsGlyphs">
@ -511,11 +511,11 @@ The example above produces the following:
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<summary>Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index.</summary>
<returns>Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface.</returns>
<remarks>This method does not check to see if the text contains invalid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="CountGlyphs">
@ -534,10 +534,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<summary>Returns the number of glyphs in text.</summary>
<returns>Returns the number of glyphs in text.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CountGlyphs">
@ -556,10 +556,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<summary>Returns the number of glyphs in text.</summary>
<returns>Returns the number of glyphs in text.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CountGlyphs">
@ -579,11 +579,11 @@ The example above produces the following:
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<summary>Returns the number of glyphs in text.</summary>
<returns>Returns the number of glyphs in text.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DeviceKerningEnabled">
@ -738,10 +738,10 @@ The example above produces the following:
<Parameter Name="src" Type="SkiaSharp.SKPath" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The source path.</param>
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -761,11 +761,11 @@ The example above produces the following:
<Parameter Name="dst" Type="SkiaSharp.SKPath" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="dst">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The input path.</param>
<param name="dst">The output path.</param>
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -785,11 +785,11 @@ The example above produces the following:
<Parameter Name="cullRect" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="cullRect">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The source path.</param>
<param name="cullRect">The limit to be passed to the path effect.</param>
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -809,11 +809,11 @@ The example above produces the following:
<Parameter Name="resScale" Type="System.Single" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="resScale">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The source path.</param>
<param name="resScale">If &gt; 1, increase precision, else if (0 &lt; res &lt; 1) reduce precision in favor of speed/size.</param>
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -834,12 +834,12 @@ The example above produces the following:
<Parameter Name="cullRect" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="dst">To be added.</param>
<param name="cullRect">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The source path.</param>
<param name="dst">The output path.</param>
<param name="cullRect">The limit to be passed to the path effect.</param>
<summary>Applies any and all effects to a source path, returning the result in the destination.</summary>
<returns>Returns true if the path should be filled, or false if it should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -890,12 +890,12 @@ The example above produces the following:
<Parameter Name="resScale" Type="System.Single" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="cullRect">To be added.</param>
<param name="resScale">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="src">The source path.</param>
<param name="cullRect">The limit to be passed to the path effect.</param>
<param name="resScale">If &gt; 1, increase precision, else if (0 &lt; res &lt; 1) reduce precision in favor of speed/size.</param>
<summary>Creates a new path from the result of applying any and all effects to a source path.</summary>
<returns>Returns the resulting fill path, or null if the source path should be drawn with a hairline.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFillPath">
@ -974,10 +974,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<summary>Converts text into glyph indices.</summary>
<returns>Returns the glyph indices.</returns>
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphs">
@ -996,10 +996,10 @@ The example above produces the following:
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<summary>Converts text into glyph indices.</summary>
<returns>Returns the glyph indices.</returns>
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphs">
@ -1019,11 +1019,11 @@ The example above produces the following:
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<summary>Converts text into glyph indices.</summary>
<returns>Returns the glyph indices.</returns>
<remarks>This method does not check the text for valid character codes or valid glyph indices.</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1042,10 +1042,22 @@ The example above produces the following:
<Parameter Name="text" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<summary>Retrieves the advance for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1064,10 +1076,22 @@ The example above produces the following:
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<summary>Retrieves the advance for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1087,11 +1111,23 @@ The example above produces the following:
<Parameter Name="bounds" Type="SkiaSharp.SKRect[]" RefType="out" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1111,11 +1147,23 @@ The example above produces the following:
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<summary>Retrieves the advance for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1135,11 +1183,23 @@ The example above produces the following:
<Parameter Name="bounds" Type="SkiaSharp.SKRect[]" RefType="out" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidths">
@ -1160,12 +1220,24 @@ The example above produces the following:
<Parameter Name="bounds" Type="SkiaSharp.SKRect[]" RefType="out" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<param name="bounds">The bounds for each glyph relative to (0, 0).</param>
<summary>Retrieves the advance and bounds for each glyph in the text.</summary>
<returns>Returns the text advances for each glyph.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:SkiaSharp.SKPaint.IsVerticalText> is false, this method returns the
horizontal advance. If <xref:SkiaSharp.SKPaint.IsVerticalText> is true, this
method returns the vertical advance.
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize> to scale the widths and bounds.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetHorizontalTextIntercepts">
@ -1188,14 +1260,23 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="xpositions">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetHorizontalTextIntercepts">
@ -1218,14 +1299,23 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="xpositions">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetHorizontalTextIntercepts">
@ -1249,15 +1339,24 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<param name="xpositions">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<param name="xpositions">The positions of each glyph in the horizontal direction.</param>
<param name="y">The positions of all the glyphs along the y-coordinate.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPositionedTextIntercepts">
@ -1279,13 +1378,22 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="positions">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="positions">The positions of each glyph.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPositionedTextIntercepts">
@ -1307,13 +1415,22 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="positions">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<param name="positions">The positions of each glyph.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPositionedTextIntercepts">
@ -1336,14 +1453,23 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<param name="positions">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<param name="positions">The positions of each glyph.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetTextIntercepts">
@ -1364,12 +1490,21 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text blob.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetTextIntercepts">
@ -1392,14 +1527,23 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="x">The x-coordinate of the origin to the text.</param>
<param name="y">The y-coordinate of the origin to the text.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetTextIntercepts">
@ -1422,14 +1566,23 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text.</param>
<param name="x">The x-coordinate of the origin to the text.</param>
<param name="y">The y-coordinate of the origin to the text.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetTextIntercepts">
@ -1453,15 +1606,24 @@ The example above produces the following:
<Parameter Name="lowerBounds" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">To be added.</param>
<param name="length">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="upperBounds">To be added.</param>
<param name="lowerBounds">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="text">The text buffer encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="length">The length of the text buffer.</param>
<param name="x">The x-coordinate of the origin to the text.</param>
<param name="y">The y-coordinate of the origin to the text.</param>
<param name="upperBounds">The upper line parallel to the advance.</param>
<param name="lowerBounds">The lower line parallel to the advance.</param>
<summary>Calculate the intersections of two parallel lines and the glyphs.</summary>
<returns>Returns the intersections of two parallel lines and the glyphs.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Uses <xref:SkiaSharp.SKPaint.TextEncoding> to decode text,
<xref:SkiaSharp.SKPaint.Typeface> to get the font metrics, and
<xref:SkiaSharp.SKPaint.TextSize>, <xref:SkiaSharp.SKPaint.FakeBoldText>
and <xref:SkiaSharp.SKPaint.PathEffect> to scale and modify the glyph paths.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetTextPath">
@ -1485,7 +1647,7 @@ The example above produces the following:
<Parameter Name="points" Type="SkiaSharp.SKPoint[]" />
</Parameters>
<Docs>
<param name="text">The text to generate an outline for.</param>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="points">The position to use for each glyph in the text.</param>
<summary>Returns the path (outline) for the specified text.</summary>
<returns>Returns the <see cref="T:SkiaSharp.SKPath" /> containing the outline of the text.</returns>
@ -1542,7 +1704,7 @@ The example above produces the following:
<Parameter Name="y" Type="System.Single" />
</Parameters>
<Docs>
<param name="text">The text to generate an outline for.</param>
<param name="text">The text encoded using the encoding specified in <see cref="P:SkiaSharp.SKPaint.TextEncoding" /> format.</param>
<param name="x">The x-coordinate of the first glyph in the text.</param>
<param name="y">The y-coordinate of the first glyph in the text.</param>
<summary>Returns the path (outline) for the specified text.</summary>

16
docs/xml/SkiaSharp/SKPaintStyle.xml
Просмотреть файл

@ -16,10 +16,18 @@
<Docs>
<summary>Indications on how to draw geometry.</summary>
<remarks>
<para>Styles apply to rectangle, oval, path, and text. Bitmaps are always drawn in <see cref="F:SkiaSharp.SKPaintStyle.Fill" />, and lines are always drawn in <see cref="F:SkiaSharp.SKPaintStyle.Stroke" />.</para>
<para>
<see cref="F:SkiaSharp.SKPaintStyle.StrokeAndFill" /> implicitly draws the result with <see cref="F:SkiaSharp.SKPathFillType.Winding" /> so if the original path is even-odd, the results may not appear the same as if it was drawn twice, filled and then stroked.</para>
<para></para>
<format type="text/markdown"><![CDATA[
## Remarks
Styles apply to rectangle, oval, path, and text. Bitmaps are always drawn in
<xref:SkiaSharp.SKPaintStyle.Fill>, and lines are always drawn in
<xref:SkiaSharp.SKPaintStyle.Stroke>.
<xref:SkiaSharp.SKPaintStyle.StrokeAndFill> implicitly draws the result with
<xref:SkiaSharp.SKPathFillType.Winding> so if the original path is even-odd,
the results may not appear the same as if it was drawn twice, filled and then
stroked.
]]></format>
</remarks>
</Docs>
<Members>

8
docs/xml/SkiaSharp/SKPath.xml
Просмотреть файл

@ -1259,7 +1259,7 @@ the first point is automatically set to (0, 0).
<Docs>
<summary>Returns the two points of the path.</summary>
<returns>Returns the two points of the path.</returns>
<remarks>If the path is not a single, straight line, then null is returned. See also <see cref="P:SkiaSharp.SKPath.IsLine" />.</remarks>
<remarks>If the path is not a single, straight line, then <see langword="null" /> is returned. See also <see cref="P:SkiaSharp.SKPath.IsLine" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetOvalBounds">
@ -1420,7 +1420,7 @@ the first point is automatically set to (0, 0).
<Docs>
<summary>Returns the round rectangle of the path.</summary>
<returns>Returns the round rectangle of the path.</returns>
<remarks>If the path is not a single round rectangle, then null is returned. See also <see cref="P:SkiaSharp.SKPath.IsRoundRect" />.</remarks>
<remarks>If the path is not a single round rectangle, then <see langword="null" /> is returned. See also <see cref="P:SkiaSharp.SKPath.IsRoundRect" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetTightBounds">
@ -1829,7 +1829,7 @@ the first point is automatically set to (0, 0).
<param name="other">The second operand.</param>
<param name="op">The logical operator.</param>
<summary>Compute the result of a logical operation on two paths.</summary>
<returns>Returns the resulting path if the operation was successful, otherwise null.</returns>
<returns>Returns the resulting path if the operation was successful, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
@ -1885,7 +1885,7 @@ the first point is automatically set to (0, 0).
<Docs>
<param name="svgPath">The SVG path data.</param>
<summary>Creates a path based on the SVG path data string.</summary>
<returns>Returns the new path if successful, otherwise null.</returns>
<returns>Returns the new path if successful, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>

50
docs/xml/SkiaSharp/SKPoint.xml
Просмотреть файл

@ -172,11 +172,11 @@
<Parameter Name="other" Type="SkiaSharp.SKPoint" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The first point.</param>
<param name="other">The second point.</param>
<summary>Calculate the Euclidean distance between two points.</summary>
<returns>Returns the Euclidean distance between two points.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DistanceSquared">
@ -196,11 +196,11 @@
<Parameter Name="other" Type="SkiaSharp.SKPoint" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The first point.</param>
<param name="other">The second point.</param>
<summary>Calculate the Euclidean distance squared between two points.</summary>
<returns>Returns the Euclidean distance squared between two points.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Empty">
@ -308,9 +308,9 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the Euclidean distance from the origin (0, 0).</summary>
<returns></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LengthSquared">
@ -326,9 +326,9 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the Euclidean distance squared from the origin (0, 0).</summary>
<returns></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Normalize">
@ -347,10 +347,10 @@
<Parameter Name="point" Type="SkiaSharp.SKPoint" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The point to normalize.</param>
<summary>Returns a point with the same direction as the specified point, but with a length of one.</summary>
<returns>Returns a point with a length of one.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Offset">
@ -702,11 +702,11 @@
<Parameter Name="normal" Type="SkiaSharp.SKPoint" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="normal">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The point to reflect.</param>
<param name="normal">The normal.</param>
<summary>Returns the reflection of a point off a surface that has the specified normal.</summary>
<returns>Returns the reflection of a point.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Subtract">

74
docs/xml/SkiaSharp/SKPointI.xml
Просмотреть файл

@ -164,11 +164,11 @@
<Parameter Name="other" Type="SkiaSharp.SKPointI" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The first point.</param>
<param name="other">The second point.</param>
<summary>Calculate the Euclidean distance between two points.</summary>
<returns>Returns the Euclidean distance between two points.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DistanceSquared">
@ -188,11 +188,11 @@
<Parameter Name="other" Type="SkiaSharp.SKPointI" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The first point.</param>
<param name="other">The second point.</param>
<summary>Calculate the Euclidean distance squared between two points.</summary>
<returns>Returns the Euclidean distance squared between two points.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Empty">
@ -287,6 +287,42 @@
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public int Length { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Length" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.SKPointI.Length" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the Euclidean distance from the origin (0, 0).</summary>
<returns></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LengthSquared">
<MemberSignature Language="C#" Value="public int LengthSquared { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 LengthSquared" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.SKPointI.LengthSquared" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the Euclidean distance squared from the origin (0, 0).</summary>
<returns></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Normalize">
<MemberSignature Language="C#" Value="public static SkiaSharp.SKPointI Normalize (SkiaSharp.SKPointI point);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype SkiaSharp.SKPointI Normalize(valuetype SkiaSharp.SKPointI point) cil managed" />
@ -303,10 +339,10 @@
<Parameter Name="point" Type="SkiaSharp.SKPointI" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The point to normalize.</param>
<summary>Returns a point with the same direction as the specified point, but with a length of one.</summary>
<returns>Returns a point with a length of one.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Offset">
@ -598,11 +634,11 @@
<Parameter Name="normal" Type="SkiaSharp.SKPointI" />
</Parameters>
<Docs>
<param name="point">To be added.</param>
<param name="normal">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="point">The point to reflect.</param>
<param name="normal">The normal.</param>
<summary>Returns the reflection of a point off a surface that has the specified normal.</summary>
<returns>Returns the reflection of a point.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Round">

8
docs/xml/SkiaSharp/SKRectI.xml
Просмотреть файл

@ -689,10 +689,10 @@
<Parameter Name="rect" Type="SkiaSharp.SKRectI" />
</Parameters>
<Docs>
<param name="rect">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="rect">The rectangle to test.</param>
<summary>Determines if this rectangle intersects with another rectangle.</summary>
<returns>This method returns true if there is any intersection.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsEmpty">

20
docs/xml/SkiaSharp/SKShader.xml
Просмотреть файл

@ -281,8 +281,14 @@ The example above produces the following:
<summary>Creates a new shader that will draw with the specified bitmap.</summary>
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
<remarks>
<para>If the bitmap cannot be used (has no pixels, or its dimensions exceed implementation limits) then an empty shader may be returned. </para>
<para>If the source bitmap's color type is <see cref="F:SkiaSharp.SKColorType.Alpha8" /> then that mask will be colorized using the color on the paint.</para>
<format type="text/markdown"><![CDATA[
## Remarks
If the bitmap cannot be used (has no pixels, or its dimensions exceed
implementation limits) then an empty shader may be returned. If the source
bitmap's color type is <xref:SkiaSharp.SKColorType.Alpha8> then that mask will
be colorized using the color on the paint.
]]></format>
</remarks>
</Docs>
</Member>
@ -316,8 +322,14 @@ The example above produces the following:
<summary>Creates a new shader that will draw with the specified bitmap.</summary>
<returns>Returns a new <see cref="T:SkiaSharp.SKShader" />, or an empty shader on error. This function never returns null.</returns>
<remarks>
<para>If the bitmap cannot be used (has no pixels, or its dimensions exceed implementation limits) then an empty shader may be returned. </para>
<para>If the source bitmap's color type is <see cref="F:SkiaSharp.SKColorType.Alpha8" /> then that mask will be colorized using the color on the paint.</para>
<format type="text/markdown"><![CDATA[
## Remarks
If the bitmap cannot be used (has no pixels, or its dimensions exceed
implementation limits) then an empty shader may be returned. If the source
bitmap's color type is <xref:SkiaSharp.SKColorType.Alpha8> then that mask will
be colorized using the color on the paint.
]]></format>
</remarks>
</Docs>
</Member>

23
docs/xml/SkiaSharp/SKTextBlob.xml
Просмотреть файл

@ -11,8 +11,8 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Represents multiple text runs of glyphs and positions.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName="Bounds">
@ -28,9 +28,9 @@
<ReturnType>SkiaSharp.SKRect</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the conservative blob bounding box.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
@ -49,9 +49,10 @@
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKTextBlob" /> and optionally releases the managed resources.</summary>
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKTextBlob" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
</Docs>
</Member>
<Member MemberName="UniqueId">
@ -67,9 +68,9 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the unique, non-zero value representing the text blob.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
</Members>

291
docs/xml/SkiaSharp/SKTextBlobBuilder.xml
Просмотреть файл

@ -11,8 +11,8 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>A builder object that is used to create a <see cref="T:SkiaSharp.SKTextBlob" />.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -26,8 +26,8 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKTextBlobBuilder" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -49,12 +49,12 @@
<Parameter Name="positions" Type="System.Single[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -77,13 +77,13 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -107,14 +107,14 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -138,14 +138,14 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -170,15 +170,15 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddHorizontalRun">
@ -203,15 +203,15 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="y">The vertical offset within the blob.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The horizontal positions of each glyph.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new horizontally-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -232,11 +232,11 @@
<Parameter Name="positions" Type="SkiaSharp.SKPoint[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -258,12 +258,12 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -286,13 +286,13 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -315,13 +315,13 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -345,14 +345,14 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddPositionedRun">
@ -376,14 +376,14 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="positions">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="positions">The positions of each glyph.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new fully-positioned run to the builder.</summary>
<remarks>The number of positions, characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -405,12 +405,12 @@
<Parameter Name="glyphs" Type="System.UInt16[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -433,13 +433,13 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -463,14 +463,14 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -494,14 +494,14 @@
<Parameter Name="clusters" Type="System.UInt32[]" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -526,15 +526,15 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="utf8Text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="utf8Text">The UTF-8 chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="AddRun">
@ -559,15 +559,15 @@
<Parameter Name="bounds" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="font">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="glyphs">To be added.</param>
<param name="text">To be added.</param>
<param name="clusters">To be added.</param>
<param name="bounds">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="font">The font to be used for this run.</param>
<param name="x">The x-position of the origin of this run.</param>
<param name="y">The y-position of the origin of this run.</param>
<param name="glyphs">The glyphs for this run.</param>
<param name="text">The chacracter information for this run.</param>
<param name="clusters">The glyph's cluster information.</param>
<param name="bounds">The bounding box of the run, used when computing the blob bounds to avoid re-measuring.</param>
<summary>Adds a new deafult-positioned run to the builder.</summary>
<remarks>The number of characters and clusters must be the same as the number of glyphs.</remarks>
</Docs>
</Member>
<Member MemberName="Build">
@ -584,9 +584,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Create the <see cref="T:SkiaSharp.SKTextBlob" /> from all the added runs.</summary>
<returns>Returns the new <see cref="T:SkiaSharp.SKTextBlob" /> if there were runs, otherwise <see langword="null" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
@ -605,9 +605,10 @@
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKTextBlobBuilder" /> and optionally releases the managed resources.</summary>
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKTextBlobBuilder" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
</Docs>
</Member>
</Members>

18
docs/xml/SkiaSharp/SKXferMode.xml
Просмотреть файл

@ -19,9 +19,21 @@
<Docs>
<summary>Predefined blend modes.</summary>
<remarks>
<para>Porter Duff Compositing Operators - defined algebra of compositing. These operators control the results of mixing the four sub-pixel regions formed by the overlapping of graphical objects that have an alpha or pixel coverage channel/value.</para>
<para>Separable Blend Mode - each component of the result color is completely determined by the corresponding components of the constituent backdrop and source colors.</para>
<para>Non-Separable Blend Mode - considers all color components in combination as opposed to the separable ones that look at each component individually.</para>
<format type="text/markdown"><![CDATA[
## Remarks
- **Porter Duff Compositing Operators**
Defined algebra of compositing.
These operators control the results of mixing the four sub-pixel regions
formed by the overlapping of graphical objects that have an alpha or
pixel coverage channel/value.
- **Separable Blend Mode**
Each component of the result color is completely determined by the
corresponding components of the constituent backdrop and source colors.
- **Non-Separable Blend Mode**
Considers all color components in combination as opposed to the
separable ones that look at each component individually.
]]></format>
</remarks>
</Docs>
<Members>