IIXC_Page::ToGrayScale Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
 
{{#parentPage:PXV:IIXC_Page|ToGrayScale Method|method}}
 
{{#parentPage:PXV:IIXC_Page|ToGrayScale Method|method}}
  
 
+
== Syntax ==
The '''ToGrayScale''' method converts the image to grayscale.
+
<pre class="brush:cpp;gutter:false">HRESULT ToGrayScale([in]  RECT*  pRect);</pre>
 
+
{{note|Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.}}
+
  
 
== Syntax ==
 
== Syntax ==

Revision as of 03:51, 20 May 2015

Syntax

HRESULT ToGrayScale([in]  RECT*  pRect);

Syntax

HRESULT ToGrayScale([in]  RECT*  pRect);

Parameters

pRect
[in] Pointer to a RECT structure which defines the rectangular area where colors should be grayscaled. If this parameter is NULL, the entire page will be grayscaled.
Note:
Please note that processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because the pixels in such images do 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
IIXC_Page::ConvertToFormat