Operator Reference

get_pixelT_get_pixelGetPixelGetPixelget_pixel (Operator)

get_pixelT_get_pixelGetPixelGetPixelget_pixel — Get the current color lookup table index.

Warning

get_pixelget_pixelGetPixelGetPixelget_pixel is obsolete and is only provided for reasons of backward compatibility.

Signature

get_pixel( : : WindowHandle : Pixel)

Herror T_get_pixel(const Htuple WindowHandle, Htuple* Pixel)

void GetPixel(const HTuple& WindowHandle, HTuple* Pixel)

HTuple HWindow::GetPixel() const

static void HOperatorSet.GetPixel(HTuple windowHandle, out HTuple pixel)

HTuple HWindow.GetPixel()

def get_pixel(window_handle: HHandle) -> Sequence[int]

Description

get_pixelget_pixelGetPixelGetPixelget_pixel returns the internal coding of the output gray value or color, respectively, for the window. If the output mode is set to color(s) or gray value(s) (see set_colorset_colorSetColorSetColorset_color or set_grayset_graySetGraySetGrayset_gray), then the color- or gray values are transformed for internal use. The internal code is then used for (physical) screen display. The transformation depends on the mapping characteristics and the condition of the output device and can be different in different program runs. Don't confuse the term “pixel” with the term “pixel” in image processing (the other operator is get_grayvalget_grayvalGetGrayvalGetGrayvalget_grayval). Here a pixel is meant to be the color lookup table index.

With get_pixelget_pixelGetPixelGetPixelget_pixel it is possible to save the output mode without knowing whether colors or gray values are used. PixelPixelPixelpixelpixel is set with the operator set_pixelset_pixelSetPixelSetPixelset_pixel.

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.

PixelPixelPixelpixelpixel (output_control)  integer-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the current color look-up table.

Result

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

Possible Successors

set_pixelset_pixelSetPixelSetPixelset_pixel, disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_imagedisp_imageDispImageDispImagedisp_image

See also

set_pixelset_pixelSetPixelSetPixelset_pixel

Module

Foundation