freebsd-dev/lib/libvgl/vgl.3

471 lines
12 KiB
Groff
Raw Normal View History

.\" Copyright (c) 1997 S<>ren Schmidt
.\" All rights reserved.
2001-07-15 07:53:42 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer,
.\" in this position and unchanged.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
2001-08-07 12:47:57 +00:00
.\" derived from this software without specific prior written permission.
2001-07-15 07:53:42 +00:00
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2001-07-15 07:53:42 +00:00
.\"
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
.Dd November 7, 1999
.Dt VGL 3
.Os
.Sh NAME
.Nm VGLBitmapAllocateBits ,
.Nm VGLBitmapCopy ,
.Nm VGLBitmapCreate ,
.Nm VGLBitmapDestroy ,
.Nm VGLBitmapPutChar ,
.Nm VGLBitmapString ,
.Nm VGLBlankDisplay ,
.Nm VGLBox ,
.Nm VGLCheckSwitch ,
.Nm VGLClear ,
.Nm VGLEllipse ,
.Nm VGLEnd ,
.Nm VGLFilledBox ,
.Nm VGLFilledEllipse ,
.Nm VGLGetXY ,
.Nm VGLInit ,
.Nm VGLLine ,
.Nm VGLKeyboardInit ,
.Nm VGLKeyboardEnd ,
.Nm VGLKeyboardGetCh ,
.Nm VGLMouseInit ,
.Nm VGLMouseMode ,
.Nm VGLMouseSetImage ,
.Nm VGLMouseSetStdImage ,
.Nm VGLMouseStatus ,
.Nm VGLPanScreen ,
.Nm VGLSetBorder ,
.Nm VGLSetPalette ,
.Nm VGLSetPaletteIndex ,
.Nm VGLSetVScreenSize ,
.Nm VGLSetXY ,
.Nm VGLTextSetFontFile
2000-04-22 16:17:38 +00:00
.Nd Video Graphics Library functions
.Sh LIBRARY
.Lb libvgl
.Sh SYNOPSIS
.In sys/fbio.h
.In sys/consio.h
.In sys/kbio.h
.In vgl.h
.Ft int
.Fn VGLInit "int mode"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLEnd "void"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLCheckSwitch "void"
2001-07-15 07:53:42 +00:00
.Ft int
.Fn VGLTextSetFontFile "char *filename"
.Ft int
.Fn VGLKeyboardInit "int code"
.Ft void
.Fn VGLKeyboardEnd "void"
.Ft int
.Fn VGLKeyboardGetCh "void"
2001-07-15 07:53:42 +00:00
.Ft int
.Fn VGLMouseInit "int mode"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLMouseMode "int mode"
2001-07-15 07:53:42 +00:00
.Ft int
.Fn VGLMouseStatus "int *x" "int *y" "char *buttons"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLMouseSetImage "VGLBitmap *AndMask" "VGLBitmap *OrMask"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLMouseSetStdImage "void"
.Ft u_long
.Fn VGLGetXY "VGLBitmap *object" "int x" "int y"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLSetXY "VGLBitmap *object" "int x" "int y" "u_long color"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLLine "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "u_long color"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "u_long color"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLFilledBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "u_long color"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "u_long color"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLFilledEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "u_long color"
.Ft VGLBitmap *
.Fn VGLBitmapCreate "int type" "int xsize" "int ysize" "byte *bits"
.Ft void
.Fn VGLBitmapDestroy "VGLBitmap *object"
.Ft int
.Fn VGLBitmapAllocateBits "VGLBitmap *object"
2001-07-15 07:53:42 +00:00
.Ft int
.Fn VGLBitmapCopy "VGLBitmap *src" "int srcx" "int srcy" "VGLBitmap *dst" "int dstx" "int dsty" "int width" "int hight"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLBitmapPutChar "VGLBitmap *Object" "int x" "int y" "byte ch" "byte fgcol" "byte bgcol" "int fill" "int dir"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLBitmapString "VGLBitmap *Object" "int x" "int y" "char *str" "byte fgcol" "byte bgcol" "int fill" "int dir"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLClear "VGLBitmap *object" "u_long color"
.Ft void
.Fn VGLSetPalette "byte *red" "byte *green" "byte *blue"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLSetPaletteIndex "byte color" "byte red" "byte green" "byte blue"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLSetBorder "byte color"
.Ft int
.Fn VGLSetVScreenSize "VGLBitmap *object" "int vxsize" "int vysize"
.Ft int
.Fn VGLPanScreen "VGLBitmap *object" "int x" "int y"
2001-07-15 07:53:42 +00:00
.Ft void
.Fn VGLBlankDisplay "int blank"
.Sh DESCRIPTION
.Nm Libvgl
is a library that enables the programmer access to the graphics
modes supported by the console driver (syscons).
The library takes care of
programming the actual video hardware, and provides a number of simple
functions to do various graphic operations.
There is also support for a
mouse via the standard mouse system in
.Fx ,
see
.Xr mouse 4 ,
including the ability to transparently have a mouse pointer superimposed on
2001-07-15 07:53:42 +00:00
the graphic image currently being worked on.
1997-10-22 23:12:27 +00:00
The library takes care of screen switching by storing the current image in
memory before switching to another virtual console, and restoring when the
user switches back.
This allows several graphic applications at once, but
on different virtual consoles.
2000-12-29 14:08:20 +00:00
.Pp
Below is a short description of the various functions:
.Pp
.Fn VGLInit
initialize the library and set up the graphic mode
2000-01-05 15:16:32 +00:00
.Va mode .
.Pp
.Fn VGLEnd
terminate graphic mode, and restore the screenmode that was active before
.Fn VGLInit
was called.
.Pp
.Fn VGLCheckSwitch
if the program goes into longer periods of processing without doing
2001-07-15 07:53:42 +00:00
any graphics output, calling this function occasionally will allow
the system to switch screens.
.Pp
2001-07-15 07:53:42 +00:00
.Fn VGLTextSetFontFile
instruct the char/string functions to use the font in file
2000-01-05 15:16:32 +00:00
.Pa filename
1997-10-22 23:12:27 +00:00
instead of the builtin font.
.Pp
.Fn VGLKeyboardInit
2000-01-05 15:16:32 +00:00
set up the keyboard in the
.Dq raw
I/O mode and
specify the key code to be used.
2000-01-05 15:16:32 +00:00
.Va code
must be
2000-01-05 15:16:32 +00:00
.Dv VGL_XLATEKEYS ,
.Dv VGL_CODEKEYS ,
or
2000-01-05 15:16:32 +00:00
.Dv VGL_RAWKEYS .
2001-07-15 07:53:42 +00:00
When
2000-01-05 15:16:32 +00:00
.Dv VGL_XLATEKEYS
is specified, the keyboard translates the raw keyboard scan code into
a character code.
If
2000-01-05 15:16:32 +00:00
.Dv VGL_RAWKEYS
is used, the raw keyboard scan code is read as is.
2000-01-05 15:16:32 +00:00
.Dv VGL_CODEKEYS
is the intermediate key code; each key is assigned a unique code whereas
more than one raw scan code may be generated when a key is pressed.
.Pp
.Fn VGLKeyboardEnd
when you have finished using the keyboard, call this function.
.Pp
.Fn VGLKeyboardGetCh
read one byte from the keyboard.
As the keyboard I/O is in the
2000-01-05 15:16:32 +00:00
.Dq raw
input mode, the function will not block even if there is no input data,
and returns 0.
.Pp
2001-07-15 07:53:42 +00:00
.Fn VGLMouseInit
initialize the mouse.
The optional on-screen mouse pointer is shown if the
2001-07-15 07:53:42 +00:00
argument is
2000-01-05 15:16:32 +00:00
.Dv VGL_MOUSESHOW .
.Pp
.Fn VGLMouseMode
either shows the mouse pointer if the argument is
2000-01-05 15:16:32 +00:00
.Dv VGL_MOUSESHOW ,
or hides the mouse pointer if the argument is
2000-01-05 15:16:32 +00:00
.Dv VGL_MOUSEHIDE .
.Pp
.Fn VGLMouseStatus
returns the current mouse pointer coordinates and button state in
2000-01-05 15:16:32 +00:00
.Va x , y ,
buttons.
2001-07-15 07:53:42 +00:00
The return value reflects if the mouse pointer
is currently shown on screen or not.
.Pp
.Fn VGLMouseSetImage
with this function it is possible to change the image of the mouse pointer
on screen.
.Pp
.Fn VGLMouseSetStdImage
this function restores the mouse pointer to the standard arrow.
.Pp
.Fn VGLGetXY
retrieves the color of the pixel located at
2000-01-05 15:16:32 +00:00
.Va x , y ,
coordinates of the
2000-01-05 15:16:32 +00:00
.Va object
argument, and returns it as a byte value.
.Pp
.Fn VGLSetXY
sets the color of the pixel located at
2000-01-05 15:16:32 +00:00
.Va x , y ,
coordinates of the
2000-01-05 15:16:32 +00:00
.Va object
argument to
2000-01-05 15:16:32 +00:00
.Va color
byte value.
.Pp
2001-07-15 07:53:42 +00:00
.Fn VGLLine
draw a line from
2000-01-05 15:16:32 +00:00
.Va x1 , y1
to
2000-01-05 15:16:32 +00:00
.Va x2 , y2
in color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLBox
draw a box with upper left hand corner at
2000-01-05 15:16:32 +00:00
.Va x1 , y1
and lower right hand corner at
2000-01-05 15:16:32 +00:00
.Va x2 , y2
in color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLFilledBox
draw a filled (solid) box with upper left hand corner at
2000-01-05 15:16:32 +00:00
.Va x1 , y1
and lower right hand corner at
2000-01-05 15:16:32 +00:00
.Va x2 , y2
in color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
2001-07-15 07:53:42 +00:00
.Fn VGLEllipse
draw an ellipse centered at
2000-01-05 15:16:32 +00:00
.Va xc , yc
2001-07-15 07:53:42 +00:00
make it
2000-01-05 15:16:32 +00:00
.Va a
2001-07-15 07:53:42 +00:00
pixels wide, and
2000-01-05 15:16:32 +00:00
.Va b
pixels high in color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLFilledEllipse
2001-07-15 07:53:42 +00:00
draw a filled (solid) ellipse centered at
2000-01-05 15:16:32 +00:00
.Va xc , yc
2001-07-15 07:53:42 +00:00
make it
2000-01-05 15:16:32 +00:00
.Va a
2001-07-15 07:53:42 +00:00
pixels wide, and
2000-01-05 15:16:32 +00:00
.Va b
pixels high in color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLBitmapCreate
2001-07-15 07:53:42 +00:00
create a bitmap object and initialize it with the specified
values and bit data.
2000-01-05 15:16:32 +00:00
.Va type
must be
2000-01-05 15:16:32 +00:00
.Dv MEMBUF
for the in-memory bitmap.
2000-01-05 15:16:32 +00:00
.Va bits
may be NULL so that bitmap data may be associated later.
.Pp
2001-07-15 07:53:42 +00:00
There also is a macro,
.Fn VGLBITMAP_INITIALIZER "type" "xsize" "ysize" "bits"
to initialize a statically declared bitmap object.
.Pp
.Fn VGLBitmapDestroy
free the bitmap data and the bitmap object.
.Pp
.Fn VGLBitmapAllocateBits
allocate a bit data buffer for the specified object.
.Pp
.Fn VGLBitmapCopy
copy a rectangle of pixels from bitmap
2000-01-05 15:16:32 +00:00
.Va src
2001-07-15 07:53:42 +00:00
upper left hand corner at
2000-01-05 15:16:32 +00:00
.Va srcx , srcy
to bitmap
2000-01-05 15:16:32 +00:00
.Va dst
2001-07-15 07:53:42 +00:00
at
2000-01-05 15:16:32 +00:00
.Va dstx , dsty
of the size
2000-01-05 15:16:32 +00:00
.Va width , height .
.Pp
.Fn VGLBitmapPutChar
write the character
2000-01-05 15:16:32 +00:00
.Va ch
at position
2000-01-05 15:16:32 +00:00
.Va x , y
2001-07-15 07:53:42 +00:00
in foreground color
2000-01-05 15:16:32 +00:00
.Va fgcol .
2001-07-15 07:53:42 +00:00
If
2000-01-05 15:16:32 +00:00
.Va fill
is != 0, use the color
2000-01-05 15:16:32 +00:00
.Va bgcol
as background otherwise the background is transparent.
The character is drawn in the direction specified by the argument
2000-01-05 15:16:32 +00:00
.Va dir .
.Pp
.Fn VGLBitmapString
write the string
2000-01-05 15:16:32 +00:00
.Va str
at position
2000-01-05 15:16:32 +00:00
.Va x , y
2001-07-15 07:53:42 +00:00
in foreground color
2000-01-05 15:16:32 +00:00
.Va fgcol .
2001-07-15 07:53:42 +00:00
If
2000-01-05 15:16:32 +00:00
.Va fill
is != 0, use the color
2000-01-05 15:16:32 +00:00
.Va bgcol
1997-10-22 23:12:27 +00:00
as background otherwise the background is transparent.
The string is drawn in the direction specified by the argument
2000-01-05 15:16:32 +00:00
.Va dir .
.Pp
.Fn VGLClear
clears the entire bitmap to color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLSetPalette
this function sets the palette used, the arguments
2000-01-05 15:16:32 +00:00
.Va red , green , blue
should point to byte arrays of 256 positions each.
.Pp
.Fn VGLSetPaletteIndex
2001-07-15 07:53:42 +00:00
set the palette index
2000-01-05 15:16:32 +00:00
.Va color
to the specified RGB value.
.Pp
.Fn VGLSetBorder
set the border color to color
2000-01-05 15:16:32 +00:00
.Va color .
.Pp
.Fn VGLSetVScreenSize
change the virtual screen size of the display.
Note that this
2001-07-15 07:53:42 +00:00
function must be called when our vty is in the foreground.
And
2000-01-05 15:16:32 +00:00
.Va object
must be
2000-01-05 15:16:32 +00:00
.Va VGLDisplay .
Passing an in-memory bitmap to this function results in error.
.Pp
The desired virtual screen width may not be achievable because
of the video card hardware.
In such case the video driver (and
underlaying video BIOS) may choose the next largest values.
2001-07-15 07:53:42 +00:00
Always examine
.Va object->VXsize
and
.Va VYsize
after calling this function, in order to see how the virtual screen
is actually set up.
.Pp
In order to set up the largest possible virtual screen, you may
call this function with arbitrary large values.
.Pp
.Dl VGLSetVScreenSize(10000, 10000);
.Pp
.Fn VGLPanSreen
change the origin of the displayed screen in the virtual screen.
2001-07-15 07:53:42 +00:00
Note that this function must be called when our vty is in the
foreground.
2000-01-05 15:16:32 +00:00
.Va object
must be
2000-01-05 15:16:32 +00:00
.Va VGLDisplay .
Passing an in-memory bitmap to this function results in error.
.Pp
.Fn VGLBlankDisplay
2001-08-07 12:47:57 +00:00
blank the display if the argument
2000-01-05 15:16:32 +00:00
.Va blank
\*(Ne 0.
This can be done to shut off the screen during display updates that
2005-02-13 23:45:54 +00:00
the user should first see when it is done.
.Ss Program termination and signal processing
It is important to call
.Fn VGLEnd
before terminating the program.
Care must be taken if you install signal handlers and try to call
.Fn VGLEnd
and
.Xr exit 3
to end the program.
If a signal is caught while the program is inside
.Nm libvgl
functions,
.Fn VGLEnd
may not be able to properly restore the graphics hardware.
.Pp
The recommended way to handle signals and program termination is to
have a flag to indicate signal's delivery.
Your signal handlers set this flag but do not terminate
the program immediately.
The main part of the program checks the flag to see if it is
2001-08-07 12:47:57 +00:00
supposed to terminate, and calls
.Fn VGLEnd
and
.Xr exit 3
if the flag is set.
.Pp
Note that
.Fn VGLInit
installs its internal signal handlers for
.Dv SIGINT , SIGTERM , SIGSEGV ,
and
.Dv SIGBUS ,
and terminates the program at appropriate time,
after one of these signals is caught.
If you want to have your own signal handlers for these signals,
install handlers
.Em after
.Fn VGLInit .
.Pp
.Dv SIGUSR1
and
.Dv SIGUSR2
are internally used by
.Nm libvgl
to control screen switching and the mouse pointer,
and are not available to
.Nm libvgl
client programs.
.Sh HISTORY
2001-07-15 07:53:42 +00:00
The
.Nm vgl
library appeared in
1999-10-30 19:29:45 +00:00
.Fx 3.0 .
2005-01-20 09:17:07 +00:00
.Sh AUTHORS
.An S\(/oren Schmidt Aq sos@FreeBSD.org