IIXC_Page::GetPixel Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 9: Line 9:
 
<pre class="brush:cpp;gutter:false">HRESULT GetPixel([in]          LONG    nX,
 
<pre class="brush:cpp;gutter:false">HRESULT GetPixel([in]          LONG    nX,
 
                 [in]          LONG    nY,
 
                 [in]          LONG    nY,
                 [out, retval]  ULONG*  nColor);</pre>
+
                 [out, retval]  ULONG*  Color);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 16:
 
;nY
 
;nY
 
:[in]  Specifies y-coordinate of the pixel to be examined.
 
:[in]  Specifies y-coordinate of the pixel to be examined.
;nColor
+
;Color
 
:[out, retval]  Pointer to ULONG variable which will receive the color of the pixel. This parameter cannot be NULL.
 
:[out, retval]  Pointer to ULONG variable which will receive the color of the pixel. This parameter cannot be NULL.
  

Revision as of 05:51, 12 June 2015

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

Syntax

HRESULT GetPixel([in]           LONG    nX,
                 [in]           LONG    nY,
                 [out, retval]  ULONG*  Color);

Parameters

nX
[in] Specifies x-coordinate of the pixel to be examined.
nY
[in] Specifies y-coordinate of the pixel to be examined.
Color
[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