IIXC_Page::AdjustHLS Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::AdjustHLS Method}} | {{#customTitle:IIXC_Page::AdjustHLS Method}} | ||
| − | {{#parentPage:PXV:IIXC_Page|method | + | {{#parentPage:PXV:IIXC_Page#Methods|AdjustHLS|method}} |
| − | + | ||
| − | + | ||
| − | The method | + | The '''AdjustHLS''' method sets ''nHue'', ''Brightness'', and ''nSaturation'' 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, [in] double nLightness, [in] double nSaturation, [in, defaultvalue(NULL)] RECT* | + | <pre class="brush:cpp;gutter:false">HRESULT AdjustHLS([in] double nHue, |
| + | [in] double nLightness, | ||
| + | [in] double nSaturation, | ||
| + | [in, defaultvalue(NULL)] RECT* stRect);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nHue |
| − | :[in] | + | :[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] | + | :[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] | + | :[in] Specifies the Saturation level to be applied to the page or its part. The range of the value is from -180 to +180. |
| − | ; | + | ;stRect |
| − | :[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 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 == | ||
| Line 24: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
Latest revision as of 02:16, 15 June 2015
The AdjustHLS method sets nHue, Brightness, and nSaturation 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* stRect);
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 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.
- stRect
- [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.
