IIXC_Page::GetPixel Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::GetPixel Method}}
 
{{#customTitle:IIXC_Page::GetPixel Method}}
 
{{#parentPage:PXV:IIXC_Page|GetPixel Method|method}}
 
{{#parentPage:PXV:IIXC_Page|GetPixel Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method retrieves the color value of the pixel at the specified coordinates.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;ptX
 
;ptX
:[in]  Value of LONG.
+
:[in]  Specifies x-coordinate of the pixel to be examined.
 
;ptY
 
;ptY
:[in]  Value of LONG.
+
:[in]  Specifies y-coordinate of the pixel to be examined.
 
;pColor
 
;pColor
:[out, retval]  Pointer to ULONG.
+
:[out, retval]  Pointer to ULONG variable which will receive the color of the pixel. This parameter cannot be NULL.
  
 
== Return Value ==
 
== Return Value ==
 
Returns S_OK if operation was successful or error code in other cases.
 
Returns S_OK if operation was successful or error code in other cases.
 +
 +
== Remarks ==
 +
For all raster internal formats, the function returns the red, green, and blue components of the pixel's color. If the page has an alpha channel (Gray with Alpha, or TrueColor with Alpha), the high-order byte of the color will contain the value of the specified pixel's alpha channel. For indexed images, the high-order byte will contain the page palette index of the pixel's color.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_GetPixelIndex|IIXC_Page::GetPixelIndex]]

Revision as of 05:01, 30 April 2015


The method retrieves the color value of the pixel at the specified coordinates.

Syntax

HRESULT GetPixel([in]           LONG    ptX,
                 [in]           LONG    ptY,
                 [out, retval]  ULONG*  pColor);

Parameters

ptX
[in] Specifies x-coordinate of the pixel to be examined.
ptY
[in] Specifies y-coordinate of the pixel to be examined.
pColor
[out, retval] Pointer to ULONG variable which will receive the color of the pixel. This parameter cannot be NULL.

Return Value

Returns S_OK if operation was successful or error code in other cases.

Remarks

For all raster internal formats, the function returns the red, green, and blue components of the pixel's color. If the page has an alpha channel (Gray with Alpha, or TrueColor with Alpha), the high-order byte of the color will contain the value of the specified pixel's alpha channel. For indexed images, the high-order byte will contain the page palette index of the pixel's color.

See Also

IIXC_Page
IIXC_Page::GetPixelIndex