IIXC_Page::SetPixel Method

From PDF XChange PDF SDK
Jump to: navigation, search
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::SetPixel Method}}
 
{{#customTitle:IIXC_Page::SetPixel Method}}
{{#parentPage:PXV:IIXC_Page|SetPixel Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|SetPixel|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
The '''SetPixel''' method sets the color of the specified pixel in the page.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT SetPixel([in]  LONG  ptX,
+
<pre class="brush:cpp;gutter:false">HRESULT SetPixel([in]  LONG  nX,
                 [in]  LONG  ptY,
+
                 [in]  LONG  nY,
 
                 [in]  ULONG  nColor,
 
                 [in]  ULONG  nColor,
 
                 [in]  ULONG  nFlags);</pre>
 
                 [in]  ULONG  nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;ptX
+
;nX
:[in]  Value of LONG.
+
:[in]  Specifies the X coordinate of the pixel. The value should be in the range (0, Width - 1), where Width is the width of the image.
;ptY
+
;nY
:[in]  Value of LONG.
+
:[in]  Specifies the Y coordinate of the pixel. The value should be in the range (0, Height - 1), where Height is the height of the image.
 
;nColor
 
;nColor
:[in]  Value of ULONG.
+
:[in]  Specifies the new color of the pixel.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Combination of [[PXV:IXC_ColorFlags|IXC_ColorFlags]] which specifies how the data will be copied.
  
 
== Return Value ==
 
== Return Value ==
Line 27: Line 26:
  
 
== See Also ==
 
== See Also ==
:[[PXV:IIXC_Page|IIXC_Page]]
+
[[PXV:IIXC_Page|IIXC_Page]]
:[[PXV:IIXC_Page_GetPixel|IIXC_Page::GetPixel]]
+
:[[PXV:IIXC_Page_GetPixelIndex|IIXC_Page::GetPixelIndex]]
+
:[[PXV:IIXC_Page_SetPixelIndex|IIXC_Page::SetPixelIndex]]
+

Latest revision as of 03:17, 15 June 2015

The SetPixel method sets the color of the specified pixel in the page.

Syntax

HRESULT SetPixel([in]  LONG   nX,
                 [in]  LONG   nY,
                 [in]  ULONG  nColor,
                 [in]  ULONG  nFlags);

Parameters

nX
[in] Specifies the X coordinate of the pixel. The value should be in the range (0, Width - 1), where Width is the width of the image.
nY
[in] Specifies the Y coordinate of the pixel. The value should be in the range (0, Height - 1), where Height is the height of the image.
nColor
[in] Specifies the new color of the pixel.
nFlags
[in] Combination of IXC_ColorFlags which specifies how the data will be copied.

Return Value

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

See Also

IIXC_Page