HALCON Website / HALCON Operator Reference / Graphics / Parameters
ClassesClassesClassesClasses | | | | Operators

get_rgbT_get_rgbGetRgbget_rgbGetRgbGetRgb (Operator)

Name

get_rgbT_get_rgbGetRgbget_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)

Herror get_rgb(const HTuple& WindowHandle, HTuple* Red, HTuple* Green, HTuple* Blue)

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

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

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

void HOperatorSetX.GetRgb(
[in] VARIANT WindowHandle, [out] VARIANT* Red, [out] VARIANT* Green, [out] VARIANT* Blue)

VARIANT HWindowX.GetRgb(
[out] VARIANT* Green, [out] VARIANT* Blue)

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_rgbGetRgbget_rgbGetRgbGetRgb 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_rgbGetRgbget_rgbGetRgbGetRgb can be set with set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb.

Parallelization

Parameters

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

Window handle.

RedRedRedRedRedred (output_control)  integer-array → HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's red value.

GreenGreenGreenGreenGreengreen (output_control)  integer-array → HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's green value.

BlueBlueBlueBlueBlueblue (output_control)  integer-array → HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's blue value.

Result

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

Possible Successors

set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage

See also

set_rgbset_rgbSetRgbset_rgbSetRgbSetRgb

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 13.0.4 Copyright © 1996-2019 MVTec Software GmbH