IIXC_Page::ToGrayScale Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method converts the image to grayscale.
+
The '''ToGrayScale''' method converts the image to grayscale.
  
 
{{note|Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.}}
 
{{note|Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.}}
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to the RECT structure which defines the rectangular area where colors should be grayscaled. If this parameter is NULL, the entire page will be grayscaled.
+
:[in]  Pointer to a ''RECT'' structure which defines the rectangular area where colors should be grayscaled. If this parameter is <tt>NULL</tt>, 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 each pixel in such images contains not the color, but the index into color table (palette) which is common for the entire page}}
+
{{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 ==
 
== Return Value ==

Revision as of 14:27, 18 May 2015


The ToGrayScale method converts the image to grayscale.

Note:
Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.

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