SvgaLib/doc/man3/vga_copytoplanar256.3

52 lines
1.5 KiB
Groff

.TH vga_copytoplanar256 3 "27 July 1997" "Svgalib (>= 1.2.11)" "Svgalib User Manual"
.SH NAME
vga_copytoplanar256 \- copy linear pixmap into Mode X video memory
.SH SYNOPSIS
.B "#include <vga.h>"
.BI "void vga_copytoplanar256(unsigned char *" virtual ", int " pitch ", int " voffset ", int "
.IB vpitch ", int " w ", int " h );
.SH DESCRIPTION
Copy part of a linear virtual screen in system memory at
.I *virtual
to Mode X style video memory.
.I pitch
is the logical width of the virtual
screen (in pixels (which are one byte large)),
.I voffset
is the address offset into video memory,
.I vpitch
is the logical scanline width of the screen.
.BI ( w ", " h )
is the width and height of the area to copy in pixels
.RI ( w
must be a multiple of 4).
.SH SEE ALSO
.BR svgalib (7),
.BR vgagl (7),
.BR libvga.config (5),
.BR vga_accel (3),
.BR vga_copytoplanar16 (3),
.BR vga_copytoplane (3),
.BR vga_drawscanline (3),
.BR vga_drawscansegment (3),
.BR vga_getmodeinfo (3),
.BR vga_setlogicalwidth (3),
.BR vga_imageblt (3),
.BR vga_setmodeX (3),
.SH AUTHOR
This manual page was edited by Michael Weller <eowmob@exp-math.uni-essen.de>. The
exact source of the referenced function as well as of the original documentation is
unknown.
It is very likely that both are at least to some extent are due to
Harm Hanemaayer <H.Hanemaayer@inter.nl.net>.
Occasionally this might be wrong. I hereby
asked to be excused by the original author and will happily accept any additions or corrections
to this first version of the svgalib manual.