IIXC_Page::GetPixelIndex Method

From PDF XChange PDF SDK
Jump to: navigation, search
(See Also)
Line 3: Line 3:
 
{{#parentPage:PXV:IIXC_Page|GetPixelIndex Method|method}}
 
{{#parentPage:PXV:IIXC_Page|GetPixelIndex Method|method}}
  
{{ToReview}}
 
  
 
The method retrieves the page palette's color index for the pixel at the specified coordinates..
 
The method retrieves the page palette's color index for the pixel at the specified coordinates..

Revision as of 09:33, 18 May 2015


The method retrieves the page palette's color index for the pixel at the specified coordinates..

Syntax

HRESULT GetPixelIndex([in]  LONG   ptX,
                      [in]  LONG   ptY,
                      [in]  LONG*  pIndex);

Parameters

ptX
[in] Specifies x-coordinate of the pixel to be examined.
ptY
[in] Specifies y-coordinate of the pixel to be examined.
pIndex
[in] Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.

Return Value

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

Remarks

For indexed formats (1 bpp, and 8 bpp) the function will return the index of the pixel's color within the page palette; for grayscaled images (Gray, and Gray with Aplha) the function will return the gray level; for TrueColor formats index will contain -1.

See Also

IIXC_Page
IIXC_Page::GetPixel
IIXC_Page::SetPixel
IIXC_Page::SetPixelIndex