IIXC_Page::AutoContrast Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#parentPage:PXV:IIXC_Page|AutoContrast Method|method}}
 
{{#parentPage:PXV:IIXC_Page|AutoContrast Method|method}}
  
{{ToReview}}
 
  
The method automatically adjusts the overall contrast and mixture of colors within a page, or specified rectangular area of a page. Because it does not adjust channels individually, Auto Contrast does not remove color casts. It maps the lightest and darkest pixels in the image to white and black which makes highlights appear lighter and shadows appear darker.
+
The '''AutoContrast''' method automatically adjusts the overall contrast and mixture of colors within a page, or specified rectangular area of a page. Because it does not adjust channels individually, '''AutoContrast''' does not remove color casts. It maps the lightest and darkest pixels in the image to white and black which makes highlights appear lighter and shadows appear darker.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
;pRect
 
;pRect
 
:[in]  Pointer to RECT structure which defines the rectangular area where the function should be applied. If this parameter is NULL, the entire page will be processed.
 
:[in]  Pointer to RECT structure which defines the rectangular area where the 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.}}
+
{{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 ==
 
== Return Value ==

Revision as of 11:00, 17 May 2015


The AutoContrast method automatically adjusts the overall contrast and mixture of colors within a page, or specified rectangular area of a page. Because it does not adjust channels individually, AutoContrast does not remove color casts. It maps the lightest and darkest pixels in the image to white and black which makes highlights appear lighter and shadows appear darker.

Syntax

HRESULT AutoContrast([in]  RECT*  pRect);

Parameters

pRect
[in] Pointer to RECT structure which defines the rectangular area where the 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.