Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / AdjustColorBalance

AdjustColorBalance method

Adjust the RGB channels of the image.

Syntax

Boolean AdjustColorBalance(nCyanRed As Number, nMagentaGreen As Number, nYellowBlue As Number, nTone As Tone, bPreserveLuminosity As Boolean, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nCyanRedNumberYesSpecifies the cyan-red color balance adjustment ranging from -100...100 (a value of 0 means no change).
nMagentaGreenNumberYesSpecifies the magenta-green color balance adjustment ranging from -100...100 (a value of 0 means no change).
nYellowBlueNumberYesSpecifies the yellow-blue color balance adjustment ranging from -100...100 (a value of 0 means no change).
nToneTone (Enumeration)NoOptional parameter which specifies the tone balance to adjust.
bPreserveLuminosityBooleanNoOptional parameter which enables or disables the preserve luminosity option.
nLeftNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the left coordinate of the rectangle.
nTopNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the top coordinate of the rectangle.
nWidthNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the width of the rectangle.
nHeightNumberNoOptional 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.
 
before
after
 
1 // Load the specified image in memory
2 MarblecoreImaging.LoadFromFile("example-adjustcolorbalance-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.AdjustColorBalance(100, 100, 100, "Shadows");
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-adjustcolorbalance-after.jpg");

Category

Color adjustments

See also

AdjustBrightness | AdjustColorLevel | AdjustContrast | AdjustGamma | AdjustHue | AdjustHueSaturation | AdjustLightness | AdjustRGB | AdjustSaturation