get_rgb (Operator)

Name

get_rgb — Get the current color in RGB-coding.

Synopsis

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

Description

get_rgb returns the output colors or gray values, respectively, for the output window. They are defined by the three color components red, green and blue.

get_rgb is like get_pixel but returns the entries of the color lookup table rather than the indices. The values returned by get_rgb can be set with set_rgb.

Parameters

WindowHandle (input_control)	window → (integer)
Window_id.

Red (output_control)	integer-array → (integer)
The current color's red value.

Green (output_control)	integer-array → (integer)
The current color's green value.

Blue (output_control)	integer-array → (integer)
The current color's blue value.

Result

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

Parallelization Information

get_rgb is reentrant and processed without parallelization.

Possible Successors

set_rgb, disp_region, disp_image

See also

set_rgb

Module

Foundation