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)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::AlphaTile Method}}
 
{{#customTitle:IIXC_Page::AlphaTile Method}}
 +
{{#parentPage:PXV:IIXC_Page#Methods|AlphaTile|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
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 ==
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in] RECT* destRect, [in] IIXC_Page* srcPage, [in] RECT* srcRect, [in] LONG originX, [in] LONG originY, [in] UCHAR nAlpha, [in] ULONG nFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in] RECT*       stDestRect,
 +
                  [in] IIXC_Page* pSrcPage,
 +
                  [in] RECT*       stSrcRect,
 +
                  [in] LONG       nOriginX,
 +
                  [in] LONG       nOriginY,
 +
                  [in] UCHAR       nAlpha,
 +
                  [in] ULONG       nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''destRect''
+
;stDestRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the destination rectangle.
;''srcPage''
+
;pSrcPage
:[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''
+
;stSrcRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
;''originX''
+
;nOriginX
:[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''
+
;nOriginY
:[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. If the alpha parameter is 255, this function is equal to function [[PXV:IIXC_Page_Tile|IIXC_Page::Tile]].
;''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 27: Line 35:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 03:16, 15 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*       stDestRect,
                  [in]  IIXC_Page*  pSrcPage,
                  [in]  RECT*       stSrcRect,
                  [in]  LONG        nOriginX,
                  [in]  LONG        nOriginY,
                  [in]  UCHAR       nAlpha,
                  [in]  ULONG       nFlags);

Parameters

stDestRect
[in] Pointer to RECT structure which defines the destination rectangle.
pSrcPage
[in] Pointer to IIXC_Page of the source page from which the area is to be copied.
stSrcRect
[in] Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto destPage page.
nOriginX
[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
nOriginY
[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