ClassesClasses | | Operators

get_window_pointer3T_get_window_pointer3GetWindowPointer3GetWindowPointer3 (Operator)

Name

get_window_pointer3T_get_window_pointer3GetWindowPointer3GetWindowPointer3 — Access to a window's pixel data.

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)

Description

get_window_pointer3get_window_pointer3GetWindowPointer3GetWindowPointer3GetWindowPointer3 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 (ImageRedImageRedImageRedImageRedimageRed, ImageGreenImageGreenImageGreenImageGreenimageGreen, ImageBlueImageBlueImageBlueImageBlueimageBlue), 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_pointer3GetWindowPointer3GetWindowPointer3GetWindowPointer3 is usable only for window type 'pixmap'.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ImageRedImageRedImageRedImageRedimageRed (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on red channel of pixel data.

ImageGreenImageGreenImageGreenImageGreenimageGreen (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on green channel of pixel data.

ImageBlueImageBlueImageBlueImageBlueimageBlue (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Pointer on blue channel of pixel data.

WidthWidthWidthWidthwidth (output_control)  extent.x HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Length of an image line.

HeightHeightHeightHeightheight (output_control)  extent.y HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of image lines.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_window_typeset_window_typeSetWindowTypeSetWindowTypeSetWindowType

Module

Foundation


ClassesClasses | | Operators