Operator Reference

HALCON Operator Reference / Graphics / Parameters

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_rgbaT_get_rgbaGetRgbaGetRgbaget_rgba (Operator)

get_rgbaT_get_rgbaGetRgbaGetRgbaget_rgba — 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)

def get_rgba(window_handle: HHandle) -> Tuple[Sequence[int], Sequence[int], Sequence[int], Sequence[int]]

Description

get_rgbaget_rgbaGetRgbaGetRgbaget_rgba 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_rgbaGetRgbaGetRgbaget_rgba can be set with set_rgbaset_rgbaSetRgbaSetRgbaset_rgba.

Attention

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

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RedRedRedredred (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The current color's red value.

GreenGreenGreengreengreen (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The current color's green value.

BlueBlueBlueblueblue (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The current color's blue value.

AlphaAlphaAlphaalphaalpha (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The current color's alpha value.

Result

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

Possible Successors

set_rgbaset_rgbaSetRgbaSetRgbaset_rgba, disp_objdisp_objDispObjDispObjdisp_obj

See also

set_rgbaset_rgbaSetRgbaSetRgbaset_rgba

Module

Foundation

---

ClassesClasses | | Operators