IIXC_Page::GetPixelIndex Method

From PDF XChange PDF SDK
Jump to: navigation, search
(See Also)
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 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|GetPixelIndex Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|GetPixelIndex|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..
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in]  LONG  ptX,
+
<pre class="brush:cpp;gutter:false">HRESULT GetPixelIndex([in]  LONG  nX,
                       [in]  LONG  ptY,
+
                       [in]  LONG  nY,
                       [in]  LONG*  pIndex);</pre>
+
                       [in]  LONG*  nIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;ptX
+
;nX
 
:[in]  Specifies x-coordinate of the pixel to be examined.
 
:[in]  Specifies x-coordinate of the pixel to be examined.
;ptY
+
;nY
 
:[in]  Specifies y-coordinate of the pixel to be examined.
 
:[in]  Specifies y-coordinate of the pixel to be examined.
;pIndex
+
;nIndex
 
:[in]  Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.
 
:[in]  Pointer to LONG variable which will receive the index of the specified pixel's color within the page palette.
  
Line 24: Line 23:
  
 
== Remarks ==
 
== 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.  
+
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|IIXC_Page]]
:[[PXV:IIXC_Page_GetPixel|IIXC_Page::GetPixel]]
+
:[[PXV:IIXC_Page_SetPixel|IIXC_Page::SetPixel]]
+
:[[PXV:IIXC_Page_SetPixelIndex|IIXC_Page::SetPixelIndex]]
+

Latest revision as of 03: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.

See Also

IIXC_Page