From 63d4e50dfe7455def8eb049fef6d421ae383069f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Cant=C3=BA?= Date: Wed, 4 Sep 2024 12:08:41 -0500 Subject: [PATCH 1/3] Add missing to AppendAllBytesAsync (#10353) Contributes to https://github.com/dotnet/runtime/issues/105979#issuecomment-2303263131 --- xml/System.IO/File.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index 723dcb8d453..d6687e419a6 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -295,7 +295,7 @@ Asynchronously appends the specified byte array to the end of the file at the given path. If the file doesn't exist, this method creates a new file. If the operation is canceled, the task will return in a canceled state. - To be added. + A task that represents the asynchronous append operation. To be added. or is . @@ -346,7 +346,7 @@ If the file doesn't exist, this method creates a new file. If the operation is canceled, the task will return in a canceled state. To be added. - To be added. + A task that represents the asynchronous append operation. is . From 34d0fe10d9158a7438fac2281578498e577b7938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Cant=C3=BA?= Date: Wed, 4 Sep 2024 14:38:47 -0500 Subject: [PATCH 2/3] Add missing docs to FileStream.CopyTo(Stream, int) (#10362) Contributes to https://github.com/dotnet/runtime/issues/105979#issuecomment-2303263131. --- xml/System.IO/FileStream.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.IO/FileStream.xml b/xml/System.IO/FileStream.xml index 9554acde241..727fbc7ed45 100644 --- a/xml/System.IO/FileStream.xml +++ b/xml/System.IO/FileStream.xml @@ -2215,10 +2215,10 @@ See for more informat - To be added. - To be added. - To be added. - To be added. + The stream to which the contents of the current stream will be copied. + The size of the buffer. This value must be greater than zero. + Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. + Copying begins at the current position in the current stream, and does not reset the position of the destination stream after the copy operation is complete. @@ -2259,7 +2259,7 @@ See for more informat The stream to which the contents of the current file stream will be copied. - The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920. + The size, in bytes, of the buffer. This value must be greater than zero. The token to monitor for cancellation requests. The default value is . Asynchronously reads the bytes from the current file stream and writes them to another stream, using a specified buffer size and cancellation token. A task that represents the asynchronous copy operation. From c98899a308cfbb8af30d3a94793e44c194a21b97 Mon Sep 17 00:00:00 2001 From: Loni Tra Date: Wed, 4 Sep 2024 15:58:55 -0700 Subject: [PATCH 3/3] Port System.Drawing docs for .NET 9 (#10243) * Port System.Drawing 9.0 docs * update docs based on feedback * missed a couple more feedback comments * fix issues * issue fix * fix GraphicsPath.Warp * rerun porting tool * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * additional updates based on feedback * Update xml/System.Drawing.Imaging/DitherType.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Drawing.Drawing2D/GraphicsPath.xml | 86 ++++- .../GraphicsPathIterator.xml | 3 + xml/System.Drawing.Drawing2D/Matrix.xml | 7 + .../PathGradientBrush.xml | 6 + .../PathPointType.xml | 1 + .../BlackSaturationCurveEffect.xml | 25 +- .../BlurEffect.xml | 25 +- .../BrightnessContrastEffect.xml | 34 +- .../ColorBalanceEffect.xml | 60 ++- .../ColorCurveEffect.xml | 4 +- .../ColorLookupTableEffect.xml | 24 +- .../ColorMatrixEffect.xml | 21 +- .../ContrastCurveEffect.xml | 19 +- .../CurveChannel.xml | 10 +- .../DensityCurveEffect.xml | 18 +- xml/System.Drawing.Imaging.Effects/Effect.xml | 2 +- .../ExposureCurveEffect.xml | 22 +- .../GrayScaleEffect.xml | 2 +- .../HighlightCurveEffect.xml | 25 +- .../InvertEffect.xml | 2 +- .../LevelsEffect.xml | 52 ++- .../MidtoneCurveEffect.xml | 32 +- .../SepiaEffect.xml | 2 +- .../ShadowCurveEffect.xml | 27 +- .../SharpenEffect.xml | 35 +- .../TintEffect.xml | 35 +- .../VividEffect.xml | 2 +- .../WhiteSaturationCurveEffect.xml | 30 +- xml/System.Drawing.Imaging/ColorMatrix.xml | 4 +- xml/System.Drawing.Imaging/ColorPalette.xml | 20 +- xml/System.Drawing.Imaging/DitherType.xml | 40 +- .../ImageAttributes.xml | 11 +- xml/System.Drawing.Imaging/PaletteType.xml | 54 ++- xml/System.Drawing.Imaging/PixelFormat.xml | 3 + xml/System.Drawing/Bitmap.xml | 55 ++- xml/System.Drawing/Graphics.xml | 68 +++- xml/System.Drawing/Icon.xml | 345 +++++++++--------- xml/System.Drawing/SystemIcons.xml | 41 +-- 38 files changed, 841 insertions(+), 411 deletions(-) diff --git a/xml/System.Drawing.Drawing2D/GraphicsPath.xml b/xml/System.Drawing.Drawing2D/GraphicsPath.xml index 08bb66edde4..d46ff629690 100644 --- a/xml/System.Drawing.Drawing2D/GraphicsPath.xml +++ b/xml/System.Drawing.Drawing2D/GraphicsPath.xml @@ -117,6 +117,7 @@ Initializes a new instance of the class with a value of . To be added. + @@ -150,6 +151,7 @@ The enumeration that determines how the interior of this is filled. Initializes a new instance of the class with the specified enumeration. To be added. + @@ -191,6 +193,7 @@ An array of enumeration elements that specifies the type of each corresponding point in the array. Initializes a new instance of the class with the specified and arrays. To be added. + @@ -232,6 +235,7 @@ An array of enumeration elements that specifies the type of each corresponding point in the array. Initializes a new instance of the array with the specified and arrays. To be added. + @@ -306,6 +310,7 @@ A enumeration that specifies how the interiors of shapes in this are filled. Initializes a new instance of the array with the specified and arrays and with the specified enumeration element. To be added. + @@ -339,6 +344,7 @@ To be added. To be added. To be added. + @@ -372,6 +378,7 @@ To be added. To be added. To be added. + @@ -961,6 +968,7 @@ ]]> + @@ -1067,6 +1075,7 @@ To be added. To be added. To be added. + @@ -1111,6 +1120,7 @@ To be added. To be added. To be added. + @@ -1178,6 +1188,7 @@ ]]> + @@ -1236,6 +1247,7 @@ ]]> + @@ -1280,6 +1292,7 @@ To be added. To be added. To be added. + @@ -1324,6 +1337,7 @@ To be added. To be added. To be added. + @@ -1386,6 +1400,7 @@ ]]> + @@ -1436,6 +1451,7 @@ ]]> + @@ -1471,6 +1487,7 @@ To be added. To be added. To be added. + @@ -1506,6 +1523,7 @@ To be added. To be added. To be added. + @@ -1573,6 +1591,7 @@ ]]> + @@ -1664,6 +1683,7 @@ To be added. To be added. To be added. + @@ -1708,6 +1728,7 @@ To be added. To be added. To be added. + @@ -1758,6 +1779,7 @@ ]]> + @@ -1808,6 +1830,7 @@ ]]> + @@ -1843,6 +1866,7 @@ To be added. To be added. To be added. + @@ -1878,6 +1902,7 @@ To be added. To be added. To be added. + @@ -1946,6 +1971,7 @@ ]]> + @@ -2505,6 +2531,7 @@ ]]> + @@ -2563,6 +2590,7 @@ ]]> + @@ -2607,6 +2635,7 @@ To be added. To be added. To be added. + @@ -2651,6 +2680,7 @@ To be added. To be added. To be added. + @@ -3022,6 +3052,7 @@ ]]> + @@ -3066,6 +3097,7 @@ To be added. To be added. To be added. + @@ -3110,6 +3142,7 @@ To be added. To be added. To be added. + @@ -3287,6 +3320,7 @@ ]]> + @@ -3384,6 +3418,7 @@ To be added. To be added. To be added. + @@ -3428,6 +3463,7 @@ To be added. To be added. To be added. + @@ -3457,6 +3493,7 @@ To be added. To be added. To be added. + @@ -3482,9 +3519,9 @@ - To be added. - To be added. - To be added. + The bounds of the rectangle to add. + The radius width and height used to round the corners of the rectangle. + Adds a rounded rectangle to this path. To be added. @@ -4534,9 +4571,9 @@ - To be added. - To be added. - To be added. + Span to copy the points into. This should be at least as long as the . + Gets the points in the path. + The count of points copied into the . To be added. @@ -4568,9 +4605,9 @@ - To be added. - To be added. - To be added. + Span to copy the types into. This should be at least as long as the . + Gets the types for the points in the path. + The count of types copied into the . To be added. @@ -6006,6 +6043,7 @@ ]]> + @@ -6067,6 +6105,7 @@ ]]> + @@ -6130,6 +6169,7 @@ ]]> + @@ -6201,6 +6241,7 @@ ]]> + @@ -6241,13 +6282,26 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + An array of points that define a parallelogram to which the rectangle defined by + is transformed. + + + A rectangle that represents the rectangle that is transformed to the parallelogram defined by . + + A matrix that specifies a geometric transform to apply to the path. + Specifies whether this warp operation uses perspective or bilinear mode. + + A value from 0 through 1 that specifies how flat the resulting path is. For more information, see the + methods. + + Applies a warp transform, defined by a rectangle and a parallelogram, to this . + + + For , the array can contain either three or four elements. If the array contains three elements, + the lower-right corner of the parallelogram is implied by the first three points. + + diff --git a/xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml b/xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml index 457d8699a07..345eb7beb41 100644 --- a/xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml +++ b/xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml @@ -208,6 +208,7 @@ To be added. To be added. To be added. + @@ -354,6 +355,7 @@ ]]> + @@ -384,6 +386,7 @@ To be added. To be added. To be added. + diff --git a/xml/System.Drawing.Drawing2D/Matrix.xml b/xml/System.Drawing.Drawing2D/Matrix.xml index 4bdf4a02dd1..da844464444 100644 --- a/xml/System.Drawing.Drawing2D/Matrix.xml +++ b/xml/System.Drawing.Drawing2D/Matrix.xml @@ -1569,6 +1569,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); ]]> + @@ -1607,6 +1608,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); To be added. To be added. To be added. + @@ -1731,6 +1733,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); ]]> + @@ -1828,6 +1831,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); To be added. To be added. To be added. + @@ -1866,6 +1870,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); To be added. To be added. To be added. + @@ -2043,6 +2048,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); An array of structures that represents the points to transform. Multiplies each vector in an array by the matrix. The translation elements of this matrix (third row) are ignored. To be added. + @@ -2081,6 +2087,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); To be added. To be added. To be added. + diff --git a/xml/System.Drawing.Drawing2D/PathGradientBrush.xml b/xml/System.Drawing.Drawing2D/PathGradientBrush.xml index 413eab087c4..185826d8a9c 100644 --- a/xml/System.Drawing.Drawing2D/PathGradientBrush.xml +++ b/xml/System.Drawing.Drawing2D/PathGradientBrush.xml @@ -152,6 +152,7 @@ An array of structures that represents the points that make up the vertices of the path. Initializes a new instance of the class with the specified points. To be added. + @@ -242,6 +243,7 @@ To be added. To be added. To be added. + @@ -283,6 +285,7 @@ To be added. To be added. To be added. + @@ -326,6 +329,7 @@ To be added. To be added. To be added. + @@ -369,6 +373,7 @@ To be added. To be added. To be added. + @@ -404,6 +409,7 @@ A that specifies how fills drawn with this are tiled. Initializes a new instance of the class with the specified points and wrap mode. To be added. + diff --git a/xml/System.Drawing.Drawing2D/PathPointType.xml b/xml/System.Drawing.Drawing2D/PathPointType.xml index df8bc1200ed..bc49ed5fc6d 100644 --- a/xml/System.Drawing.Drawing2D/PathPointType.xml +++ b/xml/System.Drawing.Drawing2D/PathPointType.xml @@ -103,6 +103,7 @@ 3 A cubic Bézier curve. + diff --git a/xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml index 39d2927d021..ffa8055bfde 100644 --- a/xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml @@ -14,7 +14,7 @@ - To be added. + Sets the black saturation of an image. The black saturation is the point at which the darkest areas of the image are converted to black. To be added. @@ -35,10 +35,17 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if + + is equal to 15, then color channel values in the interval [15, 255] are adjusted + so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0. + + Creates a new with the given parameters. To be added. + + is less than 0 or greater than 254. @@ -57,9 +64,15 @@ System.Int32 - To be added. + Gets the black saturation value. To be added. - To be added. + + + A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if + is equal to 15, then color channel values in the interval [15, 255] are adjusted + so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0. + + diff --git a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml index daa2c59223d..fd29ad3bab9 100644 --- a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml @@ -14,7 +14,7 @@ - To be added. + Applies a Gaussian blur. To be added. @@ -35,10 +35,15 @@ - To be added. - To be added. - To be added. + + + to expand the bitmap by an amount equal to the blur radius so it can have soft edges. to keep the bitmap the same size and clip the soft edges. + + + Creates a new with the given parameters. To be added. + + is less than 0 or greater than 256. @@ -57,8 +62,12 @@ System.Boolean - To be added. - To be added. + + Gets a value that indicates whether the bitmap expands by an amount equal to the blur radius. + + + if the bitmap expands by an amount equal to the radius so that it can have soft edges. if the bitmap remains the same size and the soft edges are clipped. + To be added. @@ -78,9 +87,9 @@ System.Single - To be added. + Gets the blur radius (the radius of the Gaussian convolution kernel) in pixels. To be added. - To be added. + The radius must be in the range 0 through 255. As the radius increases, the resulting bitmap becomes more blurry. diff --git a/xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml b/xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml index e0b361c4d9c..3b4f2558fdb 100644 --- a/xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml @@ -14,7 +14,7 @@ - To be added. + Changes the brightness and contrast of an image. To be added. @@ -35,10 +35,23 @@ - To be added. - To be added. - To be added. + + Integer in the range -255 through 255 that specifies the brightness level. If the value is 0, the brightness + remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves + from 0 to -255, the brightness of the image decreases. + + + Integer in the range -100 through 100 that specifies the contrast level. If the value is 0, the contrast + remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves + from 0 to -100, the contrast of the image decreases. + + Creates a new with the given parameters. To be added. + + + is less than -255 or greater than 255 or + is less than -100 or greater than 100. + @@ -57,9 +70,10 @@ System.Int32 - To be added. - To be added. - To be added. + + Gets an integer in the range -255 through 255 that specifies the brightness level. + An integer in the range -255 through 255 that specifies the brightness level. + If the value is 0, the brightness remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves from 0 to -255, the brightness of the image decreases. @@ -78,9 +92,9 @@ System.Int32 - To be added. - To be added. - To be added. + Gets the contrast level. + An integer in the range -100 through 100 that specifies the contrast level. + If the value is 0, the contrast remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves from 0 to -100, the contrast of the image decreases. diff --git a/xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml b/xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml index 5c145ccf911..3d9d7f9dba8 100644 --- a/xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml @@ -14,7 +14,7 @@ - To be added. + Adjusts the color balance of an image. To be added. @@ -36,11 +36,37 @@ - To be added. - To be added. - To be added. - To be added. + + + Integer in the range -100 through 100 that specifies a change in the amount of red in the image. If the value + is 0, there is no change. As the value moves from 0 to 100, the amount of red in the image increases and the + amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the + amount of cyan increases. + + + + + Integer in the range -100 through 100 that specifies a change in the amount of green in the image. If the value + is 0, there is no change. As the value moves from 0 to 100, the amount of green in the image increases and the + amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and + and the amount of magenta increases. + + + + + Integer in the range -100 through 100 that specifies a change in the amount of blue in the image. If the value + is 0, there is no change. As the value moves from 0 to 100, the amount of blue in the image increases and the + amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and + the amount of yellow increases. + + + Creates a new with the specified red, green, and blue values. To be added. + + + , , or is less than + -100 or greater than 100. + @@ -59,8 +85,12 @@ System.Int32 - To be added. - To be added. + Gets the amount of cyanRed in the image. + + The value can range from -100 through 100. As the value moves from 0 to 100, the amount of red in the image increases and the + amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the + amount of cyan increases. + To be added. @@ -80,8 +110,12 @@ System.Int32 - To be added. - To be added. + Gets the amount of magentaGreen in the image + + The value can range from -100 through 100. As the value moves from 0 to 100, the amount of green in the image increases and the + amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and + and the amount of magenta increases. + To be added. @@ -101,8 +135,12 @@ System.Int32 - To be added. - To be added. + Gets the amount of yellowBlue in the image. + + The value can range from -100 through 100. As the value moves from 0 to 100, the amount of blue in the image increases and the + amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and + the amount of yellow increases. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/ColorCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/ColorCurveEffect.xml index 3b87dd3f4dc..9496cdf21ad 100644 --- a/xml/System.Drawing.Imaging.Effects/ColorCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ColorCurveEffect.xml @@ -14,7 +14,7 @@ - To be added. + Base class for several effects that can be applied to an image. To be added. @@ -34,7 +34,7 @@ System.Drawing.Imaging.Effects.CurveChannel - To be added. + Gets the channel or channels that the effect is applied to. To be added. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/ColorLookupTableEffect.xml b/xml/System.Drawing.Imaging.Effects/ColorLookupTableEffect.xml index 57fec0a99f1..bc4ab6761fd 100644 --- a/xml/System.Drawing.Imaging.Effects/ColorLookupTableEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ColorLookupTableEffect.xml @@ -14,8 +14,8 @@ - To be added. - To be added. + Modifies the color components of an image. + Individual color component values are changed to entries in a series of lookup tables. @@ -43,12 +43,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The lookup table for the red channel. + The lookup table for the green channel. + The lookup table for the blue channel. + The lookup table for the alpha channel. + Creates a new with the specified red, green, blue, and alpha lookup tables. To be added. + A lookup table parameter is longer than 256 bytes. @@ -76,6 +77,7 @@ To be added. To be added. To be added. + @@ -94,7 +96,7 @@ System.ReadOnlyMemory<System.Byte> - To be added. + Gets the lookup table for the alpha channel. To be added. To be added. @@ -115,7 +117,7 @@ System.ReadOnlyMemory<System.Byte> - To be added. + Gets the lookup table for the blue channel. To be added. To be added. @@ -136,7 +138,7 @@ System.ReadOnlyMemory<System.Byte> - To be added. + Gets the lookup table for the green channel. To be added. To be added. @@ -157,7 +159,7 @@ System.ReadOnlyMemory<System.Byte> - To be added. + Gets the lookup table for the red channel. To be added. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/ColorMatrixEffect.xml b/xml/System.Drawing.Imaging.Effects/ColorMatrixEffect.xml index 209b95e1f3e..5590827b87a 100644 --- a/xml/System.Drawing.Imaging.Effects/ColorMatrixEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ColorMatrixEffect.xml @@ -24,8 +24,13 @@ - To be added. - To be added. + Adjusts the color matrix effect. + + + See Recoloring + for examples of using a color matrix to adjust the colors of an image. + + @@ -44,8 +49,8 @@ - To be added. - To be added. + Color transform matrix. + Creates a new with the given . To be added. @@ -65,9 +70,13 @@ System.Drawing.Imaging.ColorMatrix - To be added. + Gets the color transform matrix. To be added. - To be added. + + + is mutable, but effects do not support changing the matrix after creation. + + diff --git a/xml/System.Drawing.Imaging.Effects/ContrastCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/ContrastCurveEffect.xml index 6be956448e9..3f9ba1cc27e 100644 --- a/xml/System.Drawing.Imaging.Effects/ContrastCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ContrastCurveEffect.xml @@ -14,7 +14,7 @@ - To be added. + Increases or decreases the contrast of an image. To be added. @@ -35,10 +35,17 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + + A value in the range of -100 through 100 that specifies the contrast adjustment value. A value of 0 specifies no change in contrast. Positive values + specify increased contrast and negative values specify decreased contrast. + + + Creates a new with the given adjustment value. To be added. + + is less than -100 or greater than 100. @@ -57,8 +64,8 @@ System.Int32 - To be added. - To be added. + A value in the range of -100 through 100 that specifies the contrast adjustment value. + The contrast adjustment value. A value of 0 specifies no change in contrast. Positive values specify increased contrast, and negative values specify decreased contrast. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/CurveChannel.xml b/xml/System.Drawing.Imaging.Effects/CurveChannel.xml index f815415a5bf..a580229a66c 100644 --- a/xml/System.Drawing.Imaging.Effects/CurveChannel.xml +++ b/xml/System.Drawing.Imaging.Effects/CurveChannel.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Specifies which color channels are affected by a . To be added. @@ -34,7 +34,7 @@ 0 - To be added. + The color adjustment applies to all channels. @@ -54,7 +54,7 @@ 3 - To be added. + The color adjustment applies only to the blue channel. @@ -74,7 +74,7 @@ 2 - To be added. + The color adjustment applies only to the green channel. @@ -94,7 +94,7 @@ 1 - To be added. + The color adjustment applies only to the red channel. diff --git a/xml/System.Drawing.Imaging.Effects/DensityCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/DensityCurveEffect.xml index e840ffbc81b..b1a5e52aa96 100644 --- a/xml/System.Drawing.Imaging.Effects/DensityCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/DensityCurveEffect.xml @@ -14,7 +14,7 @@ - To be added. + Simulates increasing or decreasing the film density of a photograph. To be added. @@ -35,10 +35,15 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value in the range of -256 through 256 that specifies the density. A value of 0 specifies no change in density. Positive values specify + increased density (lighter picture) and negative values specify decreased density (darker picture). + + Creates a new with the given . To be added. + + is less than -256 or greater than 256. @@ -57,7 +62,10 @@ System.Int32 - To be added. + + A value in the range of -256 through 256 that specifies the density. A value of 0 specifies no change in density. Positive values specify + increased density (lighter picture) and negative values specify decreased density (darker picture). + To be added. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/Effect.xml b/xml/System.Drawing.Imaging.Effects/Effect.xml index c35e590e76d..12ab86fe0b3 100644 --- a/xml/System.Drawing.Imaging.Effects/Effect.xml +++ b/xml/System.Drawing.Imaging.Effects/Effect.xml @@ -18,7 +18,7 @@ - To be added. + Base class for all effects. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/ExposureCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/ExposureCurveEffect.xml index 03c8923aae2..b4359d5521d 100644 --- a/xml/System.Drawing.Imaging.Effects/ExposureCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ExposureCurveEffect.xml @@ -14,7 +14,7 @@ - To be added. + Simulates increasing or decreasing the exposure of a photograph To be added. @@ -35,10 +35,15 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value in the range of -256 through 256 that specifies the exposure. A value of 0 specifies no change in exposure. Positive values + specify increased exposure and negative values specify decreased exposure. + + Creates a new with the given adjustment. To be added. + + is less than -256 or greater than 256. @@ -57,8 +62,13 @@ System.Int32 - To be added. - To be added. + + Gets the exposure value. + + + A value in the range of -256 through 256. A value of 0 specifies no change in exposure. Positive values + specify increased exposure and negative values specify decreased exposure. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml b/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml index 06371eb2bd1..e531ae4c18c 100644 --- a/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml @@ -14,7 +14,7 @@ - To be added. + Produces the effect that converts an image to grayscale. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/HighlightCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/HighlightCurveEffect.xml index 3fd362a14ae..b444027bd21 100644 --- a/xml/System.Drawing.Imaging.Effects/HighlightCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/HighlightCurveEffect.xml @@ -14,8 +14,11 @@ - To be added. - To be added. + + Increases or decreases the value of a color channel if that channel already has a value that is above half + intensity. + + You can use this effect to get more definition in the light areas of an image without affecting the dark areas. @@ -35,9 +38,12 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value in the range of -100 through 100 that specifies the highlight value. A value of 0 specifies no change. Positive values specify that the + light areas are made lighter, and negative values specify that the light areas are made darker. + + Creates a new with the given adjustment. To be added. @@ -57,8 +63,13 @@ System.Int32 - To be added. - To be added. + + Gets the highlight value. + + + A value in the range of -100 through 100. A value of 0 specifies no change. Positive values specify that the + light areas are made lighter, and negative values specify that the light areas are made darker. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/InvertEffect.xml b/xml/System.Drawing.Imaging.Effects/InvertEffect.xml index e703421b06e..5c75cf730a4 100644 --- a/xml/System.Drawing.Imaging.Effects/InvertEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/InvertEffect.xml @@ -14,7 +14,7 @@ - To be added. + Produces the effect that inverts the colors in an image. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/LevelsEffect.xml b/xml/System.Drawing.Imaging.Effects/LevelsEffect.xml index 2fdcc6d6004..adb09901312 100644 --- a/xml/System.Drawing.Imaging.Effects/LevelsEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/LevelsEffect.xml @@ -14,7 +14,7 @@ - To be added. + Adjusts the light, mid-tone, or dark areas of an image. To be added. @@ -36,11 +36,45 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + + Integer in the range 0 through 100 that specifies which pixels should be lightened. + + + Integer in the range -100 through 100 that specifies how much to lighten or darken an image. + + + Integer in the range 0 through 100 that specifies which pixels should be darkened. + + Creates a new with the specified highlight, midtone, and shadow values. + + + For the , you can use this adjustment + to lighten pixels that are already lighter than a certain threshold. Setting highlight to 100 specifies no change. + Setting highlight to t specifies that a color channel value is increased if it is already greater than t percent + of full intensity. For example, setting highlight to 90 specifies that all color channel values greater than 90 + percent of full intensity are increased. + + + For the , color channel values + in the middle of the intensity range are altered more than color channel values near the minimum or maximum + intensity. You can use this adjustment to lighten (or darken) an image without loosing the contrast between the + darkest and lightest portions of the image. A value of 0 specifies no change. Positive values specify that the + mid-tones are made lighter, and negative values specify that the mid-tones are made darker. + + + For the , you can use this adjustment + to darken pixels that are already darker than a certain threshold. Setting shadow to 0 specifies no change. + Setting shadow to t specifies that a color channel value is decreased if it is already less than t percent of + full intensity. For example, setting shadow to 10 specifies that all color channel values less than 10 percent + of full intensity are decreased. + + + + + or is less than 0 or greater than 100 or + + is less than -100 or greater than 100. + @@ -59,7 +93,7 @@ System.Int32 - To be added. + Gets the highlight threshold. To be added. To be added. @@ -80,7 +114,7 @@ System.Int32 - To be added. + Gets the midtone adjustment. To be added. To be added. @@ -101,7 +135,7 @@ System.Int32 - To be added. + Gets the shadow threshold. To be added. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/MidtoneCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/MidtoneCurveEffect.xml index d5076864d44..938efa538dc 100644 --- a/xml/System.Drawing.Imaging.Effects/MidtoneCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/MidtoneCurveEffect.xml @@ -14,8 +14,16 @@ - To be added. - To be added. + + Lightens or darkens an image. + + + + Color channel values in the middle of the intensity range are altered more than + color channel values near the minimum or maximum intensity. You can use this effect to lighten (or darken) + an image without loosing the contrast between the darkest and lightest portions of the image. + + @@ -35,10 +43,15 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value in the range of -100 through 100 that specifies the midtone adjustment value. A value of 0 specifies no change. Positive values specify that the + midtones are made lighter, and negative values specify that the midtones are made darker. + + Creates a new with the given adjustment. To be added. + + is less than -100 or greater than 100. @@ -57,8 +70,13 @@ System.Int32 - To be added. - To be added. + + Gets the midtone value. + + + A value in the range of -100 through 100 that specifies the midtone adjustment value. A value of 0 specifies no change. Positive values specify that the + midtones are made lighter, and negative values specify that the midtones are made darker. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml b/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml index d2a667d35cc..0c30c4b5923 100644 --- a/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml @@ -14,7 +14,7 @@ - To be added. + Produces the effect that converts an image to sepia. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/ShadowCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/ShadowCurveEffect.xml index 935ec0efbb8..aebcc65417c 100644 --- a/xml/System.Drawing.Imaging.Effects/ShadowCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/ShadowCurveEffect.xml @@ -14,8 +14,11 @@ - To be added. - To be added. + + Increases or decreases the value of a color channel if that channel already has a value that is below half + intensity. + + You can use this effect to get more definition in the dark areas of an image without affecting the light areas. @@ -35,10 +38,15 @@ - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value in the range of -100 through 100 that specifies the shadow adjustment value. A value of 0 specifies no change. Positive values specify that the + dark areas are made lighter, and negative values specify that the dark areas are made darker. + + Creates a new with the given shadow adjustment value. To be added. + + is less than -100 or greater than 100. @@ -57,8 +65,13 @@ System.Int32 - To be added. - To be added. + + Gets the shadow value. + + + A value in the range of -100 through 100. A value of 0 specifies no change. Positive values specify that the + dark areas are made lighter, and negative values specify that the dark areas are made darker. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/SharpenEffect.xml b/xml/System.Drawing.Imaging.Effects/SharpenEffect.xml index 3285de73584..a6ae4c8c58e 100644 --- a/xml/System.Drawing.Imaging.Effects/SharpenEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/SharpenEffect.xml @@ -14,7 +14,7 @@ - To be added. + Sharpens an image. To be added. @@ -35,10 +35,22 @@ - To be added. - To be added. - To be added. + + Real number that specifies the sharpening radius (the radius of the convolution kernel) in pixels. The radius + must be in the range 0 through 256. As the radius increases, more surrounding pixels are involved in calculating + the new value of a given pixel. + + + Real number in the range 0 through 100 that specifies the amount of sharpening to be applied. A value of 0 + specifies no sharpening. As the value of amount increases, the sharpness increases. + + Creates a new with the specified sharpening values. To be added. + + + is less than 0 or greater than 256 or is less than 0 + or greater than 100. + @@ -57,7 +69,10 @@ System.Single - To be added. + + Real number in the range 0 through 100 that specifies the amount of sharpening to be applied. A value of 0 + specifies no sharpening. As the value of amount increases, the sharpness increases. + To be added. To be added. @@ -78,8 +93,14 @@ System.Single - To be added. - To be added. + + Gets the the sharpening radius. + + + Real number that specifies the sharpening radius (the radius of the convolution kernel) in pixels. The radius + must be in the range 0 through 256. As the radius increases, more surrounding pixels are involved in calculating + the new value of a given pixel. + To be added. diff --git a/xml/System.Drawing.Imaging.Effects/TintEffect.xml b/xml/System.Drawing.Imaging.Effects/TintEffect.xml index f52f10af94e..d27113a1b24 100644 --- a/xml/System.Drawing.Imaging.Effects/TintEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/TintEffect.xml @@ -14,7 +14,7 @@ - To be added. + Applies a tint to an image. To be added. @@ -35,10 +35,16 @@ - To be added. - To be added. - To be added. + The color to be applied to the image. + + Integer in the range -100 through 100 that specifies how much the hue (given by the hue parameter) is + strengthened or weakened. A value of 0 specifies no change. Positive values specify that the hue is + strengthened and negative values specify that the hue is weakened + + Creates a new with the specified hue adjustment. To be added. + + is less than -100 or greater than 100. @@ -58,10 +64,15 @@ - To be added. + Integer in the range of 0 to 360 that specifies the hue to be strengthened or weakened. To be added. To be added. To be added. + + + is less than 0 or greater than 360. + + is less than -100 or greater than 100. @@ -80,8 +91,14 @@ System.Int32 - To be added. - To be added. + + Gets the amount that the hue is strengthened or weakened. + + + Integer in the range -100 through 100 that specifies how much the hue (given by the hue property) is + strengthened or weakened. A value of 0 specifies no change. Positive values specify that the hue is + strengthened and negative values specify that the hue is weakened + To be added. @@ -101,8 +118,8 @@ System.Int32 - To be added. - To be added. + Gets the hue value. + Integer in the range of 0 to 360 that specifies the hue to be strengthened or weakened. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/VividEffect.xml b/xml/System.Drawing.Imaging.Effects/VividEffect.xml index a77fb35577b..a372cfbf746 100644 --- a/xml/System.Drawing.Imaging.Effects/VividEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/VividEffect.xml @@ -14,7 +14,7 @@ - To be added. + Produces the effect that makes colors more vivid. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/WhiteSaturationCurveEffect.xml b/xml/System.Drawing.Imaging.Effects/WhiteSaturationCurveEffect.xml index 955234ce002..9313bbbf6c5 100644 --- a/xml/System.Drawing.Imaging.Effects/WhiteSaturationCurveEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/WhiteSaturationCurveEffect.xml @@ -14,7 +14,10 @@ - To be added. + + Sets the white saturation of an image. The white saturation is the point at which the lightest areas of the image + are converted to white. + To be added. @@ -35,10 +38,19 @@ - To be added. - To be added. - To be added. - To be added. + The channel or channels that the effect is applied to. + + A value of t specifies that the interval [0, t] is mapped linearly to the interval [0, 255]. For example, if + + Creates a new with the specified white saturation value. + + + For example, if is equal to 240, then color channel values in the interval [0, 240] are adjusted + so that they spread out over the interval [0, 255]. Color channel values greater than 240 are set to 255. + + + + was less than 1 or greater than 255. @@ -57,8 +69,12 @@ System.Int32 - To be added. - To be added. + + Gets the white saturation value. + + A value of t specifies that the interval [0, t] is mapped linearly to the interval [0, 255]. For example, if + is equal to 240, then color channel values in the interval [0, 240] are adjusted so that they spread out over the interval [0, 255]. Color channel values greater than 240 are set to 255. + To be added. diff --git a/xml/System.Drawing.Imaging/ColorMatrix.xml b/xml/System.Drawing.Imaging/ColorMatrix.xml index 6a40bd4c2a6..c067005f0c9 100644 --- a/xml/System.Drawing.Imaging/ColorMatrix.xml +++ b/xml/System.Drawing.Imaging/ColorMatrix.xml @@ -163,8 +163,10 @@ To be added. - To be added. + Initializes a new instance of the class with the elements in the specified matrix. To be added. + + did not have 25 values. diff --git a/xml/System.Drawing.Imaging/ColorPalette.xml b/xml/System.Drawing.Imaging/ColorPalette.xml index 7f6fb7c7d65..01e98225252 100644 --- a/xml/System.Drawing.Imaging/ColorPalette.xml +++ b/xml/System.Drawing.Imaging/ColorPalette.xml @@ -89,8 +89,8 @@ To be added. - To be added. - To be added. + Color entries for the palette. + Creates a custom color palette. To be added. @@ -116,7 +116,7 @@ To be added. To be added. - To be added. + Creates a standard color palette. To be added. @@ -139,18 +139,16 @@ System.Drawing.Imaging.ColorPalette - - + - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The number of colors you want to have in an optimal palette based on a the specified bitmap. + to include the transparent color in the palette. + The bitmap to base the optimal color palette off of. + Creates an optimal color palette based on the colors in a given bitmap. + The optimal color palette for the specified bitmap. To be added. diff --git a/xml/System.Drawing.Imaging/DitherType.xml b/xml/System.Drawing.Imaging/DitherType.xml index 334746a44c2..61661d3103a 100644 --- a/xml/System.Drawing.Imaging/DitherType.xml +++ b/xml/System.Drawing.Imaging/DitherType.xml @@ -13,8 +13,9 @@ System.Enum - To be added. - To be added. + Specifies how images are dithered with a reduced color palette. + For information about the ordered and spiral dither types, see the remarks for the Win32 DitherType enumeration. The fixed palette types mentioned there correspond to the enumeration. + DitherType enumeration (gdipluspixelformats.h) @@ -34,7 +35,7 @@ 7 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. @@ -54,7 +55,7 @@ 8 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. @@ -74,7 +75,11 @@ 9 - To be added. + + Dithering is performed based on the palette specified by the palette parameter of the + method. + This algorithm can be used with any palette. + @@ -94,7 +99,11 @@ 0 - To be added. + + No dithering is performed. Pixels in the source bitmap are mapped to the nearest color in the palette specified + by the palette parameter of the + method. This algorithm can be used with any palette other than . + @@ -114,7 +123,7 @@ 4 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. @@ -134,7 +143,10 @@ 2 - To be added. + + Algorithm to perform dithering based on the colors in one of the standard fixed palettes. + This algorithm can also be used to convert a bitmap to a 16-bits-per-pixel format that has no palette. + @@ -154,7 +166,7 @@ 3 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. @@ -174,7 +186,11 @@ 1 - To be added. + + No dithering is performed. Pixels in the source bitmap are mapped to the nearest color in the palette specified + by the palette parameter of the + method. This algorithm can be used with any palette. + @@ -194,7 +210,7 @@ 5 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. @@ -214,7 +230,7 @@ 6 - To be added. + Dithering is performed using the colors in one of the standard fixed palettes. diff --git a/xml/System.Drawing.Imaging/ImageAttributes.xml b/xml/System.Drawing.Imaging/ImageAttributes.xml index 3086694cf0d..7a0ee61b831 100644 --- a/xml/System.Drawing.Imaging/ImageAttributes.xml +++ b/xml/System.Drawing.Imaging/ImageAttributes.xml @@ -2471,6 +2471,7 @@ ]]> + @@ -2513,6 +2514,7 @@ To be added. To be added. To be added. + @@ -2561,6 +2563,7 @@ To be added. To be added. To be added. + @@ -2601,9 +2604,9 @@ - To be added. - To be added. - To be added. + An element of that specifies the category for which the color-remap table is set. + A series of color pairs mapping an existing color to a new color. + Sets the color-remap table for a specified category. To be added. @@ -2655,6 +2658,7 @@ To be added. To be added. To be added. + @@ -2717,6 +2721,7 @@ ]]> + diff --git a/xml/System.Drawing.Imaging/PaletteType.xml b/xml/System.Drawing.Imaging/PaletteType.xml index 60bfe3dd29f..ddaa0dc558f 100644 --- a/xml/System.Drawing.Imaging/PaletteType.xml +++ b/xml/System.Drawing.Imaging/PaletteType.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Specifies color palette types. To be added. @@ -34,7 +34,7 @@ 0 - To be added. + An arbitrary custom palette specified by the caller. @@ -54,7 +54,7 @@ 2 - To be added. + A palette that has two colors. This palette type is suitable for bitmaps that store 1 bit per pixel. @@ -74,7 +74,12 @@ 6 - To be added. + + A palette based on five intensities each for the red, green, and blue channels. Also contains the 16 colors of + the system palette. Eight of the 16 system palette colors are among the 125 five-intensity combinations of red, + green, and blue, so the total number of colors in the palette is 133. If the palette also includes the transparent + color, the total number of colors is 134. + @@ -94,7 +99,13 @@ 7 - To be added. + + A palette based on six intensities each for the red, green, and blue channels. Also contains the 16 colors of + the system palette. Eight of the 16 system palette colors are among the 216 six-intensity combinations of red, + green, and blue, so the total number of colors in the palette is 224. If the palette also includes the transparent + color, the total number of colors is 225. This palette is sometimes called the Windows halftone palette or + the Web palette. + @@ -114,7 +125,11 @@ 8 - To be added. + + A palette based on 6 intensities of red, 7 intensities of green, and 6 intensities of blue. The system palette + is not included. The total number of colors is 252. If the palette also includes the transparent color, the + total number of colors is 253. + @@ -134,7 +149,11 @@ 9 - To be added. + + A palette based on 8 intensities of red, 8 intensities of green, and 4 intensities of blue. The system palette + is not included. The total number of colors is 256. If the transparent color is included in this palette, it + must replace one of the RGB combinations. + @@ -154,7 +173,12 @@ 4 - To be added. + + A palette based on three intensities each for the red, green, and blue channels. Also contains the 16 colors of + the system palette. Eight of the 16 system palette colors are among the 27 three-intensity combinations of red, + green, and blue, so the total number of colors in the palette is 35. If the palette also includes the transparent + color, the total number of colors is 36. + @@ -174,7 +198,12 @@ 5 - To be added. + + A palette based on four intensities each for the red, green, and blue channels. Also contains the 16 colors of + the system palette. Eight of the 16 system palette colors are among the 64 four-intensity combinations of red, + green, and blue, so the total number of colors in the palette is 72. If the palette also includes the transparent + color, the total number of colors is 73. + @@ -194,7 +223,12 @@ 3 - To be added. + + A palette based on two intensities each (off or full) for the red, green, and blue channels. Also contains the + 16 colors of the system palette. Because all eight of the on/off combinations of red, green, and blue are + already in the system palette, this palette is the same as the system palette. This palette type is suitable + for bitmaps that store 4 bits per pixel. + diff --git a/xml/System.Drawing.Imaging/PixelFormat.xml b/xml/System.Drawing.Imaging/PixelFormat.xml index c20b9a0f80f..5c15c9073b6 100644 --- a/xml/System.Drawing.Imaging/PixelFormat.xml +++ b/xml/System.Drawing.Imaging/PixelFormat.xml @@ -107,6 +107,7 @@ 2097152 The default pixel format of 32 bits per pixel. The format specifies 24-bit color depth and an 8-bit alpha channel. + @@ -171,6 +172,7 @@ 1048576 Reserved. + @@ -235,6 +237,7 @@ 1052676 The pixel format is 16 bits per pixel. The color information specifies 65536 shades of gray. + diff --git a/xml/System.Drawing/Bitmap.xml b/xml/System.Drawing/Bitmap.xml index d064f6c07dc..68373621580 100644 --- a/xml/System.Drawing/Bitmap.xml +++ b/xml/System.Drawing/Bitmap.xml @@ -691,9 +691,9 @@ - To be added. - To be added. - To be added. + The effect to apply. + The area to apply to, or for the entire image. + Alters the bitmap by applying the given . To be added. @@ -850,9 +850,9 @@ - To be added. - To be added. - To be added. + The new pixel format. + Converts the bitmap to the specified . The original pixel data is replaced with the new format. + For , is not supported. @@ -886,13 +886,42 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The new pixel format. + The dithering algorithm. + The palette type to use when the pixel format is indexed. + Pointer to a that specifies the palette whose indexes are stored in the pixel data of the converted bitmap. This must be specified for indexed pixel formats. + A real number in the range 0 through 100 that specifies which pixels in the source bitmap will map to the transparent color in the converted bitmap. + Converts the bitmap to the specified using the given . The original pixel data is replaced with the new format. + + + For , is not supported. + + + For , pass when the conversion does not reduce the bit depth of the pixel data. + This must be or if the is + or . + + + is ignored for non-indexed pixel formats. + + + The (called the actual palette) does not have to have the type specified by the parameter. + The parameter specifies a standard palette that can be used by any of the ordered or spiral dithering algorithms. + If the actual palette has a type other than that specified by the parameter, + then + performs a nearest-color conversion from the standard palette to the actual palette. + + + For , a value of 0 specifies that none of the source pixels map to the transparent color. + A value of 100 specifies that any pixel that is not fully opaque will map to the transparent color. + A value of t specifies that any source pixel less than t percent of fully opaque will map to the transparent color. + Note that for the alpha threshold to be effective, the palette must have a transparent color. If the palette does not have a transparent color, + pixels with alpha values below the threshold will map to color that most closely matches (0, 0, 0, 0), usually black. + + + and really only have relevance with indexed pixel formats. You can pass a for non-indexed pixel formats, but it has no impact on the transformation and will effective just call to set the palette when the conversion is complete. + + diff --git a/xml/System.Drawing/Graphics.xml b/xml/System.Drawing/Graphics.xml index 4524a7203cb..9f8a5e35752 100644 --- a/xml/System.Drawing/Graphics.xml +++ b/xml/System.Drawing/Graphics.xml @@ -1825,6 +1825,7 @@ The number of points in the array should be a multiple of 3 plus 1 because the f To be added. To be added. To be added. + @@ -1878,6 +1879,7 @@ The number of points in the array should be a multiple of 3 plus 1 because the f To be added. To be added. To be added. + @@ -2152,6 +2154,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2205,6 +2208,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2413,6 +2417,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2459,6 +2464,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2691,6 +2697,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2744,6 +2751,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2946,6 +2954,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -2990,6 +2999,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -3081,6 +3091,7 @@ The object has a transform applied othe -or- is . + @@ -3127,6 +3138,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -3353,6 +3365,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -3401,6 +3414,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -3907,6 +3921,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -5303,13 +5318,14 @@ The object has a transform applied othe - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + The to be drawn. + The effect to be applied when drawing. + The portion of the image to be drawn. draws the full image. + The transform to apply to the to determine the destination. + The unit of measure of the . + Additional adjustments to be applied, if any. + Draws a portion of an image after applying a specified effect. To be added. @@ -7409,6 +7425,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -7462,6 +7479,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8049,6 +8067,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8102,6 +8121,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8551,6 +8571,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8604,6 +8625,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8635,6 +8657,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -8661,11 +8684,12 @@ The object has a transform applied othe - To be added. + The to draw the outline with. To be added. To be added. - To be added. + Draws the outline of the specified rounded rectangle. To be added. + @@ -12433,6 +12457,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -12486,6 +12511,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -12569,6 +12595,7 @@ The object has a transform applied othe -or- is . + @@ -12696,6 +12723,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -12740,6 +12768,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -12819,6 +12848,7 @@ The object has a transform applied othe -or- is . + @@ -12943,6 +12973,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -12989,6 +13020,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -13822,6 +13854,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -13875,6 +13908,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14061,6 +14095,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14105,6 +14140,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14590,6 +14626,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14643,6 +14680,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14744,6 +14782,7 @@ The object has a transform applied othe To be added. To be added. To be added. + @@ -14770,10 +14809,10 @@ The object has a transform applied othe - To be added. - To be added. - To be added. - To be added. + The to fill the rounded rectangle with. + The bounds of the rounded rectangle. + The radius width and height used to round the corners of the rectangle. + Fills the interior of a rounded rectangle with a . To be added. @@ -19582,6 +19621,7 @@ This is a more performant alternative to + @@ -19701,6 +19741,7 @@ This is a more performant alternative to To be added. To be added. To be added. + @@ -19749,6 +19790,7 @@ This is a more performant alternative to To be added. To be added. To be added. + diff --git a/xml/System.Drawing/Icon.xml b/xml/System.Drawing/Icon.xml index b5750ed36cc..dc688c12bc8 100644 --- a/xml/System.Drawing/Icon.xml +++ b/xml/System.Drawing/Icon.xml @@ -91,28 +91,28 @@ Represents a Windows icon, which is a small bitmap image that is used to represent an object. Icons can be thought of as transparent bitmaps, although their size is determined by the system. - objects from files, streams, or embedded resources. For a list of constructors, see . You can also convert an to a bitmap by using the method. - -[!INCLUDE[System.Drawing.Common note](~/includes/system-drawing-common.md)] - - An icon resource can contain multiple icon images. One icon file may contain images in several sizes and color depths. The image that is used in an application depends on the operating system and settings. The following list details the typical sizes for an icon: - -- 16 pixels x 16 pixels - -- 32 pixels x 32 pixels - -- 48 pixels x 48 pixels - -## Examples - The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's event handler, passing `e` as . - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: - + objects from files, streams, or embedded resources. For a list of constructors, see . You can also convert an to a bitmap by using the method. + +[!INCLUDE[System.Drawing.Common note](~/includes/system-drawing-common.md)] + + An icon resource can contain multiple icon images. One icon file may contain images in several sizes and color depths. The image that is used in an application depends on the operating system and settings. The following list details the typical sizes for an icon: + +- 16 pixels x 16 pixels + +- 32 pixels x 32 pixels + +- 48 pixels x 48 pixels + +## Examples + The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's event handler, passing `e` as . + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: + ]]> Working with Images, Bitmaps, Icons, and Metafiles @@ -164,19 +164,19 @@ The data stream from which to load the . Initializes a new instance of the class from the specified data stream. - The parameter is . @@ -219,19 +219,19 @@ The file to load the from. Initializes a new instance of the class from the specified file name. - @@ -269,11 +269,11 @@ A structure that specifies the height and width of the new . Initializes a new instance of the class and attempts to find a version of the icon that matches the requested size. - that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the method to resize the icon. - + that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the method to resize the icon. + ]]> The parameter is . @@ -346,13 +346,13 @@ The desired size of the icon. Initializes a new instance of the class of the specified size from the specified file. - The is or does not contain image data. @@ -391,21 +391,21 @@ The resource name to load. Initializes a new instance of the class from a resource in the specified assembly. - from a resource with the name specified by the `resource` parameter in the assembly that contains the type specified by the `type` parameter. - - This constructor combines the namespace of the given type together with the string name of the resource and looks for a match in the assembly manifest. For example you can pass in the type and `Error.ico` to this constructor, and it looks for a resource that is named `System.Windows.Forms.Error.ico`. - - - -## Examples - The following code example demonstrates how to use the constructor. To run this example, paste the code into a Windows Form and handle the form's event. Call the `ConstructAnIconFromAType` method from the event handler, passing `e` as . - - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/SetResolution/Form1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Misc3/VB/Form1.vb" id="Snippet3"::: - + from a resource with the name specified by the `resource` parameter in the assembly that contains the type specified by the `type` parameter. + + This constructor combines the namespace of the given type together with the string name of the resource and looks for a match in the assembly manifest. For example you can pass in the type and `Error.ico` to this constructor, and it looks for a resource that is named `System.Windows.Forms.Error.ico`. + + + +## Examples + The following code example demonstrates how to use the constructor. To run this example, paste the code into a Windows Form and handle the form's event. Call the `ConstructAnIconFromAType` method from the event handler, passing `e` as . + + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/SetResolution/Form1.cs" id="Snippet3"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Misc3/VB/Form1.vb" id="Snippet3"::: + ]]> An icon specified by cannot be found in the assembly that contains the specified . @@ -446,20 +446,20 @@ The height of the new icon. Initializes a new instance of the class and attempts to find a version of the icon that matches the requested size. - that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the method to resize the icon. - - - -## Examples - The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's event handler, passing `e` as . - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: - + that has a single size, this method only creates a duplicate icon. Use the stretching capabilities of the method to resize the icon. + + + +## Examples + The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's event handler, passing `e` as . + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: + ]]> The parameter is . @@ -537,13 +537,13 @@ The desired height of the . Initializes a new instance of the class with the specified width and height from the specified file. - The is or does not contain image data. @@ -620,11 +620,11 @@ Releases all resources used by this . - to be reallocated for other purposes. - + to be reallocated for other purposes. + ]]> @@ -670,27 +670,27 @@ Returns an icon representation of an image that is contained in the specified file. The representation of the image that is contained in the specified file. - is used with bitmaps, a thumbnail image may be returned instead of an icon if the system that is running the application has a registry setting that causes bitmap files to be shown as thumbnail images. - - - -## Examples - The following code example demonstrates how to use the method. To run this example, paste the code into a Windows Form and call `ExtractAssociatedIconEx` from the form's constructor or event handler. - - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/SetResolution/Form1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Misc3/VB/Form1.vb" id="Snippet2"::: - + is used with bitmaps, a thumbnail image may be returned instead of an icon if the system that is running the application has a registry setting that causes bitmap files to be shown as thumbnail images. + + + +## Examples + The following code example demonstrates how to use the method. To run this example, paste the code into a Windows Form and call `ExtractAssociatedIconEx` from the form's constructor or event handler. + + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/SetResolution/Form1.cs" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Misc3/VB/Form1.vb" id="Snippet2"::: + ]]> - The does not indicate a valid file. - - -or- - + The does not indicate a valid file. + + -or- + The indicates a Universal Naming Convention (UNC) path. @@ -771,9 +771,9 @@ Extracts a specified icon from the given . An , or if an icon can't be found with the specified . - Unlike the constructors that take a path, this method and the methods do not retain all of the resource data or modify the original data (outside of resizing if necessary). As such, the only uses as much memory as is needed for the requested size (mostly native memory). + Unlike the constructors that take a path, this method and the methods do not retain all of the resource data or modify the original data (outside of resizing if necessary). As such, the only uses as much memory as is needed for the requested size (mostly native memory). - Without the original source data, the copy constructors have to resample the current icon's bitmap to change sizes. For best image quality, if different sizes for an are desired you should create separate instances with this method and avoid the copy constructors. + Without the original source data, the copy constructors have to resample the current icon's bitmap to change sizes. For best image quality, if different sizes for an are desired you should create separate instances with this method and avoid the copy constructors. @@ -852,30 +852,30 @@ Creates a GDI+ from the specified Windows handle to an icon (). The this method creates. - `e`, which is a parameter of the event handler. The code performs the following actions: - -- Creates a . - -- Draws that object to the screen. - -- Gets an icon handle for the . - -- Sets the attribute of the form to an icon created from the handle. - -- Calls the Windows API function `DestroyIcon` to release resources. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/CPP/form1.cpp" id="Snippet6"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/Clone/form1.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/VB/form1.vb" id="Snippet6"::: - + `e`, which is a parameter of the event handler. The code performs the following actions: + +- Creates a . + +- Draws that object to the screen. + +- Gets an icon handle for the . + +- Sets the attribute of the form to an icon created from the handle. + +- Calls the Windows API function `DestroyIcon` to release resources. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/CPP/form1.cpp" id="Snippet6"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/Clone/form1.cs" id="Snippet6"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/VB/form1.vb" id="Snippet6"::: + ]]> @@ -917,17 +917,17 @@ Gets the Windows handle for this . This is not a copy of the handle; do not free it. The Windows handle for the icon. - handle using the enumeration and how to use the method to draw the rectangle bounds of a bitmap. - - This example is designed to be used with Windows Forms. Create a form that contains a button named `Button2`. Paste the code into the form and associate this method with the button's event. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.BitmapMembers/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.BitmapMembers/VB/form1.vb" id="Snippet1"::: - + handle using the enumeration and how to use the method to draw the rectangle bounds of a bitmap. + + This example is designed to be used with Windows Forms. Create a form that contains a button named `Button2`. Paste the code into the form and associate this method with the button's event. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.BitmapMembers/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.BitmapMembers/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1005,6 +1005,8 @@ The to save to. Saves this to the specified output . To be added. + + is . @@ -1120,23 +1122,18 @@ Converts this to a GDI+ . A that represents the converted . - [!NOTE] -> Beginning with framework version 4.6 support was added for PNG frames in .ico files. Applications that target earlier versions of the framework but are running on the 4.6 bits can opt in into the new behavior by adding the following line to the `` section of the app.config file:`` - - - -## Examples - The following code example demonstrates how to use the method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's . event handler, passing `e` as . - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: - + method. This example is designed to be used with Windows Forms. Create a form and paste the following code into it. Call the `IconToBitmap` method in the form's . event handler, passing `e` as . + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.MiscExamples/CPP/form1.cpp" id="Snippet9"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form12.cs" id="Snippet9"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.MiscExamples/VB/form1.vb" id="Snippet9"::: + ]]> diff --git a/xml/System.Drawing/SystemIcons.xml b/xml/System.Drawing/SystemIcons.xml index 157f19087ea..82036bc061b 100644 --- a/xml/System.Drawing/SystemIcons.xml +++ b/xml/System.Drawing/SystemIcons.xml @@ -47,21 +47,21 @@ Each property of the class is an object for Windows system-wide icons. This class cannot be inherited. - handle, using the enumeration, and the use of the method to draw the rectangle bounds of a bitmap. - - This example is designed to be used with Windows Forms. Create a form that contains a button named Button2. Paste the code into the form and associate this method with the button's `Click` event. - - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.BitmapMembers/CPP/form1.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.BitmapMembers/VB/form1.vb" id="Snippet1"::: - + handle, using the enumeration, and the use of the method to draw the rectangle bounds of a bitmap. + + This example is designed to be used with Windows Forms. Create a form that contains a button named Button2. Paste the code into the form and associate this method with the button's `Click` event. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.BitmapMembers/CPP/form1.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Drawing/Bitmap/.ctor/form1.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.BitmapMembers/VB/form1.vb" id="Snippet1"::: + ]]> @@ -226,7 +226,7 @@ Gets the specified Windows shell stock icon. The requested . - Unlike the static icon properties in , this API returns icons that are themed for the running version of Windows. Additionally, the returned is not cached and should be disposed when no longer needed. + Unlike the static icon properties in , this API returns icons that are themed for the running version of Windows. Additionally, the returned is not cached and should be disposed when no longer needed. @@ -393,14 +393,7 @@ Gets an object that contains the shield icon. An object that contains the shield icon. - - - +