diff --git a/docs/en/SkiaSharp/SKAlphaType.xml b/docs/en/SkiaSharp/SKAlphaType.xml index 30346eac..604ec6f2 100644 --- a/docs/en/SkiaSharp/SKAlphaType.xml +++ b/docs/en/SkiaSharp/SKAlphaType.xml @@ -11,7 +11,7 @@ Describes how to interpret the alpha component of a pixel. - + diff --git a/docs/en/SkiaSharp/SKBitmap.xml b/docs/en/SkiaSharp/SKBitmap.xml index 452a7a3e..fda7a6dd 100644 --- a/docs/en/SkiaSharp/SKBitmap.xml +++ b/docs/en/SkiaSharp/SKBitmap.xml @@ -13,8 +13,8 @@ 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. @@ -29,8 +29,8 @@ 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. + @@ -45,9 +45,9 @@ - To be added. - To be added. - To be added. + Description of the desired image format. + Constructor that configures the bitmap based on an  specification. + 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). @@ -64,8 +64,8 @@ To be added. To be added. - To be added. - To be added. + Constructor that configures the bitmap based on an  specification, and the specified number of bytes per row (the stride size) + 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). @@ -86,8 +86,8 @@ If true, sets the  to Opaque, otherwise it sets it to Premul 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). + @@ -110,7 +110,7 @@ The desired color type. The desired alpha type. Creates a bitmap with the given width, height, color type and alpha type. - To be added. + 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). @@ -124,9 +124,11 @@ SkiaSharp.SKAlphaType - To be added. - To be added. - To be added. + Returns the configured alpha type for the bitmap. + + + + This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied. @@ -225,9 +227,11 @@ - To be added. - To be added. - To be added. + Copies the contents of the bitmap and returns the copy. + The copy of the bitmap, or on error. + + + @@ -244,10 +248,12 @@ - To be added. - To be added. - To be added. - To be added. + The color type to use for the copy of the bitmap. + Copies the contents of the bitmap with the specified color type and returns the copy. + The copy of the bitmap, or  on error. + + + @@ -514,11 +520,33 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + X coordinate + Y coordinate + Returns the color for the pixel at the specified location + Alpha only colortypes return black with the appropriate alpha set.  The value is undefined for the Unknown SkColorType or if x or y are out of bounds, or if the bitmap does not have any pixels (or has not be locked with ) + In most cases this will require un-premultiplying the color.   + + + + + + Method + + 1.0.0.0 + + + System.IntPtr + + + + + + The lenght 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. + + + @@ -580,9 +608,12 @@ System.Boolean - To be added. - To be added. - To be added. + Indicates if the bitmap contents are immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap. + + if it is immutable, otherwise. + + + @@ -617,6 +648,25 @@ To be added. + + + + Method + + 1.0.0.0 + + + System.Void + + + + Call this to ensure that the bitmap points to the current pixel address in the pixelref.  + + This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image. + Balance it with a call to . These calls are harmless if there is no pixelref. + + + @@ -645,8 +695,12 @@ - To be added. - To be added. + + Reset the bitmap to its initial state (see default constructor).  + + + If we are a (shared) owner of the pixels, that ownership is decremented. + @@ -677,8 +731,10 @@ - To be added. - To be added. + 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. + @@ -697,11 +753,30 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + X coordinate + Y coordinat + Color to set + Sets the color of the pixel at a specified location. + This method will set the color of the pixel on the bitmap to the specified  performing any necessary color conversions to the format of the bitmap. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + 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. + + diff --git a/docs/en/SkiaSharp/SKBlurStyle.xml b/docs/en/SkiaSharp/SKBlurStyle.xml index 974b24d0..bac29f02 100644 --- a/docs/en/SkiaSharp/SKBlurStyle.xml +++ b/docs/en/SkiaSharp/SKBlurStyle.xml @@ -11,8 +11,7 @@ Blur types for the  method. - - + diff --git a/docs/en/SkiaSharp/SKColor.xml b/docs/en/SkiaSharp/SKColor.xml index 98a184ed..ad10314f 100644 --- a/docs/en/SkiaSharp/SKColor.xml +++ b/docs/en/SkiaSharp/SKColor.xml @@ -13,7 +13,7 @@ 32 bit ARGB color value, not premultiplied.  The color components are always in a known order.  - + SkColor is the type used to specify colors in SkPaint and in gradients. diff --git a/docs/en/SkiaSharp/SKColorFilter.xml b/docs/en/SkiaSharp/SKColorFilter.xml index 1e2c4ace..68c1a7c0 100644 --- a/docs/en/SkiaSharp/SKColorFilter.xml +++ b/docs/en/SkiaSharp/SKColorFilter.xml @@ -12,8 +12,7 @@ Color filters for use in an . - - + diff --git a/docs/en/SkiaSharp/SKColorType.xml b/docs/en/SkiaSharp/SKColorType.xml index 8cf65375..887a9c49 100644 --- a/docs/en/SkiaSharp/SKColorType.xml +++ b/docs/en/SkiaSharp/SKColorType.xml @@ -11,8 +11,7 @@ Describes how to interpret the components of a pixel. - - + diff --git a/docs/en/SkiaSharp/SKColors.xml b/docs/en/SkiaSharp/SKColors.xml index 6cc3e1d6..710f7dfb 100644 --- a/docs/en/SkiaSharp/SKColors.xml +++ b/docs/en/SkiaSharp/SKColors.xml @@ -12,7 +12,7 @@ Definitions for some common color names. - + diff --git a/docs/en/SkiaSharp/SKCropRectFlags.xml b/docs/en/SkiaSharp/SKCropRectFlags.xml index 6dbe0345..d72c38fe 100644 --- a/docs/en/SkiaSharp/SKCropRectFlags.xml +++ b/docs/en/SkiaSharp/SKCropRectFlags.xml @@ -16,7 +16,7 @@ Flags used by the  method. - + diff --git a/docs/en/SkiaSharp/SKData.xml b/docs/en/SkiaSharp/SKData.xml index 0f756463..d330bfb3 100644 --- a/docs/en/SkiaSharp/SKData.xml +++ b/docs/en/SkiaSharp/SKData.xml @@ -14,8 +14,7 @@ Not only is the data immutable, but the actual pointer that is returned by the  property is guaranteed to always be the same for the life of this instance. The  method can be used to return a  that wraps this SKData and allows for .NET APIs to scan the contents of the SKData as a stream. - - + You can use the constructors for this object to make copies of the data, or you can use the  to wrap a block of memory that has been allocated with the platform malloc function. @@ -49,8 +48,7 @@ Array of bytes that will be copied. Creates an SKData by copying the provided byte array. - - + @@ -70,8 +68,7 @@ Length of the buffer. Creates an SKData by copying the provided byte buffer for the specified length. - - + diff --git a/docs/en/SkiaSharp/SKDropShadowImageFilterShadowMode.xml b/docs/en/SkiaSharp/SKDropShadowImageFilterShadowMode.xml index d070b215..feb92e3d 100644 --- a/docs/en/SkiaSharp/SKDropShadowImageFilterShadowMode.xml +++ b/docs/en/SkiaSharp/SKDropShadowImageFilterShadowMode.xml @@ -13,20 +13,6 @@ To be added. - - - - Field - - 1.0.0.0 - - - SkiaSharp.SKDropShadowImageFilterShadowMode - - - To be added. - - @@ -41,5 +27,19 @@ To be added. + + + + Field + + 1.0.0.0 + + + SkiaSharp.SKDropShadowImageFilterShadowMode + + + To be added. + + diff --git a/docs/en/SkiaSharp/SKImage.xml b/docs/en/SkiaSharp/SKImage.xml index 2f9cde1f..3c90e881 100644 --- a/docs/en/SkiaSharp/SKImage.xml +++ b/docs/en/SkiaSharp/SKImage.xml @@ -13,11 +13,9 @@ Abstraction for drawing a rectangle of pixels. SkImage is an abstraction for drawing a rectagle of pixels, though the particular type of image could be actually storing its data on the GPU, or as drawing commands (picture or PDF or otherwise), ready to be played back into another canvas. - - + The content of SkImage is always immutable, though the actual storage may change, if for example that image can be re-created via encoded data or other means. - - + SkImage always has a non-zero dimensions. If there is a request to create a new image, either directly or via SkSurface, and either of the requested dimensions are zero, then will be returned. @@ -60,6 +58,26 @@ + + + + Method + + 1.0.0.0 + + + SkiaSharp.SKImage + + + + + + Data holding the encoded image. + Creates an SKImage from an encoded image wrapped by the data. + The decoded image, or  on error. + To be added. + + @@ -80,7 +98,7 @@ Creates an SKImage from an encoded image wrapped by the data. The decoded image, or on error. - + diff --git a/docs/en/SkiaSharp/SKPaint.xml b/docs/en/SkiaSharp/SKPaint.xml index d5781261..dd9cb25f 100644 --- a/docs/en/SkiaSharp/SKPaint.xml +++ b/docs/en/SkiaSharp/SKPaint.xml @@ -10,7 +10,7 @@ - The SKPaint class holds the style and color information about how to draw geometries, text and bitmaps. + diff --git a/docs/en/SkiaSharp/SKShader.xml b/docs/en/SkiaSharp/SKShader.xml index 2de13ce7..4bfa53b8 100644 --- a/docs/en/SkiaSharp/SKShader.xml +++ b/docs/en/SkiaSharp/SKShader.xml @@ -13,8 +13,7 @@ Shaders specify the source color(s) for what is being drawn in the . Shaders specify the source color(s) for what is being drawn. If a paint has no shader, then the paint's color is used. If the paint has a shader, then the shader's color(s) are use instead, but they are modulated by the paint's alpha.  - - + This makes it easy to create a shader once (e.g. bitmap tiling or gradient) and then change its transparency w/o having to modify the original shader, only the paint's alpha needs to be modified.