IIXC_Page::AdjustHLS Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#parentPage:PXV:IIXC_Page|AdjustHLS Method|method}}
 
{{#parentPage:PXV:IIXC_Page|AdjustHLS Method|method}}
  
{{ToReview}}
 
  
The method sets Hue, Lightness, and Saturation components for an image page or selected rectangular area using the HLS color model.
+
The '''AdjustHLS''' method sets ''Hue'', ''Brightness'', and ''Saturation'' components for an image page or selected rectangular area using the HLS color model.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT AdjustHLS([in]                      double  nHue,
 
<pre class="brush:cpp;gutter:false">HRESULT AdjustHLS([in]                      double  nHue,
                   [in]                      double  nLightness,
+
                   [in]                      double  nBrightness,
 
                   [in]                      double  nSaturation,
 
                   [in]                      double  nSaturation,
 
                   [in, defaultvalue(NULL)]  RECT*  pRect);</pre>
 
                   [in, defaultvalue(NULL)]  RECT*  pRect);</pre>
Line 16: Line 15:
 
;nHue
 
;nHue
 
:[in]  Specifies the Hue level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
 
:[in]  Specifies the Hue level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
;nLightness
+
;nBrightness
:[in]  Specifies the Lightness level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
+
:[in]  Specifies the Brightness level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
 
;nSaturation
 
;nSaturation
 
:[in]  Specifies the Saturation level to be applied to the page or its part. The range of the value is from -180 to +180.
 
:[in]  Specifies the Saturation level to be applied to the page or its part. The range of the value is from -180 to +180.
 
;pRect
 
;pRect
 
:[in, defaultvalue(NULL)]  Pointer to 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, defaultvalue(NULL)]  Pointer to 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 processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because each pixel in such images contains not the color, but the index into color table (palette) which is common for the entire page.}}
+
{{note|Please note that processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because each pixel in such images does not contain the color, but an index into a color table (or palette) which is common for the entire page.}}
  
 
== Return Value ==
 
== Return Value ==

Revision as of 09:52, 17 May 2015


The AdjustHLS method sets Hue, Brightness, and Saturation components for an image page or selected rectangular area using the HLS color model.

Syntax

HRESULT AdjustHLS([in]                      double  nHue,
                  [in]                      double  nBrightness,
                  [in]                      double  nSaturation,
                  [in, defaultvalue(NULL)]  RECT*   pRect);

Parameters

nHue
[in] Specifies the Hue level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
nBrightness
[in] Specifies the Brightness level to be applied to the page or its part. The range of the value is from -1.0 to +1.0.
nSaturation
[in] Specifies the Saturation level to be applied to the page or its part. The range of the value is from -180 to +180.
pRect
[in, defaultvalue(NULL)] Pointer to 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 processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because each pixel in such images does not contain the color, but an index into a color table (or palette) which is common for the entire page.

Return Value

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

See Also

IIXC_Page.