IIXC_Page::ColorBalance Method

Images Core Layer > Interfaces > IIXC_Page > IIXC_Page::ColorBalance Method

The ColorBalance method changes the overall mixture of colors in the image page for generalized color correction based on defined values for each of the valid channels available - Red, Green and Blue.

Syntax

HRESULT ColorBalance([in, defaultvalue(0)]     LONG   RValue,
                     [in, defaultvalue(0)]     LONG   GValue,
                     [in, defaultvalue(0)]     LONG   BValue,
                     [in, defaultvalue(NULL)]  RECT*  Rect);

Parameters

RValue

[in, defaultvalue(0)] Specifies the level of red color in the image.

GValue

[in, defaultvalue(0)] Specifies the level of green color in the image.

BValue

[in, defaultvalue(0)] Specifies the level of blue color in the image.

Rect

[in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area where function should be applied. If this parameter is NULL, the entire page will be processed.

Note:

Please note that partial processing of an area of a page is not supported for all image formats. For example, it is not supported for indexed images, because each pixel in such images does not contain a color, but an index into a color table (or palette) which is common for the entire page.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IIXC_Page