SvgaLib/doc/man3/vga_getscansegment.3

35 lines
1 KiB
Groff

.TH vga_getscansegment 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
.SH NAME
vga_getscansegment \- get a list of consecutive pixel values
.SH SYNOPSIS
.B "#include <vga.h>"
.BI "int vga_getscansegment(unsigned char *" colors ", int " x ", int " y ", int " length );
.SH DESCRIPTION
The direct opposite of vga_drawscansegment(). The line of
.I length
pixels starting at
.BI ( x ", " y )
is not drawn but instead the colorvalues are taken from the screen and
copied into
.IB color "[0] .. " color [ length " - 1]."
Svgalib versions was introduced in version 1.2.10.
In high/truecolor modes, the length must be given in bytes, not pixels.
.SH SEE ALSO
.BR svgalib (7),
.BR vgagl (7),
.BR libvga.config (5),
.BR vga_clear (3),
.BR vga_drawpixel (3),
.BR vga_drawline (3),
.BR vga_getpixel (3),
.BR vga_drawscanline (3),
.BR vga_drawscansegment (3)
.SH AUTHOR
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>.
The referenced function and its documentation are due to
Bill Randle <billr@master.CNA.TEK.COM>.