get_rgbT_get_rgbGetRgbGetRgb (Operator)

Name

get_rgbT_get_rgbGetRgbGetRgb — Get the current color in RGB-coding.

Signature

get_rgb( : : WindowHandle : Red, Green, Blue)

Description

get_rgbget_rgbGetRgbGetRgbGetRgb 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_rgbGetRgbGetRgbGetRgb can be set with set_rgbset_rgbSetRgbSetRgbSetRgb.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

RedRedRedRedred (output_control) integer-array → (integer)

The current color's red value.

GreenGreenGreenGreengreen (output_control) integer-array → (integer)

The current color's green value.

BlueBlueBlueBlueblue (output_control) integer-array → (integer)

The current color's blue value.

Result

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

Possible Successors

set_rgbset_rgbSetRgbSetRgbSetRgb, disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_imagedisp_imageDispImageDispImageDispImage

Module

Foundation

Operators