get_rgbT_get_rgbGetRgbGetRgbget_rgb (Operator)
Name
get_rgbT_get_rgbGetRgbGetRgbget_rgb — Get the current color in RGB-coding.
Signature
def get_rgb(window_handle: HHandle) -> Tuple[Sequence[int], Sequence[int], Sequence[int]]
Description
get_rgbget_rgbGetRgbGetRgbget_rgb 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_rgbGetRgbGetRgbget_rgb can be set with
set_rgbset_rgbSetRgbSetRgbset_rgb.
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.
Result
get_rgbget_rgbGetRgbGetRgbget_rgb returns 2 (
H_MSG_TRUE)
if the window is valid.
Otherwise an exception is raised.
Possible Successors
set_rgbset_rgbSetRgbSetRgbset_rgb,
disp_regiondisp_regionDispRegionDispRegiondisp_region,
disp_imagedisp_imageDispImageDispImagedisp_image
See also
set_rgbset_rgbSetRgbSetRgbset_rgb
Module
Foundation