IIXC_Page::FilterNoise 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 FilterNoise([in]  RECT*  Rect,
+
<pre class="brush:cpp;gutter:false">HRESULT FilterNoise([in]  RECT*  stRect,
                     [in]  ULONG  Level,
+
                     [in]  ULONG  nLevel,
                     [in]  ULONG  Flags);</pre>
+
                     [in]  ULONG  nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Rect
+
;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.
 
:[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}}
 
{{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}}
;Level
+
;nLevel
 
:[in]  Specifies noise level.
 
:[in]  Specifies noise level.
;Flags
+
;nFlags
 
:[in]  Specifies the type of the filter. Could be one of the following [[PXV:IXC_NoiseType|Noise types]].
 
:[in]  Specifies the type of the filter. Could be one of the following [[PXV:IXC_NoiseType|Noise types]].
  

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