IIXC_Page::AlphaTile Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in]  RECT*      stDestRect,
+
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in]  RECT*      destRect,
                   [in]  IIXC_Page*  pSrcPage,
+
                   [in]  IIXC_Page*  srcPage,
                   [in]  RECT*      stSrcRect,
+
                   [in]  RECT*      srcRect,
                   [in]  LONG        nOriginX,
+
                   [in]  LONG        originX,
                   [in]  LONG        nOriginY,
+
                   [in]  LONG        originY,
                   [in]  UCHAR      nAlpha,
+
                   [in]  UCHAR      Alpha,
                   [in]  ULONG      nFlags);</pre>
+
                   [in]  ULONG      Flags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;stDestRect
+
;destRect
 
:[in]  Pointer to RECT structure which defines the destination rectangle.
 
:[in]  Pointer to RECT structure which defines the destination rectangle.
;pSrcPage
+
;srcPage
 
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied.
 
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied.
;stSrcRect
+
;srcRect
 
:[in]  Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
 
:[in]  Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
;nOriginX
+
;originX
 
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
;nOriginY
+
;originY
 
:[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
+
;Alpha
 
:[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]].
 
:[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
+
;Flags
 
:[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 06:50, 12 June 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       Alpha,
                  [in]  ULONG       Flags);

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.
Alpha
[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.
Flags
[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