set_rgbaT_set_rgbaSetRgbaSetRgba (Operator)

Name

set_rgbaT_set_rgbaSetRgbaSetRgba — Set the color definition via RGBA values.

Signature

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

Description

set_rgbaset_rgbaSetRgbaSetRgbaSetRgba 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_colorset_colorSetColorSetColorSetColor, set_rgbaset_rgbaSetRgbaSetRgbaSetRgba, or set_rgbset_rgbSetRgbSetRgbSetRgb is called again. The values are used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2DispRectangle2, disp_arrowdisp_arrowDispArrowDispArrowDispArrow, etc.

Attention

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

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

Red component of the color.

Default value: 255

Typical range of values: 0 ≤ Red Red Red Red red ≤ 255

Restriction: 0 <= Red && Red <= 255

GreenGreenGreenGreengreen (input_control) integer(-array) → (integer)

Green component of the color.

Default value: 0

Typical range of values: 0 ≤ Green Green Green Green green ≤ 255

Restriction: 0 <= Green && Green <= 255

BlueBlueBlueBlueblue (input_control) integer(-array) → (integer)

Blue component of the color.

Default value: 0

Typical range of values: 0 ≤ Blue Blue Blue Blue blue ≤ 255

Restriction: 0 <= Blue && Blue <= 255

AlphaAlphaAlphaAlphaalpha (input_control) integer(-array) → (integer)

Alpha component of the color.

Default value: 255

Typical range of values: 0 ≤ Alpha Alpha Alpha Alpha alpha ≤ 255

Restriction: 0 <= Alpha && Alpha <= 255

Result

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

Possible Successors

disp_objdisp_objDispObjDispObjDispObj

Alternatives

set_rgbset_rgbSetRgbSetRgbSetRgb, set_colorset_colorSetColorSetColorSetColor

Module

Foundation

Operators