Skip to content

get_rgbGetRgbGetRgbget_rgbT_get_rgb🔗

Short description🔗

get_rgbGetRgbGetRgbget_rgbT_get_rgb — Get the current color in RGB-coding.

Signature🔗

get_rgb( window WindowHandle, out integer Red, out integer Green, out integer Blue )void GetRgb( const HTuple& WindowHandle, HTuple* Red, HTuple* Green, HTuple* Blue )static void HOperatorSet.GetRgb( HTuple windowHandle, out HTuple red, out HTuple green, out HTuple blue )def get_rgb( window_handle: HHandle ) -> Tuple[Sequence[int], Sequence[int], Sequence[int]]

Herror T_get_rgb( const Htuple WindowHandle, Htuple* Red, Htuple* Green, Htuple* Blue )

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

void HWindow.GetRgb( out HTuple red, out HTuple green, out HTuple blue )

Description🔗

get_rgbGetRgb 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_rgbGetRgb can be set with set_rgbSetRgb.

Execution information🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Redredred (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

The current color’s red value.

Greengreengreen (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

The current color’s green value.

Blueblueblue (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

The current color’s blue value.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_rgbSetRgb, disp_regionDispRegion, disp_imageDispImage

See also

set_rgbSetRgb

Module🔗

Foundation