Operator Reference

get_window_pointer3T_get_window_pointer3GetWindowPointer3GetWindowPointer3get_window_pointer3 (Operator)

get_window_pointer3T_get_window_pointer3GetWindowPointer3GetWindowPointer3get_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( : : WindowHandle : ImageRed, ImageGreen, ImageBlue, Width, Height)

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

void GetWindowPointer3(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

static void HOperatorSet.GetWindowPointer3(HTuple windowHandle, out HTuple imageRed, out HTuple imageGreen, out HTuple imageBlue, out HTuple width, out HTuple height)

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

def get_window_pointer3(window_handle: HHandle) -> Tuple[int, int, int, int, int]

Description

get_window_pointer3get_window_pointer3GetWindowPointer3GetWindowPointer3get_window_pointer3 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 (ImageRedImageRedImageRedimageRedimage_red, ImageGreenImageGreenImageGreenimageGreenimage_green, ImageBlueImageBlueImageBlueimageBlueimage_blue), as well as the window size (WidthWidthWidthwidthwidth, HeightHeightHeightheightheight). In the language C the type of the image points is unsigned char.

Attention

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

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ImageRedImageRedImageRedimageRedimage_red (output_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on red channel of pixel data.

ImageGreenImageGreenImageGreenimageGreenimage_green (output_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on green channel of pixel data.

ImageBlueImageBlueImageBlueimageBlueimage_blue (output_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on blue channel of pixel data.

WidthWidthWidthwidthwidth (output_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Length of an image line.

HeightHeightHeightheightheight (output_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of image lines.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_window_typeset_window_typeSetWindowTypeSetWindowTypeset_window_type

Module

Foundation