get_rgbaT_get_rgbaGetRgbaGetRgba (Operator)

Name

get_rgbaT_get_rgbaGetRgbaGetRgba — Get the current color in RGBA-coding.

Signature

get_rgba( : : WindowHandle : Red, Green, Blue, Alpha)

Description

get_rgbaget_rgbaGetRgbaGetRgbaGetRgba 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_rgbaGetRgbaGetRgbaGetRgba can be set with set_rgbaset_rgbaSetRgbaSetRgbaSetRgba.

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 → (integer)

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.

AlphaAlphaAlphaAlphaalpha (output_control) integer-array → (integer)

The current color's alpha value.

Result

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

Possible Successors

set_rgbaset_rgbaSetRgbaSetRgbaSetRgba, disp_objdisp_objDispObjDispObjDispObj

Module

Foundation

Operators