get_rgbT_get_rgbGetRgbGetRgb (Operator)

Name

get_rgbT_get_rgbGetRgbGetRgb — Get the current color in RGB-coding.

Signature

get_rgb( : : WindowHandle : Red, Green, Blue)

Herror T_get_rgb(const Htuple WindowHandle, Htuple* Red, Htuple* Green, Htuple* Blue)

void GetRgb(const HTuple& WindowHandle, HTuple* Red, HTuple* Green, HTuple* Blue)

void HWindow::GetRgb(HTuple* Red, HTuple* Green, HTuple* Blue) const

static void HOperatorSet.GetRgb(HTuple windowHandle, out HTuple red, out HTuple green, out HTuple blue)

void HWindow.GetRgb(out HTuple red, out HTuple green, out HTuple blue)

Description

get_rgbget_rgbGetRgbGetRgbGetRgb returns the output colors or gray values, respectively, for the output window. They are defined by the three color components red, green and blue.

The values returned by get_rgbget_rgbGetRgbGetRgbGetRgb can be set with set_rgbset_rgbSetRgbSetRgbSetRgb.

Execution Information

Parameters

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

Window handle.

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

The current color's red value.

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

The current color's green value.

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

The current color's blue value.

Result

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

Possible Successors

set_rgbset_rgbSetRgbSetRgbSetRgb, disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_imagedisp_imageDispImageDispImageDispImage

See also

set_rgbset_rgbSetRgbSetRgbSetRgb

Module

Foundation