get_rgbaT_get_rgbaGetRgbaGetRgbaget_rgba (Operator)
Name
get_rgbaT_get_rgbaGetRgbaGetRgbaget_rgba — Get the current color in RGBA-coding.
Signature
def get_rgba(window_handle: HHandle) -> Tuple[Sequence[int], Sequence[int], Sequence[int], Sequence[int]]
Description
get_rgbaget_rgbaGetRgbaGetRgbaGetRgbaget_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_rgbaGetRgbaGetRgbaGetRgbaget_rgba can be set with
set_rgbaset_rgbaSetRgbaSetRgbaSetRgbaset_rgba.
Attention
get_rgbaget_rgbaGetRgbaGetRgbaGetRgbaget_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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
RedRedRedRedredred (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
The current color's red value.
GreenGreenGreenGreengreengreen (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
The current color's green value.
BlueBlueBlueBlueblueblue (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
The current color's blue value.
AlphaAlphaAlphaAlphaalphaalpha (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
The current color's alpha value.
Result
get_rgbaget_rgbaGetRgbaGetRgbaGetRgbaget_rgba returns 2 (H_MSG_TRUE) if the window is valid.
Otherwise an exception is raised.
Possible Successors
set_rgbaset_rgbaSetRgbaSetRgbaSetRgbaset_rgba,
disp_objdisp_objDispObjDispObjDispObjdisp_obj
See also
set_rgbaset_rgbaSetRgbaSetRgbaSetRgbaset_rgba
Module
Foundation