lib/libvgl/vgl.3

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