IIXC_Page::ColorBalance Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
| − | The method of | + | The 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 == | == Syntax == | ||
| Line 15: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nRValue | ;nRValue | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies the level of red color in the image. |
;nGValue | ;nGValue | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies the level of green color in the image. |
;nBValue | ;nBValue | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies the level of blue color in the image. |
;pRect | ;pRect | ||
| − | :[in, defaultvalue(NULL)] Pointer to 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 contains not a color, but an index into a color table (palette) which is common for the entire page.}} | ||
== Return Value == | == Return Value == | ||
| Line 27: | Line 28: | ||
== See Also == | == See Also == | ||
| − | + | :[[PXV:IIXC_Page|IIXC_Page]] | |
Revision as of 06:44, 29 April 2015
The 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.
Contents
Syntax
HRESULT ColorBalance([in, defaultvalue(0)] LONG nRValue,
[in, defaultvalue(0)] LONG nGValue,
[in, defaultvalue(0)] LONG nBValue,
[in, defaultvalue(NULL)] RECT* pRect);
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.
- pRect
- [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 contains not a color, but an index into a color table (palette) which is common for the entire page.Return Value
Returns S_OK if operation was successful or error code in other cases.
