IIXC_Page::AlphaTile Method

From Tracker Software PDF SDK
Jump to: navigation, search
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}}
{{ToReview}}
 
 
__NOTOC__
 
__NOTOC__
  
'''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]].
+
The '''AlphaTile''' method 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 28: Line 27:
 
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
:[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]  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.
+
:[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. If the alpha parameter is 255, this function is equal to function [[PXV:IIXC_Page_Tile|IIXC_Page::Tile]].
 
;nFlags
 
;nFlags
 
:[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]].
 
:[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]].

Revision as of 09:57, 17 May 2015


The AlphaTile method 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. If the alpha parameter is 255, this function is equal to function IIXC_Page::Tile.
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

IIXC_Page
IIXC_Page::Place
IIXC_Page::AlphaPlace
IIXC_Page::Tile
IXC_ColorFlags