IIXC_Page::ColorBalance Method

From Tracker Software PDF SDK
Revision as of 02:16, 15 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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   nRValue,
                     [in, defaultvalue(0)]     LONG   nGValue,
                     [in, defaultvalue(0)]     LONG   nBValue,
                     [in, defaultvalue(NULL)]  RECT*  stRect);

Parameters

nRValue
[in, defaultvalue(0)] Specifies the level of red color in the image.
nGValue
[in, defaultvalue(0)] Specifies the level of green color in the image.
nBValue
[in, defaultvalue(0)] Specifies the level of blue color in the image.
stRect
[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