Documentation / Marblecore Imaging / Methods / AdjustSaturation
AdjustSaturation method
Adjusts the saturation of the image by a certain amount.
Syntax
Boolean AdjustSaturation(nSaturation As Number, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)
Return value
Returns true if the function succeeded.
Parameters
Parameter | Type | Required | Description |
nSaturation | Number | Yes | The amount of the adjustment ranging from -100%...100%. |
nLeft | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the left coordinate of the rectangle. |
nTop | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the top coordinate of the rectangle. |
nWidth | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the width of the rectangle. |
nHeight | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the height of the rectangle. |
Example
The example below shows the effect of this method and how to use it. You can slide the marker in the before/after picture to see the difference. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.
1
2 MarblecoreImaging.LoadFromFile("example-adjustsaturation-before.jpg");
3
4
5 MarblecoreImaging.AdjustSaturation(50);
6
7
8 MarblecoreImaging.SaveToFile("example-adjustsaturation-after.jpg");
Category
Color adjustments
See also
AdjustBrightness |
AdjustColorBalance |
AdjustColorLevel |
AdjustContrast |
AdjustGamma |
AdjustHue |
AdjustHueSaturation |
AdjustLightness |
AdjustRGB