d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/lib/libvgl/vgl.h

164 lines
5.6 KiB
C
Raw Permalink Normal View History

First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
/*-
lib: further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using mis-identified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts.
2017-11-26 02:00:33 +00:00
* SPDX-License-Identifier: BSD-3-Clause
*
Convert files to UTF-8 and add some copyright markers where missing.
2012-01-07 16:13:56 +00:00
* Copyright (c) 1991-1997 Søren Schmidt
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
* All rights reserved.
*
* 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
Fix typo in the BSD copyright: s/withough/without/ Spotted and suggested by: des MFC after: 3 weeks
2002-06-02 20:05:59 +00:00
* derived from this software without specific prior written permission
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +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.
*
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
* $FreeBSD$
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
*/
Protect against multiple inclusion.
2001-01-24 09:06:42 +00:00
#ifndef _VGL_H_
#define _VGL_H_
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <machine/cpufunc.h>
typedef unsigned char byte;
typedef struct {
byte Type;
int Xsize, Ysize;
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
int VXsize, VYsize;
int Xorigin, Yorigin;
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
byte *Bitmap;
Add Truecolor 16 and 32bits support. Note that 24bits modes are not supported since it's not easy to put 3 bytes accross 64Kb windows of memory. This should not be such a problem with linear framebuffers. There is no major interface modification except that the color type becomes u_long instead of byte. So one just need to recompile his application. Approved by: Soren Schmidt <sos@freebsd.dk>
2001-01-13 11:30:17 +00:00
int PixelBytes;
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
} VGLBitmap;
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
#define VGLBITMAP_INITIALIZER(t, x, y, bits) \
Fix buffer overruns in modes with color depth more than 8. Support for 16-bit and 32-bit Truecolor modes was supposed to be complete in r70991 of main.c and in nearby revisions for other files, but it was broken by the overruns in most cases (all cases were the mouse is enabled, and most cases where bitmaps are used). r70991 also uninintentionally added support for depths 9-15, 17-23 and 25-31. Depth 24 was more obviously broken and its support is ifdefed out. In the other ranges, only depth 15 is common. It was broken by buffer overruns in all cases. bitmap.c: - the static buffer was used even when it was too small (but it was large enough to often work accidentally in depth 16) - the size of the dynamically allocated buffer was too small - the sizing info bitmap->PixelBytes was not inititialzed in the bitmap constructor. It often ended up as 0 for MEMBUFs, so using it in more places gave more null pointer accesses. (It is per-bitmap, but since conversion between bitmaps of different depths is not supported (except from 4 bits by padding to 8), it would work better if it were global.) main.c: - depths were rounded down instead of up to a multiple of 8, so PixelBytes was 1 too small for depths above 8 except 16, 24 and 32. - PixelBytes was not initialized for 4-bit planar modes. It isn't really used for frame buffer accesses in these modes, but needs to be 1 in MEMBUF images. mouse.c: - the mouse cursor buffers were too small. vgl.h: - PixelBytes was not initialized in the static bitmap constructor. It should be initialized to the value for the current mode, but that is impossible in a static constructor. Initialize it to -1 so as to fail if it is used without further initialization. All modes that are supposed to be supported now don't crash in nontrivial tests, and almost work. Missing uses of PixelBytes now give in-bounds wrong pointers instead of overruns. Misconversions of bitmaps give multiple miscolored mouse cursors instead of 1 white one, and similarly for bitmaps copied through a MEMBUF.
2019-03-24 18:57:03 +00:00
{ (t), (x), (y), (x), (y), 0, 0, (bits), -1 }
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
/*
* Defined Type's
*/
#define MEMBUF 0
#define VIDBUF4 1
#define VIDBUF8 2
#define VIDBUF8X 3
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
#define VIDBUF8S 4
#define VIDBUF4S 5
Add Truecolor 16 and 32bits support. Note that 24bits modes are not supported since it's not easy to put 3 bytes accross 64Kb windows of memory. This should not be such a problem with linear framebuffers. There is no major interface modification except that the color type becomes u_long instead of byte. So one just need to recompile his application. Approved by: Soren Schmidt <sos@freebsd.dk>
2001-01-13 11:30:17 +00:00
#define VIDBUF16 6 /* Direct Color linear buffer */
#define VIDBUF24 7 /* Direct Color linear buffer */
#define VIDBUF32 8 /* Direct Color linear buffer */
#define VIDBUF16S 9 /* Direct Color segmented buffer */
#define VIDBUF24S 10 /* Direct Color segmented buffer */
#define VIDBUF32S 11 /* Direct Color segmented buffer */
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
#define NOBUF 255
typedef struct VGLText {
byte Width, Height;
byte *BitmapArray;
} VGLText;
typedef struct VGLObject {
int Id;
int Type;
int Status;
int Xpos, Ypos;
int Xhot, Yhot;
VGLBitmap *Image;
VGLBitmap *Mask;
int (*CallBackFunction)();
} VGLObject;
#define MOUSE_IMG_SIZE 16
#define VGL_MOUSEHIDE 0
#define VGL_MOUSESHOW 1
#define VGL_MOUSEFREEZE 0
#define VGL_MOUSEUNFREEZE 1
#define VGL_DIR_RIGHT 0
#define VGL_DIR_UP 1
#define VGL_DIR_LEFT 2
#define VGL_DIR_DOWN 3
Add rudimentary support for using the keyboard.
1997-10-01 20:53:41 +00:00
#define VGL_RAWKEYS 1
#define VGL_CODEKEYS 2
#define VGL_XLATEKEYS 3
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
extern video_adapter_info_t VGLAdpInfo;
extern video_info_t VGLModeInfo;
extern VGLBitmap *VGLDisplay;
Use a shadow buffer and never read from the frame buffer. Remove large slow code for reading from the frame buffer. Reading from the frame buffer is usually much slower than writing to the frame buffer. Typically 10 to 100 times slower. It old modes, it takes many more PIOs, and in newer modes with no PIOs writes are often write-combined while reads remain uncached. Reading from the frame buffer is not very common, so this change doesn't give speedups of 10 to 100 times. My main test case is a floodfill() function that reads about as many pixels as it writes. The speedups are typically a factor of 2 to 4. Duplicating writes to the shadow buffer is slower when no reads from the frame buffer are done, but reads are often done for the pixels under the mouse cursor, and doing these reads from the shadow buffer more than compensates for the overhead of writing the shadow buffer in at least the slower modes. Management of the mouse cursor also becomes simpler. The shadow buffer doesn't take any extra memory, except twice as much in old 4-plane modes. A buffer for holding a copy of the frame buffer was allocated up front for use in the screen switching signal handler. This wasn't changed when the handler was made async-signal safe. Use the same buffer the shadow (but make it twice as large in the 4-plane modes), and remove large special code for writing it as well as large special code for reading ut. It used to have a rawer format in the 4-plane modes. Now it has a bitmap format which takes twice as much memory but can be written almost as fast without special code. VIDBUFs that are not the whole frame buffer were never supported, and the change depends on this. Check for invalid VIDBUFs in some places and do nothing. The removed code did something not so good.
2019-04-21 16:17:35 +00:00
extern VGLBitmap VGLVDisplay;
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
extern byte *VGLBuf;
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
/*
* Prototypes
*/
/* bitmap.c */
int __VGLBitmapCopy(VGLBitmap *src, int srcx, int srcy, VGLBitmap *dst, int dstx, int dsty, int width, int hight);
int VGLBitmapCopy(VGLBitmap *src, int srcx, int srcy, VGLBitmap *dst, int dstx, int dsty, int width, int hight);
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
VGLBitmap *VGLBitmapCreate(int type, int xsize, int ysize, byte *bits);
void VGLBitmapDestroy(VGLBitmap *object);
int VGLBitmapAllocateBits(VGLBitmap *object);
Fix mouse cursor coloring in depths > 8 (previously, a hack that only worked right for white interiors and black borders was used). Advertise this by changing the default colors to a red interior and a white border (the same as the kernel default). Add undocumented env variables for changing these colors. Also change to the larger and better-shaped 16x10 cursor sometimes used in the kernel. The kernel choice is fancier, but libvgl is closer to supporting the larger cursors needed in newer modes. The (n)and-or logic for the cursor doesn't work right for more than 2 colors. The (n)and part only masks out all color bits for the pixel under the cursor when all bits are set in the And mask. With more complicated logic, the non-masked bits could be used to implement translucent cursors, but they actually just gave strange colors (especially in packed and planar modes where the bits are indirect through 1 or 2 palettes so it is hard to predict the final color). They also gave a bug for writing pixels under the cursor. The non-masked bits under the cursor were not combined in this case. Drop support for combining with bits under the cursor by making any nonzero value in the And mask mean all bits set. Convert the Or mask (which is represented as a half-initialized 256-color bitmap) to a fully initialized bitmap with the correct number of colors. The 256-color representation must be as in 3:3:2 direct mode iff the final bitmap has more than 256 colors. The conversion of colors is not very efficient, so convert at initialization time.
2019-04-22 19:31:16 +00:00
void VGLBitmapCvt(VGLBitmap *src, VGLBitmap *dst);
Add rudimentary support for using the keyboard.
1997-10-01 20:53:41 +00:00
/* keyboard.c */
int VGLKeyboardInit(int mode);
void VGLKeyboardEnd(void);
int VGLKeyboardGetCh(void);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
/* main.c */
void VGLEnd(void);
int VGLInit(int mode);
void VGLCheckSwitch(void);
- This is the new version of libvgl jointly developed by sos and I. It adds new functions and extend some structures and can handle VESA modes. - Update the man page. - Bump the library version number. (The old version will be added to compat3x.)
1999-11-08 11:37:46 +00:00
int VGLSetVScreenSize(VGLBitmap *object, int VXsize, int VYsize);
int VGLPanScreen(VGLBitmap *object, int x, int y);
int VGLSetSegment(unsigned int offset);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
/* mouse.c */
Refactor and simplify hiding the mouse cursor and fix bugs caused by complications in the previous methods. r346761 broke showing the mouse cursor after changing its state from off to on (including initially), since showing the cursor uses the state to decide whether to actually show and the state variable was not changed until after null showing. Moving the mouse or copying under the cursor fixed the problem. Fix this and similar problems for the on to off transition by changing the state variable before drawing the cursor. r346641 failed to turn off the mouse cursor on exit from vgl. It hid the cursor only temporarily for clearing. This doesn't change the state variable, so unhiding the cursor after clearing restored the cursor if its state was on. Fix this by changing its state to VGL_MOUSEHIDE using the application API for changing the state. Remove the VGLMouseVisible state variable and the extra states given by it. This was an optimization that was just an obfuscation in at least the previous version. Staticize VGLMouseAction(). Remove VGLMousePointerShow/Hide() except as internals in __VGLMouseMode(). __VGLMouseMouseMode() is the same as the application API VGLMouseMouseMode() except it returns the previous mode which callers need to know to restore it after hiding the cursor. Use the refactoring to make minor improvements in a simpler way than was possible: - in VGLMouseAction(), only hide and and unhide the mouse cursor if the mouse moved - in VGLClear(), only hide and and unhide the mouse cursor if the clearing method would otherwise clear the cursor.
2019-04-29 14:13:53 +00:00
int __VGLMouseMode(int mode);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
void VGLMouseMode(int mode);
void VGLMouseSetImage(VGLBitmap *AndMask, VGLBitmap *OrMask);
void VGLMouseSetStdImage(void);
int VGLMouseInit(int mode);
Fix missing restoring of the mouse cursor position, the border color and the blank state after a screen switch.
2019-04-21 10:33:09 +00:00
void VGLMouseRestore(void);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
int VGLMouseStatus(int *x, int *y, char *buttons);
Refactor mouse freezing and fix some minor bugs. VGLMouseFreeze() now only defers mouse signals and leaves it to higher levels to hide and unhide the mouse cursor if necessary. (It is never necessary, but is done to simplify the implementation. It is slow and flashes the cursor. It is still done for copying bitmaps and clearing.) VGLMouseUnFreeze() now only undoes 1 level of freezing. Its old optimization to reduce mouse redrawing is too hard to do with unhiding in higher levels, and its undoing of multiple levels was a historical mistake. VGLMouseOverlap() determines if a region overlaps the (full) mouse region. VGLMouseFreezeXY() is the freezing and a precise overlap check combined for the special case of writing a single pixel. This is the single-pixel case of the old VGLMouseFreeze() with cleanups. Fixes: - check in more cases that the application didn't pass an invalid VIDBUF - check for errors from copying a bitmap to the shadow buffer - freeze the mouse before writing to the shadow buffer in all cases. This was not done for the case of writing a single pixel (there was a race) - don't spell the #defined values for VGLMouseShown as 0, 1 or boolean.
2019-04-24 15:35:29 +00:00
void VGLMouseFreeze(void);
int VGLMouseFreezeXY(int x, int y);
Avoid hiding and unhiding the mouse cursor when copying bitmaps to the screen. Instead, copy a merged bitmap 1 line at a time. This fixes flashing of the cursor and is faster in all modes (especially in planar modes).
2019-04-24 16:03:35 +00:00
void VGLMouseMerge(int x, int y, int width, byte *line);
Refactor mouse freezing and fix some minor bugs. VGLMouseFreeze() now only defers mouse signals and leaves it to higher levels to hide and unhide the mouse cursor if necessary. (It is never necessary, but is done to simplify the implementation. It is slow and flashes the cursor. It is still done for copying bitmaps and clearing.) VGLMouseUnFreeze() now only undoes 1 level of freezing. Its old optimization to reduce mouse redrawing is too hard to do with unhiding in higher levels, and its undoing of multiple levels was a historical mistake. VGLMouseOverlap() determines if a region overlaps the (full) mouse region. VGLMouseFreezeXY() is the freezing and a precise overlap check combined for the special case of writing a single pixel. This is the single-pixel case of the old VGLMouseFreeze() with cleanups. Fixes: - check in more cases that the application didn't pass an invalid VIDBUF - check for errors from copying a bitmap to the shadow buffer - freeze the mouse before writing to the shadow buffer in all cases. This was not done for the case of writing a single pixel (there was a race) - don't spell the #defined values for VGLMouseShown as 0, 1 or boolean.
2019-04-24 15:35:29 +00:00
int VGLMouseOverlap(int x, int y, int width, int hight);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
void VGLMouseUnFreeze(void);
/* simple.c */
Add Truecolor 16 and 32bits support. Note that 24bits modes are not supported since it's not easy to put 3 bytes accross 64Kb windows of memory. This should not be such a problem with linear framebuffers. There is no major interface modification except that the color type becomes u_long instead of byte. So one just need to recompile his application. Approved by: Soren Schmidt <sos@freebsd.dk>
2001-01-13 11:30:17 +00:00
void VGLSetXY(VGLBitmap *object, int x, int y, u_long color);
u_long VGLGetXY(VGLBitmap *object, int x, int y);
void VGLLine(VGLBitmap *object, int x1, int y1, int x2, int y2, u_long color);
void VGLBox(VGLBitmap *object, int x1, int y1, int x2, int y2, u_long color);
void VGLFilledBox(VGLBitmap *object, int x1, int y1, int x2, int y2, u_long color);
void VGLEllipse(VGLBitmap *object, int xc, int yc, int a, int b, u_long color);
void VGLFilledEllipse(VGLBitmap *object, int xc, int yc, int a, int b, u_long color);
void VGLClear(VGLBitmap *object, u_long color);
Fix mouse cursor coloring in depths > 8 (previously, a hack that only worked right for white interiors and black borders was used). Advertise this by changing the default colors to a red interior and a white border (the same as the kernel default). Add undocumented env variables for changing these colors. Also change to the larger and better-shaped 16x10 cursor sometimes used in the kernel. The kernel choice is fancier, but libvgl is closer to supporting the larger cursors needed in newer modes. The (n)and-or logic for the cursor doesn't work right for more than 2 colors. The (n)and part only masks out all color bits for the pixel under the cursor when all bits are set in the And mask. With more complicated logic, the non-masked bits could be used to implement translucent cursors, but they actually just gave strange colors (especially in packed and planar modes where the bits are indirect through 1 or 2 palettes so it is hard to predict the final color). They also gave a bug for writing pixels under the cursor. The non-masked bits under the cursor were not combined in this case. Drop support for combining with bits under the cursor by making any nonzero value in the And mask mean all bits set. Convert the Or mask (which is represented as a half-initialized 256-color bitmap) to a fully initialized bitmap with the correct number of colors. The 256-color representation must be as in 3:3:2 direct mode iff the final bitmap has more than 256 colors. The conversion of colors is not very efficient, so convert at initialization time.
2019-04-22 19:31:16 +00:00
u_long VGLrgb332ToNative(byte c);
Fix missing restoring of the mouse cursor position, the border color and the blank state after a screen switch.
2019-04-21 10:33:09 +00:00
void VGLRestoreBlank(void);
void VGLRestoreBorder(void);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
void VGLRestorePalette(void);
void VGLSavePalette(void);
void VGLSetPalette(byte *red, byte *green, byte *blue);
void VGLSetPaletteIndex(byte color, byte red, byte green, byte blue);
Oops, my previous commit to libvgl was missing the change of VGLSetBorder() to match the change in its declaration. Change the declaration back to "byte color" since setting of the border color is not supported for more than 256 colors.
2019-03-24 20:43:21 +00:00
void VGLSetBorder(byte color);
First import of my little "video graphic library". See the manpage vgl.3 for more info. A little example will follow shortly.
1997-08-17 21:09:35 +00:00
void VGLBlankDisplay(int blank);
/* text.c */
int VGLTextSetFontFile(char *filename);
Fix the type of the color args for VGLMouseFreeze(), VGLBitmapPutChar(), VGLBitmapString() and VGLSetBorder() so as to not truncate to 8 bits. Complete the corresponding fix for VGLGetXY() and VGLPutXY() (parts of the man page were out of date).
2019-03-24 20:36:35 +00:00
void VGLBitmapPutChar(VGLBitmap *Object, int x, int y, byte ch, u_long fgcol, u_long bgcol, int fill, int dir);
void VGLBitmapString(VGLBitmap *Object, int x, int y, char *str, u_long fgcol, u_long bgcol, int fill, int dir);
Protect against multiple inclusion.
2001-01-24 09:06:42 +00:00
#endif /* !_VGL_H_ */
Reference in New Issue Copy Permalink