get_hsiT_get_hsiGetHsiGetHsi (Operator)

Name

get_hsiT_get_hsiGetHsiGetHsi — Get the HSI coding of the current color.

Signature

get_hsi( : : WindowHandle : Hue, Saturation, Intensity)

Description

get_hsiget_hsiGetHsiGetHsiGetHsi returns the output color or gray values, respectively, for the window, described in HueHueHueHuehue, SaturationSaturationSaturationSaturationsaturation and IntensityIntensityIntensityIntensityintensity. The values returned by get_hsiget_hsiGetHsiGetHsiGetHsi can be set with set_hsiset_hsiSetHsiSetHsiSetHsi.

The values returned by get_hsiget_hsiGetHsiGetHsiGetHsi may be inaccurate due to rounding errors. They do not necessarily match the values set with set_hsiset_hsiSetHsiSetHsiSetHsi exactly (colors are stored in RGB internally).

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

HueHueHueHuehue (output_control) integer-array → (integer)

Hue (color value) of the current color.

SaturationSaturationSaturationSaturationsaturation (output_control) integer-array → (integer)

Saturation of the current color.

IntensityIntensityIntensityIntensityintensity (output_control) integer-array → (integer)

Intensity of the current color.

Result

get_hsiget_hsiGetHsiGetHsiGetHsi returns 2 (H_MSG_TRUE), if the window is valid. Otherwise an exception is raised.

Possible Successors

set_hsiset_hsiSetHsiSetHsiSetHsi, set_rgbset_rgbSetRgbSetRgbSetRgb, disp_imagedisp_imageDispImageDispImageDispImage

Module

Foundation

Operators