IIXC_Page::AlphaTile Method

From PDF XChange PDF SDK
Jump to: navigation, search
(See Also)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 4 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|AlphaTile Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|AlphaTile|method}}
{{ToReview}}
+
  
'''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 ==
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in]  RECT*      destRect,
+
<pre class="brush:cpp;gutter:false">HRESULT AlphaTile([in]  RECT*      stDestRect,
                   [in]  IIXC_Page*  srcPage,
+
                   [in]  IIXC_Page*  pSrcPage,
                   [in]  RECT*      srcRect,
+
                   [in]  RECT*      stSrcRect,
                   [in]  LONG        originX,
+
                   [in]  LONG        nOriginX,
                   [in]  LONG        originY,
+
                   [in]  LONG        nOriginY,
 
                   [in]  UCHAR      nAlpha,
 
                   [in]  UCHAR      nAlpha,
 
                   [in]  ULONG      nFlags);</pre>
 
                   [in]  ULONG      nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;destRect
+
;stDestRect
 
:[in]  Pointer to RECT structure which defines the destination rectangle.
 
:[in]  Pointer to RECT structure which defines the destination rectangle.
;srcPage
+
;pSrcPage
 
:[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.
;srcRect
+
;stSrcRect
 
:[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.
;originX
+
;nOriginX
 
:[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.
;originY
+
;nOriginY
 
:[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]].
Line 35: Line 35:
  
 
== See Also ==
 
== See Also ==
:[[PXV:IIXC_Page|IIXC_Page]]
+
[[PXV:IIXC_Page|IIXC_Page]]
:[[PXV:IIXC_Page_Place|IIXC_Page::Place]]
+
:[[PXV:IIXC_Page_AlphaPlace|IIXC_Page::AlphaPlace]]
+
:[[PXV:IIXC_Page_Tile|IIXC_Page::Tile]]
+
:[[PXV:IXC_ColorFlags|IXC_ColorFlags]]
+

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