Skip to content

set_rgbaSetRgbaSetRgbaset_rgbaT_set_rgba🔗

Short description🔗

set_rgbaSetRgbaSetRgbaset_rgbaT_set_rgba — Set the color definition via RGBA values.

Signature🔗

set_rgba( window WindowHandle, integer Red, integer Green, integer Blue, integer Alpha )void SetRgba( const HTuple& WindowHandle, const HTuple& Red, const HTuple& Green, const HTuple& Blue, const HTuple& Alpha )static void HOperatorSet.SetRgba( HTuple windowHandle, HTuple red, HTuple green, HTuple blue, HTuple alpha )def set_rgba( window_handle: HHandle, red: MaybeSequence[int], green: MaybeSequence[int], blue: MaybeSequence[int], alpha: MaybeSequence[int] ) -> None

Herror T_set_rgba( const Htuple WindowHandle, const Htuple Red, const Htuple Green, const Htuple Blue, const Htuple Alpha )

void HWindow::SetRgba( const HTuple& Red, const HTuple& Green, const HTuple& Blue, const HTuple& Alpha ) const

void HWindow::SetRgba( Hlong Red, Hlong Green, Hlong Blue, Hlong Alpha ) const

void HWindow.SetRgba( HTuple red, HTuple green, HTuple blue, HTuple alpha )

void HWindow.SetRgba( int red, int green, int blue, int alpha )

Description🔗

set_rgbaSetRgba sets the output color(s) or the gray values, respectively, for region output for the window. The colors are defined with the red, green, blue, and alpha components. If only one combination is passed, all output takes place in that color. If a tuple is passed, region output and output of geometric objects takes place modulo the passed colors.

For every call of an output operator, output is started with the first color. If only one object is displayed per call, it will always be displayed in the first color. This is even true for objects with multiple connection components. If multiple objects are displayed per operator call, multiple colors are used. The defined colors are used until set_colorSetColor, set_rgbaSetRgba, or set_rgbSetRgb is called again. The values are used by operators like disp_regionDispRegion, disp_lineDispLine, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2, disp_arrowDispArrow, etc.

Attention🔗

set_rgbaSetRgba 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 (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Red component of the color.

Default: 255255
Value range: 0 ≤ Red ≤ 255
Restriction: 0 <= Red && Red <= 255

Greengreengreen (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Green component of the color.

Default: 00
Value range: 0 ≤ Green ≤ 255
Restriction: 0 <= Green && Green <= 255

Blueblueblue (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Blue component of the color.

Default: 00
Value range: 0 ≤ Blue ≤ 255
Restriction: 0 <= Blue && Blue <= 255

Alphaalphaalpha (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Alpha component of the color.

Default: 255255
Value range: 0 ≤ Alpha ≤ 255
Restriction: 0 <= Alpha && Alpha <= 255

Result🔗

set_rgbaSetRgba returns 2 (H_MSG_TRUE) if the window is valid and all passed colors are available and displayable. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible successors

disp_objDispObj

Alternatives

set_rgbSetRgb, set_colorSetColor

Module🔗

Foundation