ClassesClassesClassesClasses | | | | Operators

get_rgbaT_get_rgbaGetRgbaget_rgbaGetRgbaGetRgba (Operator)

Name

get_rgbaT_get_rgbaGetRgbaget_rgbaGetRgbaGetRgba — Get the current color in RGBA-coding.

Signature

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

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

Herror get_rgba(const HTuple& WindowHandle, HTuple* Red, HTuple* Green, HTuple* Blue, HTuple* Alpha)

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

void GetRgba(const HTuple& WindowHandle, HTuple* Red, HTuple* Green, HTuple* Blue, HTuple* Alpha)

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

void HOperatorSetX.GetRgba(
[in] VARIANT WindowHandle, [out] VARIANT* Red, [out] VARIANT* Green, [out] VARIANT* Blue, [out] VARIANT* Alpha)

VARIANT HWindowX.GetRgba(
[out] VARIANT* Green, [out] VARIANT* Blue, [out] VARIANT* Alpha)

static void HOperatorSet.GetRgba(HTuple windowHandle, out HTuple red, out HTuple green, out HTuple blue, out HTuple alpha)

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

Description

get_rgbaget_rgbaGetRgbaget_rgbaGetRgbaGetRgba 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_rgbaGetRgbaget_rgbaGetRgbaGetRgba can be set with set_rgbaset_rgbaSetRgbaset_rgbaSetRgbaSetRgba.

Attention

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

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window handle.

RedRedRedRedRedred (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's red value.

GreenGreenGreenGreenGreengreen (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's green value.

BlueBlueBlueBlueBlueblue (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's blue value.

AlphaAlphaAlphaAlphaAlphaalpha (output_control)  integer-array HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

The current color's alpha value.

Result

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

Possible Successors

set_rgbaset_rgbaSetRgbaset_rgbaSetRgbaSetRgba, disp_objdisp_objDispObjdisp_objDispObjDispObj

See also

set_rgbaset_rgbaSetRgbaset_rgbaSetRgbaSetRgba

Module

Foundation


ClassesClassesClassesClasses | | | | Operators