ClassesClassesClassesClasses | | | | Operators

get_hsiT_get_hsiGetHsiget_hsiGetHsiGetHsi (Operator)

Name

get_hsiT_get_hsiGetHsiget_hsiGetHsiGetHsi — Get the HSI coding of the current color.

Signature

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

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

Herror get_hsi(const HTuple& WindowHandle, HTuple* Hue, HTuple* Saturation, HTuple* Intensity)

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

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

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

void HOperatorSetX.GetHsi(
[in] VARIANT WindowHandle, [out] VARIANT* Hue, [out] VARIANT* Saturation, [out] VARIANT* Intensity)

VARIANT HWindowX.GetHsi(
[out] VARIANT* Saturation, [out] VARIANT* Intensity)

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

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

Description

get_hsiget_hsiGetHsiget_hsiGetHsiGetHsi returns the output color or gray values, respectively, for the window, described in HueHueHueHueHuehue, SaturationSaturationSaturationSaturationSaturationsaturation and IntensityIntensityIntensityIntensityIntensityintensity. The values returned by get_hsiget_hsiGetHsiget_hsiGetHsiGetHsi can be set with set_hsiset_hsiSetHsiset_hsiSetHsiSetHsi.

Attention

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

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window handle.

HueHueHueHueHuehue (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Hue (color value) of the current color.

SaturationSaturationSaturationSaturationSaturationsaturation (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Saturation of the current color.

IntensityIntensityIntensityIntensityIntensityintensity (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Intensity of the current color.

Result

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

Possible Successors

set_hsiset_hsiSetHsiset_hsiSetHsiSetHsi, set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage

See also

set_hsiset_hsiSetHsiset_hsiSetHsiSetHsi, set_colorset_colorSetColorset_colorSetColorSetColor, set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb, trans_to_rgbtrans_to_rgbTransToRgbtrans_to_rgbTransToRgbTransToRgb, trans_from_rgbtrans_from_rgbTransFromRgbtrans_from_rgbTransFromRgbTransFromRgb

Module

Foundation


ClassesClassesClassesClasses | | | | Operators