1.\" Copyright (c) 1997 S�ren Schmidt
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer,
--- 10 unchanged lines hidden (view full) ---
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: head/lib/libvgl/vgl.3 52681 1999-10-30 19:29:45Z mpp $
28.Dd October 28, 1999
29.Dt VGL 3
30.Os FreeBSD 3.0
31.Sh NAME
32.Nm VGLBitmapCopy ,
33.Nm VGLBitmapPutChar ,
34.Nm VGLBitmapString ,
35.Nm VGLBlankDisplay ,
36.Nm VGLBox ,
37.Nm VGLCheckSwitch ,
38.Nm VGLClear ,
39.Nm VGLEllipse ,
40.Nm VGLEnd ,
41.Nm VGLFilledBox ,
42.Nm VGLFilledEllipse ,
43.Nm VGLInit ,
44.Nm VGLLine ,
45.Nm VGLMouseInit ,
46.Nm VGLMouseMode ,
47.Nm VGLMouseSetImage ,
48.Nm VGLMouseSetStdImage ,
49.Nm VGLMouseStatus ,
50.Nm VGLSetBorder ,
51.Nm VGLSetPalette ,
52.Nm VGLSetPaletteIndex ,
53.Nm VGLTextSetFontFile
54.Nd Video Graphics Library functions (libvgl)
55.Sh SYNOPSIS
56.Fd #include <vgl.h>
57.Ft int
58.Fn VGLInit "int mode"
59.Ft void
60.Fn VGLEnd "void"
61.Ft void
62.Fn VGLCheckSwitch "void"
63.Ft int
64.Fn VGLTextSetFontFile "char *filename"
65.Ft int
66.Fn VGLMouseInit "int mode"
67.Ft void
68.Fn VGLMouseMode "int mode"
69.Ft int
70.Fn VGLMouseStatus "int *x" "int *y" "char *buttons"
71.Ft void
72.Fn VGLMouseSetImage "VGLBitmap *AndMask" "VGLBitmap *OrMask"
--- 4 unchanged lines hidden (view full) ---
77.Ft void
78.Fn VGLBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
79.Ft void
80.Fn VGLFilledBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
81.Ft void
82.Fn VGLEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
83.Ft void
84.Fn VGLFilledEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
85.Ft int
86.Fn VGLBitmapCopy "VGLBitmap *src" "int srcx" "int srcy" "VGLBitmap *dst" "int dstx" "int dsty" "int width" "int hight"
87.Ft void
88.Fn VGLBitmapPutChar "VGLBitmap *Object" "int x" "int y" "byte ch" "byte fgcol" "byte bgcol" "int fill" "int dir"
89.Ft void
90.Fn VGLBitmapString "VGLBitmap *Object" "int x" "int y" "char *str" "byte fgcol" "byte bgcol" "int fill" "int dir"
91.Ft void
92.Fn VGLClear "VGLBitmap *object" "byte color"
93.Ft void
94.Fn VGLSetPalette "byte *red" "byte *green" "byte *blue"
95.Ft void
96.Fn VGLSetPaletteIndex "byte color" "byte red" "byte green" "byte blue"
97.Ft void
98.Fn VGLSetBorder "byte color"
99.Ft void
100.Fn VGLBlankDisplay "int blank"
101.Sh DESCRIPTION
102.Nm Libvgl
103is a library that enables the programmer access to the graphics
104modes supported by the console driver (syscons). The library takes care of
105programming the actual video hardware, and provides a number of simple
106functions to do various graphic operations. There is also support for a
--- 24 unchanged lines hidden (view full) ---
131any graphics output, calling this function occasionally will allow
132the system to switch screens.
133.Pp
134.Fn VGLTextSetFontFile
135instruct the char/string functions to use the font in file
136.Em filename
137instead of the builtin font.
138.Pp
139.Fn VGLMouseInit
140initialize the mouse. The optional on-screen mouse pointer is shown if the
141argument is
142.Em VGL_MOUSESHOW .
143.Pp
144.Fn VGLMouseMode
145either shows the mouse pointer if the argument is
146.Em VGL_MOUSESHOW ,
--- 52 unchanged lines hidden (view full) ---
199.Em xc , yc
200make it
201.Em a
202pixels wide, and
203.Em b
204pixels high in color
205.Em color .
206.Pp
207.Fn VGLBitmapCopy
208copy a rectangle of pixels from bitmap
209.Em src
210upper left hand corner at
211.Em srcx , srcy
212to bitmap
213.Em dst
214at
--- 44 unchanged lines hidden (view full) ---
259set the palette index
260.Em color
261to the specified RGB value.
262.Pp
263.Fn VGLSetBorder
264set the border color to color
265.Em color .
266.Pp
267.Fn VGLBlankDisplay
268blank the display if the argment
269.Em blank
270!= 0. This can be done to shut off the screen during display updates that
271the user should first see when it's done.
272.Sh AUTHORS
273.An S�ren Schmidt Aq sos@FreeBSD.org
274.Sh HISTORY
275The
276.Nm vgl
277library appeared in
278.Fx 3.0 .
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer,
--- 10 unchanged lines hidden (view full) ---
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: head/lib/libvgl/vgl.3 52681 1999-10-30 19:29:45Z mpp $
28.Dd October 28, 1999
29.Dt VGL 3
30.Os FreeBSD 3.0
31.Sh NAME
32.Nm VGLBitmapCopy ,
33.Nm VGLBitmapPutChar ,
34.Nm VGLBitmapString ,
35.Nm VGLBlankDisplay ,
36.Nm VGLBox ,
37.Nm VGLCheckSwitch ,
38.Nm VGLClear ,
39.Nm VGLEllipse ,
40.Nm VGLEnd ,
41.Nm VGLFilledBox ,
42.Nm VGLFilledEllipse ,
43.Nm VGLInit ,
44.Nm VGLLine ,
45.Nm VGLMouseInit ,
46.Nm VGLMouseMode ,
47.Nm VGLMouseSetImage ,
48.Nm VGLMouseSetStdImage ,
49.Nm VGLMouseStatus ,
50.Nm VGLSetBorder ,
51.Nm VGLSetPalette ,
52.Nm VGLSetPaletteIndex ,
53.Nm VGLTextSetFontFile
54.Nd Video Graphics Library functions (libvgl)
55.Sh SYNOPSIS
56.Fd #include <vgl.h>
57.Ft int
58.Fn VGLInit "int mode"
59.Ft void
60.Fn VGLEnd "void"
61.Ft void
62.Fn VGLCheckSwitch "void"
63.Ft int
64.Fn VGLTextSetFontFile "char *filename"
65.Ft int
66.Fn VGLMouseInit "int mode"
67.Ft void
68.Fn VGLMouseMode "int mode"
69.Ft int
70.Fn VGLMouseStatus "int *x" "int *y" "char *buttons"
71.Ft void
72.Fn VGLMouseSetImage "VGLBitmap *AndMask" "VGLBitmap *OrMask"
--- 4 unchanged lines hidden (view full) ---
77.Ft void
78.Fn VGLBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
79.Ft void
80.Fn VGLFilledBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
81.Ft void
82.Fn VGLEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
83.Ft void
84.Fn VGLFilledEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
85.Ft int
86.Fn VGLBitmapCopy "VGLBitmap *src" "int srcx" "int srcy" "VGLBitmap *dst" "int dstx" "int dsty" "int width" "int hight"
87.Ft void
88.Fn VGLBitmapPutChar "VGLBitmap *Object" "int x" "int y" "byte ch" "byte fgcol" "byte bgcol" "int fill" "int dir"
89.Ft void
90.Fn VGLBitmapString "VGLBitmap *Object" "int x" "int y" "char *str" "byte fgcol" "byte bgcol" "int fill" "int dir"
91.Ft void
92.Fn VGLClear "VGLBitmap *object" "byte color"
93.Ft void
94.Fn VGLSetPalette "byte *red" "byte *green" "byte *blue"
95.Ft void
96.Fn VGLSetPaletteIndex "byte color" "byte red" "byte green" "byte blue"
97.Ft void
98.Fn VGLSetBorder "byte color"
99.Ft void
100.Fn VGLBlankDisplay "int blank"
101.Sh DESCRIPTION
102.Nm Libvgl
103is a library that enables the programmer access to the graphics
104modes supported by the console driver (syscons). The library takes care of
105programming the actual video hardware, and provides a number of simple
106functions to do various graphic operations. There is also support for a
--- 24 unchanged lines hidden (view full) ---
131any graphics output, calling this function occasionally will allow
132the system to switch screens.
133.Pp
134.Fn VGLTextSetFontFile
135instruct the char/string functions to use the font in file
136.Em filename
137instead of the builtin font.
138.Pp
139.Fn VGLMouseInit
140initialize the mouse. The optional on-screen mouse pointer is shown if the
141argument is
142.Em VGL_MOUSESHOW .
143.Pp
144.Fn VGLMouseMode
145either shows the mouse pointer if the argument is
146.Em VGL_MOUSESHOW ,
--- 52 unchanged lines hidden (view full) ---
199.Em xc , yc
200make it
201.Em a
202pixels wide, and
203.Em b
204pixels high in color
205.Em color .
206.Pp
207.Fn VGLBitmapCopy
208copy a rectangle of pixels from bitmap
209.Em src
210upper left hand corner at
211.Em srcx , srcy
212to bitmap
213.Em dst
214at
--- 44 unchanged lines hidden (view full) ---
259set the palette index
260.Em color
261to the specified RGB value.
262.Pp
263.Fn VGLSetBorder
264set the border color to color
265.Em color .
266.Pp
267.Fn VGLBlankDisplay
268blank the display if the argment
269.Em blank
270!= 0. This can be done to shut off the screen during display updates that
271the user should first see when it's done.
272.Sh AUTHORS
273.An S�ren Schmidt Aq sos@FreeBSD.org
274.Sh HISTORY
275The
276.Nm vgl
277library appeared in
278.Fx 3.0 .