IIXC_Page::GetPixelIndex Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IIXC_Page::GetPixelIndex Method}} | {{#customTitle:IIXC_Page::GetPixelIndex Method}} | ||
{{#parentPage:PXV:IIXC_Page|GetPixelIndex Method|method}} | {{#parentPage:PXV:IIXC_Page|GetPixelIndex Method|method}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | The method | + | The method retrieves the page palette's color index for the pixel at the specified coordinates.. |
== Syntax == | == Syntax == | ||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;ptX | ;ptX | ||
| − | :[in] | + | :[in] Specifies x-coordinate of the pixel to be examined. |
;ptY | ;ptY | ||
| − | :[in] | + | :[in] Specifies y-coordinate of the pixel to be examined. |
;pIndex | ;pIndex | ||
| − | :[in] Pointer to LONG. | + | :[in] Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette. |
== 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 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 == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]]. | |
| + | |||
| + | :[[PXV:IIXC_Page_GetPixel|IIXC_Page::GetPixel]] | ||
| + | :[[PXV:IIXC_Page_SetPixel|IIXC_Page::SetPixel]] | ||
| + | :[[PXV:IIXC_Page_SetPixelIndex|IIXC_Page::SetPixelIndex]] | ||
Revision as of 05:08, 30 April 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.
