IIXC_Page::AdjustHLS Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::AdjustHLS Method}}
 
{{#customTitle:IIXC_Page::AdjustHLS Method}}
 
{{#parentPage:PXV:IIXC_Page|AdjustHLS Method|method}}
 
{{#parentPage:PXV:IIXC_Page|AdjustHLS Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method sets Hue, Lightness, and Saturation components for an image page or selected rectangular area using the HLS color model.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;nHue
 
;nHue
:[in]  Value of double.
+
:[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
 
;nLightness
:[in]  Value of double.
+
:[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.
 
;nSaturation
 
;nSaturation
:[in]  Value of double.
+
:[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.
+
:[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.}}
  
 
== Return Value ==
 
== Return Value ==
Line 27: Line 28:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]].

Revision as of 06:40, 29 April 2015


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

Syntax

HRESULT AdjustHLS([in]                      double  nHue,
                  [in]                      double  nLightness,
                  [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.
nLightness
[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.
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 contains not the color, but the index into color table (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.