Added and cleaned API docs.
[wine] / dlls / winedos / vga.h
1 /*
2  * VGA emulation
3  *
4  * Copyright 1998 Ove KÅven
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef __WINE_VGA_H
22 #define __WINE_VGA_H
23
24 #include <stdarg.h>
25
26 #include "windef.h"
27 #include "winbase.h"
28 #include "wingdi.h"
29
30 /* graphics mode */
31 int VGA_SetMode(unsigned Xres,unsigned Yres,unsigned Depth);
32 int VGA_GetMode(unsigned*Height,unsigned*Width,unsigned*Depth);
33 void VGA_SetPalette(PALETTEENTRY*pal,int start,int len);
34 void VGA_SetColor16(int reg,int color);
35 char VGA_GetColor16(int reg);
36 void VGA_Set16Palette(char *Table);
37 void VGA_Get16Palette(char *Table);
38 void VGA_SetQuadPalette(RGBQUAD*color,int start,int len);
39 LPSTR VGA_Lock(unsigned*Pitch,unsigned*Height,unsigned*Width,unsigned*Depth);
40 void VGA_Unlock(void);
41 void VGA_SetWindowStart(int start);
42 int  VGA_GetWindowStart();
43
44 /* text mode */
45 void VGA_InitAlphaMode(unsigned*Xres,unsigned*Yres);
46 void VGA_SetAlphaMode(unsigned Xres,unsigned Yres);
47 BOOL VGA_GetAlphaMode(unsigned*Xres,unsigned*Yres);
48 void VGA_SetCursorShape(unsigned char start_options,unsigned char end);
49 void VGA_SetCursorPos(unsigned X,unsigned Y);
50 void VGA_GetCursorPos(unsigned*X,unsigned*Y);
51 void VGA_WriteChars(unsigned X,unsigned Y,unsigned ch,int attr,int count);
52 void VGA_PutChar(BYTE ascii);
53 void VGA_SetTextAttribute(BYTE attr);
54 void VGA_ClearText(unsigned row1, unsigned col1,
55                   unsigned row2, unsigned col2,
56                   BYTE attr);
57 void VGA_ScrollUpText(unsigned row1, unsigned col1,
58                      unsigned row2, unsigned col2,
59                      unsigned lines, BYTE attr);
60 void VGA_ScrollDownText(unsigned row1, unsigned col1,
61                        unsigned row2, unsigned col2,
62                        unsigned lines, BYTE attr);
63 void VGA_GetCharacterAtCursor(BYTE *ascii, BYTE *attr);
64
65 /* control */
66 void VGA_ioport_out(WORD port, BYTE val);
67 BYTE VGA_ioport_in(WORD port);
68 void VGA_Clean(void);
69
70 #endif /* __WINE_VGA_H */