IIXC_Page::SetPixel Method

Revision as of 06:12, 30 April 2015

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

HRESULT SetPixel([in]  LONG   ptX,
                 [in]  LONG   ptY,
                 [in]  ULONG  nColor,
                 [in]  ULONG  nFlags);

ptX: [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: [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 flags which specifies how the data will be copied.

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

@@ Line 5: / Line 5: @@
 {{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+The method sets the color of the specified pixel in the page.
 == Syntax ==
@@ Line 15: / Line 15: @@
 == Parameters ==
 ;ptX
-:[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
-:[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
-:[in]  Value of ULONG.
+:[in]  Specifies the new color of the pixel.
 ;nFlags
-:[in]  Value of ULONG.
+:[in]  Combination of [[PXV:IXC_ColorFlags|flags]] which specifies how the data will be copied.
 == Return Value ==
@@ Line 31: / Line 31: @@
 :[[PXV:IIXC_Page_GetPixelIndex|IIXC_Page::GetPixelIndex]]
 :[[PXV:IIXC_Page_SetPixelIndex|IIXC_Page::SetPixelIndex]]
+[[PXV:IXC_ColorFlags|IXC_ColorFlags]]