Skip to content

get_rgbaGetRgbaGetRgbaget_rgbaT_get_rgba🔗

Short description🔗

get_rgbaGetRgbaGetRgbaget_rgbaT_get_rgba — Get the current color in RGBA-coding.

Signature🔗

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

Herror T_get_rgba( const Htuple WindowHandle, Htuple* Red, Htuple* Green, Htuple* Blue, Htuple* Alpha )

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

void HWindow.GetRgba( out HTuple red, out HTuple green, out HTuple blue, out HTuple alpha )

Description🔗

get_rgbaGetRgba 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_rgbaGetRgba can be set with set_rgbaSetRgba.

Attention🔗

get_rgbaGetRgba depends on the library libcanvas, which might not be available on embedded systems.

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.

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

The current color’s alpha value.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_rgbaSetRgba, disp_objDispObj

See also

set_rgbaSetRgba

Module🔗

Foundation