IIXC_Page::Histogramm Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::Histogramm Method}}
 
{{#customTitle:IIXC_Page::Histogramm Method}}
{{#parentPage:PXV:IIXC_Page#Methods|Histogramm Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|Histogramm|method}}
  
 
The '''Histogramm''' method returns histogram(s) for one or more color channels for the entire page or a selected rectangular area.
 
The '''Histogramm''' method returns histogram(s) for one or more color channels for the entire page or a selected rectangular area.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Histogramm([in, out]  ULONG*  pRed,
+
<pre class="brush:cpp;gutter:false">HRESULT Histogramm([in, out]  ULONG*  nRed,
                   [in, out]  ULONG*  pGreen,
+
                   [in, out]  ULONG*  nGreen,
                   [in, out]  ULONG*  pBlue,
+
                   [in, out]  ULONG*  nBlue,
                   [in, out]  ULONG*  pGray,
+
                   [in, out]  ULONG*  nGray,
                   [in]      RECT*  pRect);</pre>
+
                   [in]      RECT*  stRect);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pRed
+
;nRed
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the red channel.
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the red channel.
;pGreen
+
;nGreen
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the green channel.
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the green channel.
;pBlue
+
;nBlue
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the blue channel.
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the blue channel.
;pGray
+
;nGray
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the gray channel.
 
:[in, out]  Pointer to an array of ULONGs that receives the histogram for the gray channel.
;pRect
+
;stRect
 
:[in]  Pointer to RECT structure which defines the rectangular area for which color histograms will be calculated. If this parameter is NULL, the entire page will be used.
 
:[in]  Pointer to RECT structure which defines the rectangular area for which color histograms will be calculated. If this parameter is NULL, the entire page will be used.
  
Line 32: Line 32:
  
 
== See Also ==
 
== See Also ==
 +
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 02:16, 15 June 2015

The Histogramm method returns histogram(s) for one or more color channels for the entire page or a selected rectangular area.

Syntax

HRESULT Histogramm([in, out]  ULONG*  nRed,
                   [in, out]  ULONG*  nGreen,
                   [in, out]  ULONG*  nBlue,
                   [in, out]  ULONG*  nGray,
                   [in]       RECT*   stRect);

Parameters

nRed
[in, out] Pointer to an array of ULONGs that receives the histogram for the red channel.
nGreen
[in, out] Pointer to an array of ULONGs that receives the histogram for the green channel.
nBlue
[in, out] Pointer to an array of ULONGs that receives the histogram for the blue channel.
nGray
[in, out] Pointer to an array of ULONGs that receives the histogram for the gray channel.
stRect
[in] Pointer to RECT structure which defines the rectangular area for which color histograms will be calculated. If this parameter is NULL, the entire page will be used.

Return Value

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

Remarks

All UINT arrays passed to the function must have at least 256 items. If one or more histograms isn't needed, the corresponding parameter can be set to NULL.

See Also

IIXC_Page