get_window_pointer3GetWindowPointer3GetWindowPointer3get_window_pointer3T_get_window_pointer3

HALCON ScriptCpp++.NETPythonC

Short description

get_window_pointer3GetWindowPointer3GetWindowPointer3get_window_pointer3T_get_window_pointer3 — Access to a window’s pixel data.

Warning

This operator does not work in an HDevelop graphics window opened with dev_open_window.

Signature

get_window_pointer3( window WindowHandle, out integer ImageRed, out integer ImageGreen, out integer ImageBlue, out extent.x Width, out extent.y Height )void GetWindowPointer3( const HTuple& WindowHandle, HTuple* ImageRed, HTuple* ImageGreen, HTuple* ImageBlue, HTuple* Width, HTuple* Height )static void HOperatorSet.GetWindowPointer3( HTuple windowHandle, out HTuple imageRed, out HTuple imageGreen, out HTuple imageBlue, out HTuple width, out HTuple height )def get_window_pointer3( window_handle: HHandle ) -> Tuple[int, int, int, int, int]

Herror T_get_window_pointer3( const Htuple WindowHandle, Htuple* ImageRed, Htuple* ImageGreen, Htuple* ImageBlue, Htuple* Width, Htuple* Height )

void HWindow::GetWindowPointer3( Hlong* ImageRed, Hlong* ImageGreen, Hlong* ImageBlue, Hlong* Width, Hlong* Height ) const

void HWindow.GetWindowPointer3( out int imageRed, out int imageGreen, out int imageBlue, out int width, out int height )

Description

get_window_pointer3GetWindowPointer3 enables (in some window systems) the direct access to the bitmap. Result values are the three pointers on the color extracts of a 24-bit window (ImageRedimageRedimage_red, ImageGreenimageGreenimage_green, ImageBlueimageBlueimage_blue), as well as the window size (Widthwidthwidth, Heightheightheight). In the language C the type of the image points is unsigned char.

Attention

get_window_pointer3GetWindowPointer3 is usable only for window type 'pixmap'"pixmap".

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.

ImageRedimageRedimage_red (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Pointer on red channel of pixel data.

ImageGreenimageGreenimage_green (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Pointer on green channel of pixel data.

ImageBlueimageBlueimage_blue (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Pointer on blue channel of pixel data.

Widthwidthwidth (output_control) extent.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Length of an image line.

Heightheightheight (output_control) extent.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of image lines.

Result

If a window of type 'pixmap'"pixmap" exists and it is valid get_window_pointer3GetWindowPointer3 returns 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

open_windowOpenWindow

See also

open_windowOpenWindow, set_window_typeSetWindowType

Module

Foundation