get_window_pointer3T_get_window_pointer3GetWindowPointer3GetWindowPointer3get_window_pointer3 (Operator)
Name
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
def get_window_pointer3(window_handle: HHandle) -> Tuple[int, int, int, int, int]
 
Description
get_window_pointer3get_window_pointer3GetWindowPointer3GetWindowPointer3GetWindowPointer3get_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 (ImageRedImageRedImageRedImageRedimageRedimage_red, ImageGreenImageGreenImageGreenImageGreenimageGreenimage_green,
ImageBlueImageBlueImageBlueImageBlueimageBlueimage_blue), as well as the window size (WidthWidthWidthWidthwidthwidth,
HeightHeightHeightHeightheightheight).
In the language C the type of the image points is unsigned char.
Attention
get_window_pointer3get_window_pointer3GetWindowPointer3GetWindowPointer3GetWindowPointer3get_window_pointer3 is usable only for window type
'pixmap'"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
  
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
 
Window handle.
 
  
ImageRedImageRedImageRedImageRedimageRedimage_red (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
 
Pointer on red channel of pixel data.
 
  
ImageGreenImageGreenImageGreenImageGreenimageGreenimage_green (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
 
Pointer on green channel of pixel data.
 
  
ImageBlueImageBlueImageBlueImageBlueimageBlueimage_blue (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
 
Pointer on blue channel of pixel data.
 
  
WidthWidthWidthWidthwidthwidth (output_control)  extent.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
 
Length of an image line.
 
  
HeightHeightHeightHeightheightheight (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""pixmap" exists and it is valid
get_window_pointer3get_window_pointer3GetWindowPointer3GetWindowPointer3GetWindowPointer3get_window_pointer3 returns TRUE.
If necessary an exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window
See also
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, 
set_window_typeset_window_typeSetWindowTypeSetWindowTypeSetWindowTypeset_window_type
Module
Foundation