ClassesClasses | | Operators

get_hsiT_get_hsiGetHsiGetHsi (Operator)


get_hsiT_get_hsiGetHsiGetHsi — Get the HSI coding of the current color.


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

Herror T_get_hsi(const Htuple WindowHandle, Htuple* Hue, Htuple* Saturation, Htuple* Intensity)

void GetHsi(const HTuple& WindowHandle, HTuple* Hue, HTuple* Saturation, HTuple* Intensity)

HTuple HWindow::GetHsi(HTuple* Saturation, HTuple* Intensity) const

static void HOperatorSet.GetHsi(HTuple windowHandle, out HTuple hue, out HTuple saturation, out HTuple intensity)

HTuple HWindow.GetHsi(out HTuple saturation, out HTuple intensity)


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


WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

HueHueHueHuehue (output_control)  integer-array HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Hue (color value) of the current color.

SaturationSaturationSaturationSaturationsaturation (output_control)  integer-array HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Saturation of the current color.

IntensityIntensityIntensityIntensityintensity (output_control)  integer-array HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Intensity of the current color.


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

See also

set_hsiset_hsiSetHsiSetHsiSetHsi, set_colorset_colorSetColorSetColorSetColor, set_rgbset_rgbSetRgbSetRgbSetRgb, trans_to_rgbtrans_to_rgbTransToRgbTransToRgbTransToRgb, trans_from_rgbtrans_from_rgbTransFromRgbTransFromRgbTransFromRgb



ClassesClasses | | Operators