IIXC_Page::GetPixelIndex Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::GetPixelIndex Method}} | {{#customTitle:IIXC_Page::GetPixelIndex Method}} | ||
| + | {{#parentPage:PXV:IIXC_Page#Methods|GetPixelIndex|method}} | ||
| − | The method | + | The method retrieves the page palette's color index for the pixel at the specified coordinates.. |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in] LONG | + | <pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in] LONG nX, |
| + | [in] LONG nY, | ||
| + | [in] LONG* nIndex);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nX |
| − | :[in] | + | :[in] Specifies x-coordinate of the pixel to be examined. |
| − | ; | + | ;nY |
| − | :[in] | + | :[in] Specifies y-coordinate of the pixel to be examined. |
| − | ; | + | ;nIndex |
| − | :[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]] | |
Latest revision as of 02:16, 15 June 2015
The method retrieves the page palette's color index for the pixel at the specified coordinates..
Syntax
HRESULT GetPixelIndex([in] LONG nX,
[in] LONG nY,
[in] LONG* nIndex);
Parameters
- nX
- [in] Specifies x-coordinate of the pixel to be examined.
- nY
- [in] Specifies y-coordinate of the pixel to be examined.
- nIndex
- [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.
