IIXC_Page::AutoContrast Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::AutoContrast Method}}
 
{{#customTitle:IIXC_Page::AutoContrast Method}}
 
{{#parentPage:PXV:IIXC_Page|AutoContrast Method|method}}
 
{{#parentPage:PXV:IIXC_Page|AutoContrast Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
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.
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[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.}}
  
 
== Return Value ==
 
== Return Value ==
Line 18: Line 19:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]].

Revision as of 06:38, 29 April 2015


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.

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 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.

See Also

IIXC_Page.