From e243c2a7f36550d1f38199958b66511dbc798feb Mon Sep 17 00:00:00 2001 From: Matthew Leibowitz Date: Mon, 19 Nov 2018 19:39:13 +0200 Subject: [PATCH] Updated the docs --- binding/Binding/MathTypes.cs | 4 + docs/xml/FrameworksIndex/skiasharp-1.68.0.xml | 2 + docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml | 2 +- docs/xml/SkiaSharp/GRContext.xml | 14 +- docs/xml/SkiaSharp/GRGlInterface.xml | 26 +- docs/xml/SkiaSharp/SKBlendMode.xml | 18 +- docs/xml/SkiaSharp/SKCanvas.xml | 12 +- docs/xml/SkiaSharp/SKCodec.xml | 10 +- docs/xml/SkiaSharp/SKDocument.xml | 82 +-- docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml | 78 ++- docs/xml/SkiaSharp/SKMaskFilter.xml | 16 +- docs/xml/SkiaSharp/SKPaint.xml | 520 ++++++++++++------ docs/xml/SkiaSharp/SKPaintStyle.xml | 16 +- docs/xml/SkiaSharp/SKPath.xml | 8 +- docs/xml/SkiaSharp/SKPoint.xml | 50 +- docs/xml/SkiaSharp/SKPointI.xml | 74 ++- docs/xml/SkiaSharp/SKRectI.xml | 8 +- docs/xml/SkiaSharp/SKShader.xml | 20 +- docs/xml/SkiaSharp/SKTextBlob.xml | 23 +- docs/xml/SkiaSharp/SKTextBlobBuilder.xml | 291 +++++----- docs/xml/SkiaSharp/SKXferMode.xml | 18 +- 21 files changed, 785 insertions(+), 507 deletions(-) diff --git a/binding/Binding/MathTypes.cs b/binding/Binding/MathTypes.cs index d6123020..b36ea8d7 100644 --- a/binding/Binding/MathTypes.cs +++ b/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; diff --git a/docs/xml/FrameworksIndex/skiasharp-1.68.0.xml b/docs/xml/FrameworksIndex/skiasharp-1.68.0.xml index 2a9e21c6..720a26c6 100644 --- a/docs/xml/FrameworksIndex/skiasharp-1.68.0.xml +++ b/docs/xml/FrameworksIndex/skiasharp-1.68.0.xml @@ -2044,6 +2044,8 @@ + + diff --git a/docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml b/docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml index 8dd5df2a..cfa7c491 100644 --- a/docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml +++ b/docs/xml/SkiaSharp.Views.Mac/SKGLLayer.xml @@ -86,7 +86,7 @@ The rendering context in to which the OpenGL content should be rendered. The pixel format used when the context was created. The current layer time. - The display timestamp associated with the time interval. Can be null. + The display timestamp associated with the time interval. Can be . Draws the OpenGL content for the specified time. diff --git a/docs/xml/SkiaSharp/GRContext.xml b/docs/xml/SkiaSharp/GRContext.xml index a3d145f4..f701ddf6 100644 --- a/docs/xml/SkiaSharp/GRContext.xml +++ b/docs/xml/SkiaSharp/GRContext.xml @@ -84,7 +84,7 @@ The backend to use. Creates a for a backend context using the default interface for the specified backend. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -112,7 +112,7 @@ The backend to use. The backend interface to use. Creates a for a backend context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -145,7 +145,7 @@ The backend to use. The backend interface to use. Creates a for a backend context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -174,7 +174,7 @@ The backend interface to use. The context-creation options. Creates a for a backend context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -203,7 +203,7 @@ The backend interface to use. The context-creation options. Creates a for a backend context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -222,7 +222,7 @@ Creates a for an OpenGL context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . @@ -244,7 +244,7 @@ The OpenGL interface to use. Creates a for an OpenGL context. - Returns the new if one was created, otherwise null. + Returns the new if one was created, otherwise . diff --git a/docs/xml/SkiaSharp/GRGlInterface.xml b/docs/xml/SkiaSharp/GRGlInterface.xml index 72eafd4c..626ccb58 100644 --- a/docs/xml/SkiaSharp/GRGlInterface.xml +++ b/docs/xml/SkiaSharp/GRGlInterface.xml @@ -41,7 +41,7 @@ The delegate used to locate entry points. Assemble an ANGLE using the specified delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -69,7 +69,7 @@ The user data to use in the delegate. The delegate used to locate entry points. Assemble an ANGLE using the specified context and delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -95,7 +95,7 @@ The delegate used to locate entry points. Assemble an OpenGL ES using the specified delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -123,7 +123,7 @@ The user data to use in the delegate. The delegate used to locate entry points. Assemble an OpenGL ES using the specified context and delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -149,7 +149,7 @@ The delegate used to locate entry points. Assemble an OpenGL using the specified delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -177,7 +177,7 @@ The user data to use in the delegate. The delegate used to locate entry points. Assemble an OpenGL using the specified context and delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -203,7 +203,7 @@ The delegate used to locate entry points. Assemble an platform-specific using the specified delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -231,7 +231,7 @@ The user data to use in the delegate. The delegate used to locate entry points. Assemble an platform-specific using the specified context and delegate. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -276,7 +276,7 @@ Create a using the platform-default OpenGL implementation. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. On Windows, this is typically ANGLE, on mobile it is typically OpenGL ES and on desktop it is typically OpenGL. @@ -299,7 +299,7 @@ Create a using the ANGLE OpenGL implementation. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -322,7 +322,7 @@ The pointer to the Evas_GL object to use. Create a using the Evas OpenGL implementation. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -345,7 +345,7 @@ Create a using the platform OpenGL implementation. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. @@ -371,7 +371,7 @@ Create a using the platform OpenGL implementation. - Returns the new , or null if one could not be created. + Returns the new , or if one could not be created. diff --git a/docs/xml/SkiaSharp/SKBlendMode.xml b/docs/xml/SkiaSharp/SKBlendMode.xml index 645ddc2b..cf7e3e9f 100644 --- a/docs/xml/SkiaSharp/SKBlendMode.xml +++ b/docs/xml/SkiaSharp/SKBlendMode.xml @@ -16,9 +16,21 @@ Predefined blend modes. - 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. + diff --git a/docs/xml/SkiaSharp/SKCanvas.xml b/docs/xml/SkiaSharp/SKCanvas.xml index e85f7917..60c813cb 100644 --- a/docs/xml/SkiaSharp/SKCanvas.xml +++ b/docs/xml/SkiaSharp/SKCanvas.xml @@ -2340,12 +2340,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text blob to draw. + The x-coordinate of the origin of the text being drawn. + The y-coordinate of the origin of the text being drawn. + The paint to use when drawing the text. + Draws a text blob on the canvas at the specified coordinates. + diff --git a/docs/xml/SkiaSharp/SKCodec.xml b/docs/xml/SkiaSharp/SKCodec.xml index 60dfa321..5be49e37 100644 --- a/docs/xml/SkiaSharp/SKCodec.xml +++ b/docs/xml/SkiaSharp/SKCodec.xml @@ -41,7 +41,7 @@ The data to use when creating the codec. Creates a codec from the specified data. - Returns the new instance of the codec, or null if there was an error. + Returns the new instance of the codec, or if there was an error. @@ -67,8 +67,8 @@ The stream to use when creating the codec. Creates a codec from the specified stream. - Returns the new instance of the codec, or null if there was an error. - If null is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. + Returns the new instance of the codec, or if there was an error. + If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. @@ -91,8 +91,8 @@ The stream to use when creating the codec. The result of the creation operation. Creates a codec from the specified stream. - Returns the new instance of the codec, or null if there was an error. - If null is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. + Returns the new instance of the codec, or if there was an error. + If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. diff --git a/docs/xml/SkiaSharp/SKDocument.xml b/docs/xml/SkiaSharp/SKDocument.xml index 0f7b50ad..d9f06fd7 100644 --- a/docs/xml/SkiaSharp/SKDocument.xml +++ b/docs/xml/SkiaSharp/SKDocument.xml @@ -168,10 +168,10 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. + The stream to write to. + Create a PDF-backed document, writing the results into a stream. + Returns the new PDF-backed document. + @@ -190,10 +190,10 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. + The path of the file to write to. + Create a PDF-backed document, writing the results into a file. + Returns the new PDF-backed document. + @@ -266,11 +266,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write to. + The document metadata to include. + Create a PDF-backed document with the specified metadata, writing the results into a stream. + Returns the new PDF-backed document. + @@ -290,11 +290,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write to. + The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. + Create a PDF-backed document, writing the results into a stream. + Returns the new PDF-backed document. + PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. @@ -314,11 +314,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The path of the file to write to. + The document metadata to include. + Create a PDF-backed document with the specified metadata, writing the results into a file. + Returns the new PDF-backed document. + @@ -401,10 +401,10 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. + The stream to write to. + Create a XPS-backed document, writing the results into a stream. + Returns the new XPS-backed document. + @@ -423,10 +423,10 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. + The stream to write to. + Create a XPS-backed document, writing the results into a stream. + Returns the new XPS-backed document. + @@ -445,10 +445,10 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. + The path of the file to write to. + Create a XPS-backed document, writing the results into a file. + Returns the new XPS-backed document. + @@ -496,11 +496,11 @@ canvas, and then complete the page with a call to - To be added. - To be added. - To be added. - To be added. - To be added. + The stream to write to. + The DPI (pixels-per-inch) at which features without native XPS support will be rasterized. + Create a XPS-backed document, writing the results into a stream. + Returns the new XPS-backed document. + XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. @@ -531,7 +531,7 @@ canvas, and then complete the page with a call to The path of the file to write to. The DPI (pixels-per-inch) at which features without native XPS support will be rasterized. - Create a XPS-backed document, writing the results into a stream. + Create a XPS-backed document, writing the results into a file. Returns the new XPS-backed document. XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. diff --git a/docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml b/docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml index 755b9215..7e03cc2d 100644 --- a/docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml +++ b/docs/xml/SkiaSharp/SKDocumentPdfMetadata.xml @@ -32,9 +32,9 @@ - To be added. - To be added. - To be added. + The encoding quality. + Creates a new instance of with the specified encoding quality. + The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding. @@ -50,9 +50,9 @@ - To be added. - To be added. - To be added. + The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. + Creates a new instance of with the specified raster DPI. + PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. @@ -69,10 +69,10 @@ - To be added. - To be added. - To be added. - To be added. + The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. + The encoding quality. + Creates a new instance of with the specified raster DPI and encoding quality. + 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. @@ -154,8 +154,8 @@ SkiaSharp.SKDocumentPdfMetadata - To be added. - To be added. + Gets a new instance of with the values set to the defaults. + @@ -172,8 +172,8 @@ 101 - To be added. - To be added. + Gets the default encoding quality (101% or lossless). + @@ -190,8 +190,8 @@ 72 - To be added. - To be added. + Gets the default DPI (72.0 DPI). + @@ -207,9 +207,18 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the encoding quality. + + + + @@ -269,9 +278,17 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value indicating whether or not make the document PDF/A-2b conformant. + + + + @@ -309,9 +326,20 @@ System.Single - To be added. - To be added. - To be added. + Gets or sets the DPI (pixels-per-inch) at which features without native PDF support will be rasterized. + + + + diff --git a/docs/xml/SkiaSharp/SKMaskFilter.xml b/docs/xml/SkiaSharp/SKMaskFilter.xml index b2c7ac54..72e790e1 100644 --- a/docs/xml/SkiaSharp/SKMaskFilter.xml +++ b/docs/xml/SkiaSharp/SKMaskFilter.xml @@ -95,7 +95,7 @@ The style of blurring. The standard deviation (greater than 0) of the Gaussian blur to apply. Creates a mask filter that applies a blur. - Returns the new , or null on error. + Returns the new , or on error. @@ -130,7 +130,7 @@ The standard deviation (greater than 0) of the Gaussian blur to apply. The flags to apply when blurring. Creates a mask filter that applies a blur. - Returns the new , or null on error. + Returns the new , or on error. @@ -160,7 +160,7 @@ The standard deviation (greater than 0) of the Gaussian blur to apply. The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). Creates a mask filter that applies a blur. - Returns the new , or null on error. + Returns the new , or on error. @@ -197,7 +197,7 @@ The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). The flags to apply when blurring. Creates a mask filter that applies a blur. - Returns the new , or null on error. + Returns the new , or on error. @@ -225,7 +225,7 @@ The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). Whether or not the blur's sigma is modified by the CTM. Creates a mask filter that applies a blur. - Returns the new , or null on error. + Returns the new , or on error. @@ -253,7 +253,7 @@ The minimum alpha value. The maximum alpha value. Creates a mask filter that clips the alpha channel to the specified minimum and maximum alpha values. - Returns the new , or null on error. + Returns the new , or on error. @@ -279,7 +279,7 @@ The gamma. Creates a mask filter that applies gamma. - Returns the new , or null on error. + Returns the new , or on error. @@ -305,7 +305,7 @@ The lookup table with exactly 256 elements. Creates a mask filter that applies a table lookup on each of the alpha values in the mask. - Returns the new , or null on error. + Returns the new , or on error. diff --git a/docs/xml/SkiaSharp/SKPaint.xml b/docs/xml/SkiaSharp/SKPaint.xml index aaf8a675..0491987a 100644 --- a/docs/xml/SkiaSharp/SKPaint.xml +++ b/docs/xml/SkiaSharp/SKPaint.xml @@ -466,10 +466,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. + 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. + This method does not check to see if the text contains invalid glyph indices. @@ -488,10 +488,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text. + Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. + 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. + This method does not check to see if the text contains invalid glyph indices. @@ -511,11 +511,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. + 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. + This method does not check to see if the text contains invalid glyph indices. @@ -534,10 +534,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + Returns the number of glyphs in text. + Returns the number of glyphs in text. + @@ -556,10 +556,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text. + Returns the number of glyphs in text. + Returns the number of glyphs in text. + @@ -579,11 +579,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + Returns the number of glyphs in text. + Returns the number of glyphs in text. + @@ -738,10 +738,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The source path. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or null if the source path should be drawn with a hairline. + @@ -761,11 +761,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The input path. + The output path. + Applies any and all effects to a source path, returning the result in the destination. + Returns true if the path should be filled, or false if it should be drawn with a hairline. + @@ -785,11 +785,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The limit to be passed to the path effect. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or null if the source path should be drawn with a hairline. + @@ -809,11 +809,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or null if the source path should be drawn with a hairline. + @@ -834,12 +834,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The output path. + The limit to be passed to the path effect. + Applies any and all effects to a source path, returning the result in the destination. + Returns true if the path should be filled, or false if it should be drawn with a hairline. + @@ -890,12 +890,12 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The source path. + The limit to be passed to the path effect. + If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. + Creates a new path from the result of applying any and all effects to a source path. + Returns the resulting fill path, or null if the source path should be drawn with a hairline. + @@ -974,10 +974,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + Converts text into glyph indices. + Returns the glyph indices. + This method does not check the text for valid character codes or valid glyph indices. @@ -996,10 +996,10 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text. + Converts text into glyph indices. + Returns the glyph indices. + This method does not check the text for valid character codes or valid glyph indices. @@ -1019,11 +1019,11 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + Converts text into glyph indices. + Returns the glyph indices. + This method does not check the text for valid character codes or valid glyph indices. @@ -1042,10 +1042,22 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + Retrieves the advance for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths. +]]> + @@ -1064,10 +1076,22 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. + The text. + Retrieves the advance for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths. +]]> + @@ -1087,11 +1111,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + The bounds for each glyph relative to (0, 0). + Retrieves the advance and bounds for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths and bounds. +]]> + @@ -1111,11 +1147,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + Retrieves the advance for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths. +]]> + @@ -1135,11 +1183,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. + The text. + The bounds for each glyph relative to (0, 0). + Retrieves the advance and bounds for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths and bounds. +]]> + @@ -1160,12 +1220,24 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + The bounds for each glyph relative to (0, 0). + Retrieves the advance and bounds for each glyph in the text. + Returns the text advances for each glyph. + + is false, this method returns the +horizontal advance. If is true, this +method returns the vertical advance. + +Uses to decode text, + to get the font metrics, and + to scale the widths and bounds. +]]> + @@ -1188,14 +1260,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + The positions of each glyph in the horizontal direction. + The positions of all the glyphs along the y-coordinate. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1218,14 +1299,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text. + The positions of each glyph in the horizontal direction. + The positions of all the glyphs along the y-coordinate. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1249,15 +1339,24 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + The positions of each glyph in the horizontal direction. + The positions of all the glyphs along the y-coordinate. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1279,13 +1378,22 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + The positions of each glyph. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1307,13 +1415,22 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text. + The positions of each glyph. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1336,14 +1453,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + The positions of each glyph. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1364,12 +1490,21 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text blob. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1392,14 +1527,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text encoded using the encoding specified in format. + The x-coordinate of the origin to the text. + The y-coordinate of the origin to the text. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1422,14 +1566,23 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text. + The x-coordinate of the origin to the text. + The y-coordinate of the origin to the text. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1453,15 +1606,24 @@ The example above produces the following: - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The text buffer encoded using the encoding specified in format. + The length of the text buffer. + The x-coordinate of the origin to the text. + The y-coordinate of the origin to the text. + The upper line parallel to the advance. + The lower line parallel to the advance. + Calculate the intersections of two parallel lines and the glyphs. + Returns the intersections of two parallel lines and the glyphs. + + to decode text, + to get the font metrics, and +, +and to scale and modify the glyph paths. +]]> + @@ -1485,7 +1647,7 @@ The example above produces the following: - The text to generate an outline for. + The text encoded using the encoding specified in format. The position to use for each glyph in the text. Returns the path (outline) for the specified text. Returns the containing the outline of the text. @@ -1542,7 +1704,7 @@ The example above produces the following: - The text to generate an outline for. + The text encoded using the encoding specified in format. The x-coordinate of the first glyph in the text. The y-coordinate of the first glyph in the text. Returns the path (outline) for the specified text. diff --git a/docs/xml/SkiaSharp/SKPaintStyle.xml b/docs/xml/SkiaSharp/SKPaintStyle.xml index 50e557dc..12aa3ca1 100644 --- a/docs/xml/SkiaSharp/SKPaintStyle.xml +++ b/docs/xml/SkiaSharp/SKPaintStyle.xml @@ -16,10 +16,18 @@ Indications on how to draw geometry. - Styles apply to rectangle, oval, path, and text. Bitmaps are always drawn in , and lines are always drawn in . - - implicitly draws the result with 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. - + , and lines are always drawn in +. + + implicitly draws the result with + 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. +]]> diff --git a/docs/xml/SkiaSharp/SKPath.xml b/docs/xml/SkiaSharp/SKPath.xml index 6334a0ac..ecd81df0 100644 --- a/docs/xml/SkiaSharp/SKPath.xml +++ b/docs/xml/SkiaSharp/SKPath.xml @@ -1259,7 +1259,7 @@ the first point is automatically set to (0, 0). Returns the two points of the path. Returns the two points of the path. - If the path is not a single, straight line, then null is returned. See also . + If the path is not a single, straight line, then is returned. See also . @@ -1420,7 +1420,7 @@ the first point is automatically set to (0, 0). Returns the round rectangle of the path. Returns the round rectangle of the path. - If the path is not a single round rectangle, then null is returned. See also . + If the path is not a single round rectangle, then is returned. See also . @@ -1829,7 +1829,7 @@ the first point is automatically set to (0, 0). The second operand. The logical operator. Compute the result of a logical operation on two paths. - Returns the resulting path if the operation was successful, otherwise null. + Returns the resulting path if the operation was successful, otherwise . @@ -1885,7 +1885,7 @@ the first point is automatically set to (0, 0). The SVG path data. Creates a path based on the SVG path data string. - Returns the new path if successful, otherwise null. + Returns the new path if successful, otherwise . diff --git a/docs/xml/SkiaSharp/SKPoint.xml b/docs/xml/SkiaSharp/SKPoint.xml index 7be7367c..4cf20599 100644 --- a/docs/xml/SkiaSharp/SKPoint.xml +++ b/docs/xml/SkiaSharp/SKPoint.xml @@ -172,11 +172,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first point. + The second point. + Calculate the Euclidean distance between two points. + Returns the Euclidean distance between two points. + @@ -196,11 +196,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first point. + The second point. + Calculate the Euclidean distance squared between two points. + Returns the Euclidean distance squared between two points. + @@ -308,9 +308,9 @@ System.Single - To be added. - To be added. - To be added. + Gets the Euclidean distance from the origin (0, 0). + + @@ -326,9 +326,9 @@ System.Single - To be added. - To be added. - To be added. + Gets the Euclidean distance squared from the origin (0, 0). + + @@ -347,10 +347,10 @@ - To be added. - To be added. - To be added. - To be added. + The point to normalize. + Returns a point with the same direction as the specified point, but with a length of one. + Returns a point with a length of one. + @@ -702,11 +702,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The point to reflect. + The normal. + Returns the reflection of a point off a surface that has the specified normal. + Returns the reflection of a point. + diff --git a/docs/xml/SkiaSharp/SKPointI.xml b/docs/xml/SkiaSharp/SKPointI.xml index 2e329ec3..034b08b0 100644 --- a/docs/xml/SkiaSharp/SKPointI.xml +++ b/docs/xml/SkiaSharp/SKPointI.xml @@ -164,11 +164,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first point. + The second point. + Calculate the Euclidean distance between two points. + Returns the Euclidean distance between two points. + @@ -188,11 +188,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first point. + The second point. + Calculate the Euclidean distance squared between two points. + Returns the Euclidean distance squared between two points. + @@ -287,6 +287,42 @@ + + + + + Property + + SkiaSharp + 1.68.0.0 + + + System.Int32 + + + Gets the Euclidean distance from the origin (0, 0). + + + + + + + + + Property + + SkiaSharp + 1.68.0.0 + + + System.Int32 + + + Gets the Euclidean distance squared from the origin (0, 0). + + + + @@ -303,10 +339,10 @@ - To be added. - To be added. - To be added. - To be added. + The point to normalize. + Returns a point with the same direction as the specified point, but with a length of one. + Returns a point with a length of one. + @@ -598,11 +634,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The point to reflect. + The normal. + Returns the reflection of a point off a surface that has the specified normal. + Returns the reflection of a point. + diff --git a/docs/xml/SkiaSharp/SKRectI.xml b/docs/xml/SkiaSharp/SKRectI.xml index 83a3baa0..b04a0c97 100644 --- a/docs/xml/SkiaSharp/SKRectI.xml +++ b/docs/xml/SkiaSharp/SKRectI.xml @@ -689,10 +689,10 @@ - To be added. - To be added. - To be added. - To be added. + The rectangle to test. + Determines if this rectangle intersects with another rectangle. + This method returns true if there is any intersection. + diff --git a/docs/xml/SkiaSharp/SKShader.xml b/docs/xml/SkiaSharp/SKShader.xml index 555fa505..94d2f50a 100644 --- a/docs/xml/SkiaSharp/SKShader.xml +++ b/docs/xml/SkiaSharp/SKShader.xml @@ -281,8 +281,14 @@ The example above produces the following: Creates a new shader that will draw with the specified bitmap. Returns a new , or an empty shader on error. This function never returns null. - 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 then that mask will be colorized using the color on the paint. + then that mask will +be colorized using the color on the paint. +]]> @@ -316,8 +322,14 @@ The example above produces the following: Creates a new shader that will draw with the specified bitmap. Returns a new , or an empty shader on error. This function never returns null. - 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 then that mask will be colorized using the color on the paint. + then that mask will +be colorized using the color on the paint. +]]> diff --git a/docs/xml/SkiaSharp/SKTextBlob.xml b/docs/xml/SkiaSharp/SKTextBlob.xml index dc0dbd15..d282591f 100644 --- a/docs/xml/SkiaSharp/SKTextBlob.xml +++ b/docs/xml/SkiaSharp/SKTextBlob.xml @@ -11,8 +11,8 @@ - To be added. - To be added. + Represents multiple text runs of glyphs and positions. + @@ -28,9 +28,9 @@ SkiaSharp.SKRect - To be added. - To be added. - To be added. + Gets the conservative blob bounding box. + + @@ -49,9 +49,10 @@ - To be added. - To be added. - To be added. + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. @@ -67,9 +68,9 @@ System.UInt32 - To be added. - To be added. - To be added. + Gets the unique, non-zero value representing the text blob. + + diff --git a/docs/xml/SkiaSharp/SKTextBlobBuilder.xml b/docs/xml/SkiaSharp/SKTextBlobBuilder.xml index 87de99bc..30ebdf82 100644 --- a/docs/xml/SkiaSharp/SKTextBlobBuilder.xml +++ b/docs/xml/SkiaSharp/SKTextBlobBuilder.xml @@ -11,8 +11,8 @@ - To be added. - To be added. + A builder object that is used to create a . + @@ -26,8 +26,8 @@ - To be added. - To be added. + Creates a new instance of . + @@ -49,12 +49,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + Adds a new horizontally-positioned run to the builder. + The number of positions must be the same as the number of glyphs. @@ -77,13 +77,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new horizontally-positioned run to the builder. + The number of positions must be the same as the number of glyphs. @@ -107,14 +107,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + Adds a new horizontally-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -138,14 +138,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + The chacracter information for this run. + The glyph's cluster information. + Adds a new horizontally-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -170,15 +170,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new horizontally-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -203,15 +203,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The vertical offset within the blob. + The glyphs for this run. + The horizontal positions of each glyph. + The chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new horizontally-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -232,11 +232,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + Adds a new fully-positioned run to the builder. + The number of positions must be the same as the number of glyphs. @@ -258,12 +258,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new fully-positioned run to the builder. + The number of positions must be the same as the number of glyphs. @@ -286,13 +286,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + Adds a new fully-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -315,13 +315,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + The chacracter information for this run. + The glyph's cluster information. + Adds a new fully-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -345,14 +345,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new fully-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -376,14 +376,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The glyphs for this run. + The positions of each glyph. + The chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new fully-positioned run to the builder. + The number of positions, characters and clusters must be the same as the number of glyphs. @@ -405,12 +405,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + Adds a new deafult-positioned run to the builder. + @@ -433,13 +433,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new deafult-positioned run to the builder. + @@ -463,14 +463,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + Adds a new deafult-positioned run to the builder. + The number of characters and clusters must be the same as the number of glyphs. @@ -494,14 +494,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + The chacracter information for this run. + The glyph's cluster information. + Adds a new deafult-positioned run to the builder. + The number of characters and clusters must be the same as the number of glyphs. @@ -526,15 +526,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + The UTF-8 chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new deafult-positioned run to the builder. + The number of characters and clusters must be the same as the number of glyphs. @@ -559,15 +559,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The font to be used for this run. + The x-position of the origin of this run. + The y-position of the origin of this run. + The glyphs for this run. + The chacracter information for this run. + The glyph's cluster information. + The bounding box of the run, used when computing the blob bounds to avoid re-measuring. + Adds a new deafult-positioned run to the builder. + The number of characters and clusters must be the same as the number of glyphs. @@ -584,9 +584,9 @@ - To be added. - To be added. - To be added. + Create the from all the added runs. + Returns the new if there were runs, otherwise . + @@ -605,9 +605,10 @@ - To be added. - To be added. - To be added. + + to release both managed and unmanaged resources; to release only unmanaged resources. + Releases the unmanaged resources used by the and optionally releases the managed resources. + Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. diff --git a/docs/xml/SkiaSharp/SKXferMode.xml b/docs/xml/SkiaSharp/SKXferMode.xml index 397ac345..76ec6038 100644 --- a/docs/xml/SkiaSharp/SKXferMode.xml +++ b/docs/xml/SkiaSharp/SKXferMode.xml @@ -19,9 +19,21 @@ Predefined blend modes. - 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. +