IIXC_Page::AlphaTile Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::AlphaTile Method}}
 
{{#customTitle:IIXC_Page::AlphaTile Method}}
 
{{#parentPage:PXV:IIXC_Page|AlphaTile Method|method}}
 
{{#parentPage:PXV:IIXC_Page|AlphaTile Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
'''AlphaTile''' tiles a specified rectangular area from one page into another using specified level of transparency. If the alpha parameter is 255, this function is equal to function [[PXV:IIXC_Page_Tile|IIXC_Page::Tile]].
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;destRect
 
;destRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the destination rectangle.
 
;srcPage
 
;srcPage
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied.
 
;srcRect
 
;srcRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
 
;originX
 
;originX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
;originY
 
;originY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
;nAlpha
 
;nAlpha
:[in]  Value of UCHAR.
+
:[in]  Specifies the transparency level. Range of values is from 0 to 255. Value 0 means that srcPage is fully transparent, value 255 means that srcPage is fully opaque.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum [[PXV:IXC_ColorFlags|IXC_ColorFlags]].
  
 
== Return Value ==
 
== Return Value ==
Line 36: Line 35:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
See also [[PXV:IIXC_Page|IIXC_Page]], [[PXV:IIXC_Page_Tile|IIXC_Page::Tile]], [[PXV:IXC_ColorFlags|IXC_ColorFlags]].

Revision as of 22:25, 28 April 2015


AlphaTile tiles a specified rectangular area from one page into another using specified level of transparency. If the alpha parameter is 255, this function is equal to function IIXC_Page::Tile.

Syntax

HRESULT AlphaTile([in]  RECT*       destRect,
                  [in]  IIXC_Page*  srcPage,
                  [in]  RECT*       srcRect,
                  [in]  LONG        originX,
                  [in]  LONG        originY,
                  [in]  UCHAR       nAlpha,
                  [in]  ULONG       nFlags);

Parameters

destRect
[in] Pointer to RECT structure which defines the destination rectangle.
srcPage
[in] Pointer to IIXC_Page of the source page from which the area is to be copied.
srcRect
[in] Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
originX
[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
originY
[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
nAlpha
[in] Specifies the transparency level. Range of values is from 0 to 255. Value 0 means that srcPage is fully transparent, value 255 means that srcPage is fully opaque.
nFlags
[in] Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum IXC_ColorFlags.

Return Value

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

See Also

See also IIXC_Page, IIXC_Page::Tile, IXC_ColorFlags.