IIXC_Page::Rop3 Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method combines up to three images in different ways using the raster operations codes (ROP3).
  
 
== Syntax ==
 
== Syntax ==
Line 22: Line 22:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT specifies the rectangular area on the destination page which will be affected. If NULL then the entire page will be used.
 
;srcFrom
 
;srcFrom
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in]  Specifies the [[PXV:IIXC_Page|IIXC_Page]] of the source page. This parameter can be NULL (see Comments for details).  
 
;srcX
 
;srcX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate of the left-top corner of the affected rectangle in the source page.
 
;srcY
 
;srcY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate of the left-top corner of the affected rectangle in the source page.
 
;srcColor
 
;srcColor
:[in]  Value of ULONG.
+
:[in]  Specifies the color which should be used if pSource is NULL.
 
;pPattern
 
;pPattern
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in]  Specifies the [[PXV:IIXC_Page|IIXC_Page]] of the pattern page. This parameter can be NULL (see Comments for details).  
 
;patX
 
;patX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate of the left-top corner of the affected rectangle in pattern page.
 
;patY
 
;patY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate of the left-top corner of the affected rectangle in pattern page.
 
;patColor
 
;patColor
:[in]  Value of ULONG.
+
:[in]  Specifies the color which should be used if pPattern is NULL.
 
;ropCode
 
;ropCode
:[in]  Value of UCHAR.
+
:[in]  Specifies a ternary raster-operation value. This value determines how BitBlt combines corresponding pixels from the source, destination, and pattern that is used to produce the final pixels in the destination rectangle. This parameter can be any one of 256 ternary raster-operation values; the following lists the most common values.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Combination of [[PXV:IXC_FilterFlags|flags]] which specifies how the data will be processed.
  
 
== 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.
 +
 +
== Comments ==
 +
 +
{{note|In the current implementation this page should have one of following internal formats: PageFormat_8Gray, PageFormat_8AlphaGray, PageFormat_8RGB, PageFormat_8ARGB.}}
 +
 +
 +
Most raster operations combine all three pages - Destination, Source and Pattern, but some of them do not use Source or Pattern, or either of them. Also, sometimes Source or Pattern are "solid" pages filled by one color. So IMG_PageRop3 supports one extension - if Source or Pattern (or both) handles are NULL the corresponding color will be used for each pixel, instead of getting the pixel value from the page.
 +
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IIXC_Page|IIXC_Page]].
 
See also [[PXV:IIXC_Page|IIXC_Page]].

Revision as of 07:00, 6 May 2015


The method combines up to three images in different ways using the raster operations codes (ROP3).

Syntax

HRESULT Rop3([in]  RECT*       pRect,
             [in]  IIXC_Page*  srcFrom,
             [in]  LONG        srcX,
             [in]  LONG        srcY,
             [in]  ULONG       srcColor,
             [in]  IIXC_Page*  pPattern,
             [in]  LONG        patX,
             [in]  LONG        patY,
             [in]  ULONG       patColor,
             [in]  UCHAR       ropCode,
             [in]  ULONG       nFlags);

Parameters

pRect
[in] Pointer to RECT specifies the rectangular area on the destination page which will be affected. If NULL then the entire page will be used.
srcFrom
[in] Specifies the IIXC_Page of the source page. This parameter can be NULL (see Comments for details).
srcX
[in] Specifies the x-coordinate of the left-top corner of the affected rectangle in the source page.
srcY
[in] Specifies the y-coordinate of the left-top corner of the affected rectangle in the source page.
srcColor
[in] Specifies the color which should be used if pSource is NULL.
pPattern
[in] Specifies the IIXC_Page of the pattern page. This parameter can be NULL (see Comments for details).
patX
[in] Specifies the x-coordinate of the left-top corner of the affected rectangle in pattern page.
patY
[in] Specifies the y-coordinate of the left-top corner of the affected rectangle in pattern page.
patColor
[in] Specifies the color which should be used if pPattern is NULL.
ropCode
[in] Specifies a ternary raster-operation value. This value determines how BitBlt combines corresponding pixels from the source, destination, and pattern that is used to produce the final pixels in the destination rectangle. This parameter can be any one of 256 ternary raster-operation values; the following lists the most common values.
nFlags
[in] Combination of flags which specifies how the data will be processed.

Return Value

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

Comments

Note:
In the current implementation this page should have one of following internal formats: PageFormat_8Gray, PageFormat_8AlphaGray, PageFormat_8RGB, PageFormat_8ARGB.


Most raster operations combine all three pages - Destination, Source and Pattern, but some of them do not use Source or Pattern, or either of them. Also, sometimes Source or Pattern are "solid" pages filled by one color. So IMG_PageRop3 supports one extension - if Source or Pattern (or both) handles are NULL the corresponding color will be used for each pixel, instead of getting the pixel value from the page.


See Also

See also IIXC_Page.