IIXC_Page::FilterNoise Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::FilterNoise Method}}
 
{{#customTitle:IIXC_Page::FilterNoise Method}}
 +
{{#parentPage:PXV:IIXC_Page#Methods|FilterNoise|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method applies Noise filter to the image page or its specified area.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FilterNoise([in] RECT* pRect, [in] ULONG nLevel, [in] ULONG nFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FilterNoise([in] RECT* stRect,
 +
                    [in] ULONG nLevel,
 +
                    [in] ULONG nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pRect''
+
;stRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to the RECT structure which defines the rectangular area where the function should be applied. If this parameter is NULL, the entire page will be processed.
;''nLevel''
+
{{note|Please note that partial processing of an area of a page is not supported for all image formats. For example, it is not supported for indexed images, because pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page}}
:[in]  Value of ULONG.
+
;nLevel
;''nFlags''
+
:[in]  Specifies noise level.
:[in]  Value of ULONG.
+
;nFlags
 +
:[in]  Specifies the type of the filter. Could be one of the following [[PXV:IXC_NoiseType|Noise types]].
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== 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 method applies Noise filter to the image page or its specified area.

Syntax

HRESULT FilterNoise([in]  RECT*  stRect,
                    [in]  ULONG  nLevel,
                    [in]  ULONG  nFlags);

Parameters

stRect
[in] Pointer to the RECT structure which defines the rectangular area where the function should be applied. If this parameter is NULL, the entire page will be processed.
Note:
Please note that partial processing of an area of a page is not supported for all image formats. For example, it is not supported for indexed images, because pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page
nLevel
[in] Specifies noise level.
nFlags
[in] Specifies the type of the filter. Could be one of the following Noise types.

Return Value

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

See Also

IIXC_Page