lib/libvgl/vgl.3

   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,
   9 .\"    in this position and unchanged.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  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: src/lib/libvgl/vgl.3,v 1.12.2.8 2001/12/17 10:08:35 ru Exp $
  28 .Dd November 7, 1999
  29 .Dt VGL 3
  30 .Os
  31 .Sh NAME
  32 .Nm VGLBitmapAllocateBits ,
  33 .Nm VGLBitmapCopy ,
  34 .Nm VGLBitmapCreate ,
  35 .Nm VGLBitmapDestroy ,
  36 .Nm VGLBitmapPutChar ,
  37 .Nm VGLBitmapString ,
  38 .Nm VGLBlankDisplay ,
  39 .Nm VGLBox ,
  40 .Nm VGLCheckSwitch ,
  41 .Nm VGLClear ,
  42 .Nm VGLEllipse ,
  43 .Nm VGLEnd ,
  44 .Nm VGLFilledBox ,
  45 .Nm VGLFilledEllipse ,
  46 .Nm VGLGetXY ,
  47 .Nm VGLInit ,
  48 .Nm VGLLine ,
  49 .Nm VGLKeyboardInit ,
  50 .Nm VGLKeyboardEnd ,
  51 .Nm VGLKeyboardGetCh ,
  52 .Nm VGLMouseInit ,
  53 .Nm VGLMouseMode ,
  54 .Nm VGLMouseSetImage ,
  55 .Nm VGLMouseSetStdImage ,
  56 .Nm VGLMouseStatus ,
  57 .Nm VGLPanScreen ,
  58 .Nm VGLSetBorder ,
  59 .Nm VGLSetPalette ,
  60 .Nm VGLSetPaletteIndex ,
  61 .Nm VGLSetVScreenSize ,
  62 .Nm VGLSetXY ,
  63 .Nm VGLTextSetFontFile
  64 .Nd Video Graphics Library functions
  65 .Sh LIBRARY
  66 .Lb libvgl
  67 .Sh SYNOPSIS
  68 .In machine/console.h
  69 .In vgl.h
  70 .Ft int
  71 .Fn VGLInit "int mode"
  72 .Ft void
  73 .Fn VGLEnd "void"
  74 .Ft void
  75 .Fn VGLCheckSwitch "void"
  76 .Ft int
  77 .Fn VGLTextSetFontFile "char *filename"
  78 .Ft int
  79 .Fn VGLKeyboardInit "int code"
  80 .Ft void
  81 .Fn VGLKeyboardEnd "void"
  82 .Ft int
  83 .Fn VGLKeyboardGetCh "void"
  84 .Ft int
  85 .Fn VGLMouseInit "int mode"
  86 .Ft void
  87 .Fn VGLMouseMode "int mode"
  88 .Ft int
  89 .Fn VGLMouseStatus "int *x" "int *y" "char *buttons"
  90 .Ft void
  91 .Fn VGLMouseSetImage "VGLBitmap *AndMask" "VGLBitmap *OrMask"
  92 .Ft void
  93 .Fn VGLMouseSetStdImage "void"
  94 .Ft byte
  95 .Fn VGLGetXY "VGLBitmap *object" "int x" "int y"
  96 .Ft void
  97 .Fn VGLSetXY "VGLBitmap *object" "int x" "int y" "byte color"
  98 .Ft void
  99 .Fn VGLLine "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
 100 .Ft void
 101 .Fn VGLBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
 102 .Ft void
 103 .Fn VGLFilledBox "VGLBitmap *object" "int x1" "int y1" "int x2" "int y2" "byte color"
 104 .Ft void
 105 .Fn VGLEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
 106 .Ft void
 107 .Fn VGLFilledEllipse "VGLBitmap *object" "int xc" "int yc" "int a" "int b" "byte color"
 108 .Ft VGLBitmap *
 109 .Fn VGLBitmapCreate "int type" "int xsize" "int ysize" "byte *bits"
 110 .Ft void
 111 .Fn VGLBitmapDestroy "VGLBitmap *object"
 112 .Ft int
 113 .Fn VGLBitmapAllocateBits "VGLBitmap *object"
 114 .Ft int
 115 .Fn VGLBitmapCopy "VGLBitmap *src" "int srcx" "int srcy" "VGLBitmap *dst" "int dstx" "int dsty" "int width" "int hight"
 116 .Ft void
 117 .Fn VGLBitmapPutChar "VGLBitmap *Object" "int x" "int y" "byte ch" "byte fgcol" "byte bgcol" "int fill" "int dir"
 118 .Ft void
 119 .Fn VGLBitmapString "VGLBitmap *Object" "int x" "int y" "char *str" "byte fgcol" "byte bgcol" "int fill" "int dir"
 120 .Ft void
 121 .Fn VGLClear "VGLBitmap *object" "byte color"
 122 .Ft void
 123 .Fn VGLSetPalette "byte *red" "byte *green" "byte *blue"
 124 .Ft void
 125 .Fn VGLSetPaletteIndex "byte color" "byte red" "byte green" "byte blue"
 126 .Ft void
 127 .Fn VGLSetBorder "byte color"
 128 .Ft int
 129 .Fn VGLSetVScreenSize "VGLBitmap *object" "int vxsize" "int vysize"
 130 .Ft int
 131 .Fn VGLPanScreen "VGLBitmap *object" "int x" "int y"
 132 .Ft void
 133 .Fn VGLBlankDisplay "int blank"
 134 .Sh DESCRIPTION
 135 .Nm Libvgl
 136 is a library that enables the programmer access to the graphics
 137 modes supported by the console driver
 138 .Xr ( syscons 4 ) .
 139 The library takes care of
 140 programming the actual video hardware, and provides a number of simple
 141 functions to do various graphic operations.
 142 There is also support for a
 143 mouse via the standard mouse system in
 144 .Dx ,
 145 see
 146 .Xr mouse 4 ,
 147 including the ability to transparently have a mouse pointer superimposed on
 148 the graphic image currently being worked on.
 149 The library takes care of screen switching by storing the current image in
 150 memory before switching to another virtual console, and restoring when the
 151 user switches back.
 152 This allows several graphic applications at once, but
 153 on different virtual consoles.
 154 .Pp
 155 Below is a short description of the various functions:
 156 .Pp
 157 .Fn VGLInit
 158 initialize the library and set up the graphic mode
 159 .Va mode .
 160 .Pp
 161 .Fn VGLEnd
 162 terminate graphic mode, and restore the screenmode that was active before
 163 .Fn VGLInit
 164 was called.
 165 .Pp
 166 .Fn VGLCheckSwitch
 167 if the program goes into longer periods of processing without doing
 168 any graphics output, calling this function occasionally will allow
 169 the system to switch screens.
 170 .Pp
 171 .Fn VGLTextSetFontFile
 172 instruct the char/string functions to use the font in file
 173 .Fa filename
 174 instead of the builtin font.
 175 .Pp
 176 .Fn VGLKeyboardInit
 177 set up the keyboard in the
 178 .Dq raw
 179 I/O mode and
 180 specify the key code to be used.
 181 .Va code
 182 must be
 183 .Dv VGL_XLATEKEYS ,
 184 .Dv VGL_CODEKEYS ,
 185 or
 186 .Dv VGL_RAWKEYS .
 187 When
 188 .Dv VGL_XLATEKEYS
 189 is specified, the keyboard translate the raw keyboard scan code into
 190 a character code.
 191 If
 192 .Dv VGL_RAWKEYS
 193 is used, the raw keyboard scan code is read as is.
 194 .Dv VGL_CODEKEYS
 195 is the intermediate key code; each key is assigned a unique code whereas
 196 more than one raw scan code may be generated when a key is pressed.
 197 .Pp
 198 .Fn VGLKeyboardEnd
 199 when you have finished using the keyboard, call this function.
 200 .Pp
 201 .Fn VGLKeyboardGetCh
 202 read one byte from the keyboard.  As the keyboard I/O is in the
 203 .Dq raw
 204 input mode, the function will not block even if there is no input data,
 205 and returns 0.
 206 .Pp
 207 .Fn VGLMouseInit
 208 initialize the mouse.
 209 The optional on-screen mouse pointer is shown if the
 210 argument is
 211 .Dv VGL_MOUSESHOW .
 212 .Pp
 213 .Fn VGLMouseMode
 214 either shows the mouse pointer if the argument is
 215 .Dv VGL_MOUSESHOW ,
 216 or hides the mouse pointer if the argument is
 217 .Dv VGL_MOUSEHIDE .
 218 .Pp
 219 .Fn VGLMouseStatus
 220 returns the current mouse pointer coordinates and button state in
 221 .Va x , y ,
 222 buttons.
 223 The return value reflects if the mouse pointer
 224 is currently shown on screen or not.
 225 .Pp
 226 .Fn VGLMouseSetImage
 227 with this function it is possible to change the image of the mouse pointer
 228 on screen.
 229 .Pp
 230 .Fn VGLMouseSetStdImage
 231 this function restores the mouse pointer to the standard arrow.
 232 .Pp
 233 .Fn VGLGetXY
 234 retrieves the color of the pixel located at
 235 .Va x , y ,
 236 coordinates of the
 237 .Va object
 238 argument, and returns it as a byte value.
 239 .Pp
 240 .Fn VGLSetXY
 241 sets the color of the pixel located at
 242 .Va x , y ,
 243 coordinates of the
 244 .Va object
 245 argument to
 246 .Va color
 247 byte value.
 248 .Pp
 249 .Fn VGLLine
 250 draw a line from
 251 .Va x1 , y1
 252 to
 253 .Va x2 , y2
 254 in color
 255 .Va color .
 256 .Pp
 257 .Fn VGLBox
 258 draw a box with upper left hand corner at
 259 .Va x1 , y1
 260 and lower right hand corner at
 261 .Va x2 , y2
 262 in color
 263 .Va color .
 264 .Pp
 265 .Fn VGLFilledBox
 266 draw a filled (solid) box with upper left hand corner at
 267 .Va x1 , y1
 268 and lower right hand corner at
 269 .Va x2 , y2
 270 in color
 271 .Va color .
 272 .Pp
 273 .Fn VGLEllipse
 274 draw an ellipse centered at
 275 .Va xc , yc
 276 make it
 277 .Va a
 278 pixels wide, and
 279 .Va b
 280 pixels high in color
 281 .Va color .
 282 .Pp
 283 .Fn VGLFilledEllipse
 284 draw a filled (solid) ellipse centered at
 285 .Va xc , yc
 286 make it
 287 .Va a
 288 pixels wide, and
 289 .Va b
 290 pixels high in color
 291 .Va color .
 292 .Pp
 293 .Fn VGLBitmapCreate
 294 create a bitmap object and initialize it with the specified
 295 values and bit data.
 296 .Va type
 297 must be
 298 .Dv MEMBUF
 299 for the in-memory bitmap.
 300 .Va bits
 301 may be NULL so that bitmap data may be associated later.
 302 .Pp
 303 There also is a macro,
 304 .Fn VGLBITMAP_INITIALIZER "type" "xsize" "ysize" "bits"
 305 to initialize a statically declared bitmap object.
 306 .Pp
 307 .Fn VGLBitmapDestroy
 308 free the bitmap data and the bitmap object.
 309 .Pp
 310 .Fn VGLBitmapAllocateBits
 311 allocate a bit data buffer for the specified object.
 312 .Pp
 313 .Fn VGLBitmapCopy
 314 copy a rectangle of pixels from bitmap
 315 .Va src
 316 upper left hand corner at
 317 .Va srcx , srcy
 318 to bitmap
 319 .Va dst
 320 at
 321 .Va dstx , dsty
 322 of the size
 323 .Va width , height .
 324 .Pp
 325 .Fn VGLBitmapPutChar
 326 write the character
 327 .Va ch
 328 at position
 329 .Va x , y
 330 in foreground color
 331 .Va fgcol .
 332 If
 333 .Va fill
 334 is != 0, use the color
 335 .Va bgcol
 336 as background otherwise the background is transparent.
 337 The character is drawn in the direction specified by the argument
 338 .Va dir .
 339 .Pp
 340 .Fn VGLBitmapString
 341 write the string
 342 .Va str
 343 at position
 344 .Va x , y
 345 in foreground color
 346 .Va fgcol .
 347 If
 348 .Va fill
 349 is != 0, use the color
 350 .Va bgcol
 351 as background otherwise the background is transparent.
 352 The string is drawn in the direction specified by the argument
 353 .Va dir .
 354 .Pp
 355 .Fn VGLClear
 356 clears the entire bitmap to color
 357 .Va color .
 358 .Pp
 359 .Fn VGLSetPalette
 360 this function sets the palette used, the arguments
 361 .Va red , green , blue
 362 should point to byte arrays of 256 positions each.
 363 .Pp
 364 .Fn VGLSetPaletteIndex
 365 set the palette index
 366 .Va color
 367 to the specified RGB value.
 368 .Pp
 369 .Fn VGLSetBorder
 370 set the border color to color
 371 .Va color .
 372 .Pp
 373 .Fn VGLSetVScreenSize
 374 change the virtual screen size of the display.  Note that this
 375 function must be called when our vty is in the foreground.
 376 And
 377 .Va object
 378 must be
 379 .Va VGLDisplay .
 380 Passing an in-memory bitmap to this function results in error.
 381 .Pp
 382 The desired virtual screen width may not be achievable because
 383 of the video card hardware.  In such case the video driver (and
 384 underlaying video BIOS) may choose the next largest values.
 385 Always examine
 386 .Va object->VXsize
 387 and
 388 .Va VYsize
 389 after calling this function, in order to see how the virtual screen
 390 is actually set up.
 391 .Pp
 392 In order to set up the largest possible virtual screen, you may
 393 call this function with arbitrary large values.
 394 .Pp
 395 .Dl VGLSetVScreenSize(10000, 10000);
 396 .Pp
 397 .Fn VGLPanScreen
 398 change the origin of the displayed screen in the virtual screen.
 399 Note that this function must be called when our vty is in the
 400 foreground.
 401 .Va object
 402 must be
 403 .Va VGLDisplay .
 404 Passing an in-memory bitmap to this function results in error.
 405 .Pp
 406 .Fn VGLBlankDisplay
 407 blank the display if the argument
 408 .Va blank
 409 \*(Ne 0.
 410 This can be done to shut off the screen during display updates that
 411 the user should first see when it's done.
 412 .Ss Program termination and signal processing
 413 It is important to call
 414 .Fn VGLEnd
 415 before terminating the program.
 416 Care must be taken if you install signal handlers and try to call
 417 .Fn VGLEnd
 418 and
 419 .Xr exit 3
 420 to end the program.
 421 If a signal is caught while the program is inside
 422 .Nm libvgl
 423 functions,
 424 .Fn VGLEnd
 425 may not be able to properly restore the graphics hardware.
 426 .Pp
 427 The recommended way to handle signals and program termination is to
 428 have a flag to indicate signal's delivery.
 429 Your signal handlers set this flag but do not terminate
 430 the program immediately.
 431 The main part of the program checks the flag to see if it is
 432 supposed to terminate, and calls
 433 .Fn VGLEnd
 434 and
 435 .Xr exit 3
 436 if the flag is set.
 437 .Pp
 438 Note that
 439 .Fn VGLInit
 440 installs its internal signal handlers for
 441 .Dv SIGINT , SIGTERM , SIGSEGV ,
 442 and
 443 .Dv SIGBUS ,
 444 and terminates the program at appropriate time,
 445 after one of these signals is caught.
 446 If you want to have your own signal handlers for these signals,
 447 install handlers
 448 .Em after
 449 .Fn VGLInit .
 450 .Pp
 451 .Dv SIGUSR1
 452 and
 453 .Dv SIGUSR2
 454 are internally used by
 455 .Nm libvgl
 456 to control screen switching and the mouse pointer,
 457 and are not available to
 458 .Nm libvgl
 459 client programs.
 460 .Sh HISTORY
 461 The
 462 .Nm vgl
 463 library appeared in
 464 .Fx 3.0 .
 465 .Sh AUTHORS
 466 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org