diff --git a/build.cake b/build.cake index 4ac411ff..995da56c 100644 --- a/build.cake +++ b/build.cake @@ -236,6 +236,10 @@ Task ("samples") Task ("docs") .Does (() => { + // log TODOs + var docFiles = FindTextInFiles ("./docs/**/*.xml", "To be added."); + Information ("Documentation missing in {0} files.", docFiles.Length); + if (!DirectoryExists ("./output/docs/msxml/")) CreateDirectory ("./output/docs/msxml/"); RunMdocMSXml (DOCS_PATH, "./output/docs/msxml/"); diff --git a/docs/en/SkiaSharp/GRBackendRenderTargetDesc.xml b/docs/en/SkiaSharp/GRBackendRenderTargetDesc.xml index 0d81d969..346895aa 100644 --- a/docs/en/SkiaSharp/GRBackendRenderTargetDesc.xml +++ b/docs/en/SkiaSharp/GRBackendRenderTargetDesc.xml @@ -33,8 +33,12 @@ The color format. - To be added. - To be added. + + + + + + @@ -51,8 +55,12 @@ The height in pixels. - To be added. - To be added. + + + + + + @@ -69,8 +77,12 @@ The pixel origin. - To be added. - To be added. + + + + + + @@ -86,8 +98,10 @@ System.IntPtr - Handle to the 3D API object. - To be added. + The handle to the 3D API object. + + + When using OpenGL, it is the FBO ID. @@ -105,7 +119,9 @@  The number of samples per pixel. - To be added. + + + This is used to influence decisions about applying other forms of anti-aliasing. @@ -122,9 +138,13 @@ System.Int32 - Number of bits of stencil per-pixel. - To be added. - To be added. + The number of bits of stencil per-pixel. + + + + + + @@ -141,8 +161,12 @@ The width in pixels. - To be added. - To be added. + + + + + + diff --git a/docs/en/SkiaSharp/GRBackendTextureDesc.xml b/docs/en/SkiaSharp/GRBackendTextureDesc.xml index 27c64444..dbd3d299 100644 --- a/docs/en/SkiaSharp/GRBackendTextureDesc.xml +++ b/docs/en/SkiaSharp/GRBackendTextureDesc.xml @@ -34,8 +34,12 @@ The color format. - To be added. - To be added. + + + + + + @@ -70,8 +74,12 @@ The height in pixels. - To be added. - To be added. + + + + + + @@ -88,8 +96,12 @@ The pixel origin. - To be added. - To be added. + + + + + + @@ -106,7 +118,9 @@  The number of samples per pixel. - To be added. + + + If the render target flag is set and sample count is greater than 0, then an MSAA buffer that resolves to the texture will be created. @@ -124,7 +138,9 @@ Handle to the 3D API object. - To be added. + + + When using OpenGL, it is the Texture ID. @@ -142,8 +158,12 @@ The width in pixels. - To be added. - To be added. + + + + + + diff --git a/docs/en/SkiaSharp/GRContext.xml b/docs/en/SkiaSharp/GRContext.xml index a43bcb62..b01ef1a1 100644 --- a/docs/en/SkiaSharp/GRContext.xml +++ b/docs/en/SkiaSharp/GRContext.xml @@ -12,8 +12,10 @@ - To be added. - To be added. + Represents an underlying backend 3D API context. + + + @@ -32,9 +34,9 @@ - To be added. - To be added. - To be added. + Use true to indicate that the underlying 3D context is not yet lost and the  will cleanup all allocated resources before returning. Using false will ensure that the destructors of the  and any of its created resource objects will not make backend 3D API calls. + Abandons all GPU resources and assumes the underlying backend 3D API context is not longer usable. After returning it will assume that the underlying context may no longer be valid. + @@ -53,10 +55,12 @@ - To be added. - Creates a GRContext for a backend context. - To be added. - To be added. + 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. + + + @@ -76,11 +80,13 @@ - To be added. - To be added. - Creates a GRContext for a backend context. - To be added. - To be added. + The backend to use. + The backend interface to use. + Creates a  for a backend context. + Returns the new  if one was created, otherwise null. + + + @@ -100,11 +106,13 @@ - To be added. - To be added. - Creates a GRContext for a backend context. - To be added. - To be added. + The backend to use. + The backend interface to use. + Creates a  for a backend context. + Returns the new  if one was created, otherwise null. + + + @@ -125,12 +133,14 @@ - To be added. - To be added. - To be added. - Creates a GRContext for a backend context. - To be added. - To be added. + The backend to use. + The backend interface to use. + The context-creation options. + Creates a  for a backend context. + Returns the new  if one was created, otherwise null. + + + @@ -151,12 +161,14 @@ - To be added. - To be added. - To be added. - Creates a GRContext for a backend context. - To be added. - To be added. + The backend to use. + The backend interface to use. + The context-creation options. + Creates a  for a backend context. + Returns the new  if one was created, otherwise null. + + + @@ -192,8 +204,10 @@ - To be added. - To be added. + Call to ensure all drawing to the context has been issued to the underlying 3D API. + + + @@ -217,9 +231,11 @@ - Flags that control the flushing behavior. + Flags that control the flushing behavior. (This is ignored) Call to ensure all drawing to the context has been issued to the underlying 3D API. - To be added. + + + @@ -239,11 +255,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The configuration of the render target. + The display density in dots per inch. + Returns the recommended sample count for a render target when using this context. + Returns the recommended sample count. + May return 0 if MSAA is not supported or recommended to be used by default. @@ -263,10 +279,12 @@ - To be added. - To be added. - To be added. - To be added. + The maximum number of resources that can be held in the cache. + The maximum number of bytes of video memory that can be held in the cache. + Returns the current GPU resource cache limits. + + + @@ -286,10 +304,12 @@ - To be added. - To be added. - To be added. - To be added. + The number of resources that are held in the cache. + The total number of bytes of video memory held in the cache. + Returns the current GPU resource cache usage. + + + @@ -309,10 +329,10 @@ - To be added. - To be added. - To be added. - To be added. + The maximum number of resources that can be held in the cache. + The maximum number of bytes of video memory that can be held in the cache. + Specify the GPU resource cache limits. + If the current cache exceeds either of these, it will be purged (LRU) to keep the cache within these limits. diff --git a/docs/en/SkiaSharp/GRContextFlushBits.xml b/docs/en/SkiaSharp/GRContextFlushBits.xml index bbccd6e1..1647170b 100644 --- a/docs/en/SkiaSharp/GRContextFlushBits.xml +++ b/docs/en/SkiaSharp/GRContextFlushBits.xml @@ -16,8 +16,12 @@ - To be added. - To be added. + + + + + + diff --git a/docs/en/SkiaSharp/GRGlInterface.xml b/docs/en/SkiaSharp/GRGlInterface.xml index 990a0d23..160bc105 100644 --- a/docs/en/SkiaSharp/GRGlInterface.xml +++ b/docs/en/SkiaSharp/GRGlInterface.xml @@ -12,8 +12,8 @@ - To be added. - To be added. + The  is used to interface with OpenGL. +  does not interact directly with the underlying backend, instead it uses an OpenGL interface. @@ -32,10 +32,12 @@ - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -55,11 +57,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -78,10 +82,12 @@ - To be added. - To be added. - To be added. - To be added. + The delegate used to locate entry points. + Assemble an OpenGLES  using the specified delegate. + Returns the new , or null if one could not be created. + + + @@ -101,11 +107,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The user data to use in the delegate. + The delegate used to locate entry points. + Assemble an OpenGLES  using the specified context and delegate. + Returns the new , or null if one could not be created. + + + @@ -124,10 +132,12 @@ - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -147,11 +157,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -170,10 +182,12 @@ - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -193,11 +207,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + 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. + + + @@ -214,9 +230,11 @@ - To be added. - To be added. - To be added. + Returns a copy of the current interface. + Returns a copy. + + + @@ -233,9 +251,9 @@ - To be added. - To be added. - To be added. + Create a  using the platform-default OpenGL implementation. + Returns the new , or null if one could not be created. + On Windows, this is typically ANGLE, on mobile it is typically OpenGLES and on desktop it is typically OpenGL. @@ -252,9 +270,11 @@ - To be added. - To be added. - To be added. + Create a  using the ANGLE OpenGL implementation. + Returns the new , or null if one could not be created. + + + @@ -271,9 +291,11 @@ - To be added. - To be added. - To be added. + Create a  using the platform OpenGL implementation. + Returns the new , or null if one could not be created. + + + @@ -295,9 +317,15 @@ - To be added. - To be added. - To be added. + + + + + + + + + @@ -337,10 +365,12 @@ - To be added. - To be added. - To be added. - To be added. + The extension to check for. + Checks to see if the underlying OpenGL backend has the specified extension. + Returns true if the backend has the extension, otherwise false. + + + @@ -357,9 +387,11 @@ - To be added. - To be added. - To be added. + Validates that the  supports its advertised standard. + Returns true if all the entry points are specified, and any required extensions exist. + + + diff --git a/docs/en/SkiaSharp/GRPixelConfig.xml b/docs/en/SkiaSharp/GRPixelConfig.xml index 49b13fde..e2db6069 100644 --- a/docs/en/SkiaSharp/GRPixelConfig.xml +++ b/docs/en/SkiaSharp/GRPixelConfig.xml @@ -11,8 +11,10 @@ System.Enum - To be added. - To be added. + Various pixel configurations supported. + + + @@ -28,7 +30,7 @@ SkiaSharp.GRPixelConfig - To be added. + 8-bit Alpha. @@ -44,7 +46,7 @@ SkiaSharp.GRPixelConfig - To be added. + Single 16-bit float channel. @@ -60,7 +62,7 @@ SkiaSharp.GRPixelConfig - To be added. + 12x12 ASTC Compressed Data. @@ -76,7 +78,7 @@ SkiaSharp.GRPixelConfig - To be added. + Premultiplied 32-bit channel. Byte order is BGRA. @@ -92,7 +94,7 @@ SkiaSharp.GRPixelConfig - To be added. + ETC1 Compressed Data. @@ -108,7 +110,7 @@ SkiaSharp.GRPixelConfig - To be added. + 8-bit indexed color channel. @@ -124,7 +126,7 @@ SkiaSharp.GRPixelConfig - To be added. + LATC/RGTC/3Dc/BC4 Compressed Data. @@ -140,7 +142,7 @@ SkiaSharp.GRPixelConfig - To be added. + R11 EAC Compressed Data. (Corresponds to section C.3.5 of the OpenGL 4.4 core profile spec) @@ -156,7 +158,7 @@ SkiaSharp.GRPixelConfig - To be added. + 16-bit channel. Byte order is RGB. @@ -172,7 +174,7 @@ SkiaSharp.GRPixelConfig - To be added. + Premultiplied 16-bit channel. Byte order is RGBA. @@ -188,7 +190,7 @@ SkiaSharp.GRPixelConfig - To be added. + Premultiplied 32-bit channel. Byte order is RGBA. @@ -204,7 +206,7 @@ SkiaSharp.GRPixelConfig - To be added. + 32-bit channel. Byte order is RGBA. @@ -220,7 +222,7 @@ SkiaSharp.GRPixelConfig - To be added. + 16-bit channel. Byte order is RGBA. @@ -236,7 +238,7 @@ SkiaSharp.GRPixelConfig - To be added. + Premultiplied and sRGB. Byte order is BGRA. @@ -252,7 +254,7 @@ SkiaSharp.GRPixelConfig - To be added. + Premultiplied and sRGB. Byte order is RGBA. @@ -268,7 +270,9 @@ SkiaSharp.GRPixelConfig - To be added. + + + diff --git a/docs/en/SkiaSharp/GRSurfaceOrigin.xml b/docs/en/SkiaSharp/GRSurfaceOrigin.xml index 1383e5e2..84154ac8 100644 --- a/docs/en/SkiaSharp/GRSurfaceOrigin.xml +++ b/docs/en/SkiaSharp/GRSurfaceOrigin.xml @@ -11,8 +11,10 @@ System.Enum - To be added. - To be added. + The origin of a texture. + + + @@ -28,7 +30,7 @@ SkiaSharp.GRSurfaceOrigin - To be added. + Origin is at the bottom-left. @@ -44,7 +46,7 @@ SkiaSharp.GRSurfaceOrigin - To be added. + Origin is at the top-left. diff --git a/docs/en/SkiaSharp/SKAlphaType.xml b/docs/en/SkiaSharp/SKAlphaType.xml index 3e1bc6fb..eb74bd0e 100644 --- a/docs/en/SkiaSharp/SKAlphaType.xml +++ b/docs/en/SkiaSharp/SKAlphaType.xml @@ -16,10 +16,7 @@ Describes how to interpret the alpha component of a pixel. - - - - + @@ -80,7 +77,9 @@ SkiaSharp.SKAlphaType - To be added. + + + diff --git a/docs/en/SkiaSharp/SKAutoCanvasRestore.xml b/docs/en/SkiaSharp/SKAutoCanvasRestore.xml index e03c9926..20e2d824 100644 --- a/docs/en/SkiaSharp/SKAutoCanvasRestore.xml +++ b/docs/en/SkiaSharp/SKAutoCanvasRestore.xml @@ -46,7 +46,7 @@ Determines whether you want the  method to be invoked on your behalf at this point. Creates a canvas restore point - + @@ -69,7 +69,9 @@ Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd.  This operation will not do anything if you had previously manually called the  method. - To be added. + + + @@ -91,7 +93,9 @@ Restores the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd. - To be added. + + + diff --git a/docs/en/SkiaSharp/SKBitmap.xml b/docs/en/SkiaSharp/SKBitmap.xml index 1471cd2a..3878bb26 100644 --- a/docs/en/SkiaSharp/SKBitmap.xml +++ b/docs/en/SkiaSharp/SKBitmap.xml @@ -16,11 +16,10 @@ - Raster bitmap. + The  specifies a raster bitmap. - This class specifies a raster bitmap. A bitmap has an integer width and height, and a format (colortype), and a pointer to the actual pixels. Bitmaps can be drawn into a , but they are also used to specify the target of a ' drawing operations. - An SkBitmap exposes, which lets a caller write its pixels; the constness is considered to apply to the bitmap's configuration, not its contents. - To retrive a pointer to the raw image data of the SKBitmap, call the  method, and then call the  method to get a pointer to the image data.  Once you no longer need to use the raw data pointer, call the  method.   The raw data is laid out in the format configured at the time that the SKBitmap was created. + A bitmap has an integer width and height, and a format (colortype), and a pointer to the actual pixels. Bitmaps can be drawn into a , but they are also used to specify the target of a ' drawing operations. + A  exposes , which lets a caller write its pixels. To retrive a pointer to the raw image data of the bitmap, call the  method, and then call the  method to get a pointer to the image data.  Once you no longer need to use the raw data pointer, call the  method. The raw data is laid out in the format configured at the time that the bitmap was created. @@ -40,11 +39,7 @@ Default construct creates a bitmap with zero width and height, and no pixels. Its colortype is set to  - - This constructor does not allocate a backing store for the bitmap. - - - + This constructor does not allocate a backing store for the bitmap. @@ -84,8 +79,8 @@ - Description of the desired image format. - Color lookup table + The description of the desired image format. + The color lookup table. Constructor that configures the bitmap based on an  specification and a color table. Use this method to create a bitmap that will use a color lookup table.   The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array. @@ -135,13 +130,9 @@ Desired width in pixels. Desired height in pixels. - If true, sets the  to Opaque, otherwise it sets it to Premul + If true, sets the  to , otherwise it sets it to . Creates a bitmap with the given width, height and opacity with color type set to  - - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - + This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). @@ -166,8 +157,8 @@ Desired width in pixels. Desired height in pixels. - The desired color type. - The desired alpha type. + The desired . + The desired . Creates a bitmap with the given width, height, color type and alpha type. This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). @@ -189,11 +180,8 @@ SkiaSharp.SKAlphaType - Returns the configured alpha type for the bitmap. - - - - + Gets the configured  for the bitmap. + The configured . This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied. @@ -214,9 +202,9 @@ System.Int32 - To be added. - To be added. - To be added. + Return the byte size of the pixels, based on the  and . + The byte size of the pixels. + Note: this truncates the result to 32-bits. @@ -236,9 +224,11 @@ System.Byte[] - To be added. - To be added. - To be added. + Gets a copy of all the pixel data as a byte array. + The pixel data. + + + @@ -351,8 +341,7 @@ Copies the contents of the bitmap and returns the copy. The copy of the bitmap, or on error. - - + @@ -964,12 +953,11 @@ - The lenght of the pixel buffer returned. + The length of the pixel buffer returned. Returns the address of the pixels for this SKBitmap - Returns a pointer to the region that contains the pixel data for this bitmap.   This might return if there is no pixel buffer associated with this bitmap. + Returns a pointer to the region that contains the pixel data for this bitmap. This might return if there is no pixel buffer associated with this bitmap. - - + @@ -1060,8 +1048,7 @@ if it is immutable, otherwise. - - + @@ -1223,9 +1210,7 @@ Marks the bitmap as immutable. - - Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref. - + Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref. @@ -1276,11 +1261,7 @@ Call this to balance a previous call to . - - When you are finished access the pixel memory, call this to balance a previous call to . This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image. - - - + When you are finished access the pixel memory, call this to balance a previous call to . This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image. diff --git a/docs/en/SkiaSharp/SKColorType.xml b/docs/en/SkiaSharp/SKColorType.xml index 4036029d..14ea0a20 100644 --- a/docs/en/SkiaSharp/SKColorType.xml +++ b/docs/en/SkiaSharp/SKColorType.xml @@ -16,9 +16,7 @@ Describes how to interpret the components of a pixel. - - - + diff --git a/docs/en/ns-SkiaSharp.xml b/docs/en/ns-SkiaSharp.xml index 6db8683d..d00d48f1 100644 --- a/docs/en/ns-SkiaSharp.xml +++ b/docs/en/ns-SkiaSharp.xml @@ -1,10 +1,6 @@ SkiaSharp is a 2D graphics API powered by the Skia library. - - For information on getting started with the SkiaSharp library, please visit  - - SkiaSharp. - + For information on getting started with the SkiaSharp library, please visit the Xamarin documentation website.