API documentation for visualization library

Michael Galloy

single page | use frames     summary     class     fields     routine details     file attributes

directgraphics/

vis_read.pro

includes main-level program

top vis_read

result = vis_read( [xstart] [, ystart] [, nx] [, ny] [, channel] [, true=long] [, red=bytarr] [, green=bytarr] [, blue=bytarr] [, _extra=keywords])

Reads from the current graphics device (WIN, X, or Z devices) and returns the image in the TRUE format specified.

NOTE: on Mac OS X, the resize indicator in the lower right of the image is filled with a solid color using the pixel immediately to the left of the indicator at y=0.

Return value

image byte array

Parameters

xstart in optional type=long default=0L

starting column to read

ystart in optional type=long default=0L

starting row to read

nx in optional type=long default=fill window from xstart

number of columns to read

ny in optional type=long default=fill window from ystart

number of rows to read

channel in optional type=long default=0L

the memory channel to read

Keywords

true in optional type=long

TRUE format of output image desired; defaults to 0 on 8-bit hardware and 1 on higher bit-depths

red out optional type=bytarr

red values for the color table produced if TRUE was set to 0 on a graphics device supporting 24-bit color

green out optional type=bytarr

green values for the color table produced if TRUE was set to 0 on a graphics device supporting 24-bit color

blue out optional type=bytarr

blue values for the color table produced if TRUE was set to 0 on a graphics device supporting 24-bit color

_extra in optional type=keywords

keywords to TVRD

Examples

See the main-level program at the end of this file:

IDL> .run vis_read

File attributes

Modification date: Wed May 16 14:23:50 2012
Lines: 149
Docformat: rst rst