IIXC_Page::AutoContrast Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::AutoContrast Method}}
 
{{#customTitle:IIXC_Page::AutoContrast Method}}
 +
{{#parentPage:PXV:IIXC_Page#Methods|AutoContrast|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
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 ==
<pre class="brush:cpp;gutter:false">HRESULT AutoContrast([in, optional] RECT* pRect);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AutoContrast([in] RECT* stRect);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pRect''
+
;stRect
:[in, optional]  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 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 ==
Line 15: Line 18:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 03:16, 15 June 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*  stRect);

Parameters

stRect
[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