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

get_rgbaT_get_rgbaGetRgbaGetRgba (Operator)

Name

get_rgbaT_get_rgbaGetRgbaGetRgba — Get the current color in RGBA-coding.

Signature

get_rgba( : : WindowHandle : Red, Green, Blue, Alpha)

Herror T_get_rgba(const Htuple WindowHandle, Htuple* Red, Htuple* Green, Htuple* Blue, Htuple* Alpha)

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

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

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

void HWindow.GetRgba(out HTuple red, out HTuple green, out HTuple blue, out HTuple alpha)

Description

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

The values returned by get_rgbaget_rgbaGetRgbaGetRgbaGetRgba can be set with set_rgbaset_rgbaSetRgbaSetRgbaSetRgba.

Attention

get_rgbaget_rgbaGetRgbaGetRgbaGetRgba depends on the library libcanvas, which might not be available on embedded systems.

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.

AlphaAlphaAlphaAlphaalpha (output_control)  integer-array → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The current color's alpha value.

Result

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

Possible Successors

set_rgbaset_rgbaSetRgbaSetRgbaSetRgba, disp_objdisp_objDispObjDispObjDispObj

See also

set_rgbaset_rgbaSetRgbaSetRgbaSetRgba

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 19.05.0.0 Copyright © 1996-2019 MVTec Software GmbH