- vid_userefreshrate: when 0, a sane default is tried to be used
[xonotic/darkplaces.git] / vid.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // vid.h -- video driver defs
21
22 #ifndef VID_H
23 #define VID_H
24
25 #define ENGINE_ICON ( (gamemode == GAME_NEXUIZ) ? nexuiz_xpm : darkplaces_xpm )
26
27 extern int cl_available;
28
29 typedef struct viddef_s
30 {
31         // these are set by VID_Mode
32         int width;
33         int height;
34         int bitsperpixel;
35         int fullscreen;
36         int refreshrate;
37         qboolean userefreshrate;
38         int stereobuffer;
39 } viddef_t;
40
41 // global video state
42 extern viddef_t vid;
43 extern void (*vid_menudrawfn)(void);
44 extern void (*vid_menukeyfn)(int key);
45
46 extern qboolean vid_hidden;
47 extern qboolean vid_activewindow;
48 extern cvar_t vid_hardwaregammasupported;
49 extern qboolean vid_usinghwgamma;
50 extern qboolean vid_supportrefreshrate;
51
52 extern cvar_t vid_fullscreen;
53 extern cvar_t vid_width;
54 extern cvar_t vid_height;
55 extern cvar_t vid_bitsperpixel;
56 extern cvar_t vid_refreshrate;
57 extern cvar_t vid_userefreshrate;
58 extern cvar_t vid_vsync;
59 extern cvar_t vid_mouse;
60 extern cvar_t vid_grabkeyboard;
61 extern cvar_t vid_stick_mouse;
62 extern cvar_t vid_resizable;
63 extern cvar_t vid_minwidth;
64 extern cvar_t vid_minheight;
65
66 extern cvar_t gl_combine;
67 extern cvar_t gl_finish;
68
69 extern cvar_t v_gamma;
70 extern cvar_t v_contrast;
71 extern cvar_t v_brightness;
72 extern cvar_t v_color_enable;
73 extern cvar_t v_color_black_r;
74 extern cvar_t v_color_black_g;
75 extern cvar_t v_color_black_b;
76 extern cvar_t v_color_grey_r;
77 extern cvar_t v_color_grey_g;
78 extern cvar_t v_color_grey_b;
79 extern cvar_t v_color_white_r;
80 extern cvar_t v_color_white_g;
81 extern cvar_t v_color_white_b;
82 extern cvar_t v_hwgamma;
83
84 extern int gl_stencil;
85
86 // brand of graphics chip
87 extern const char *gl_vendor;
88 // graphics chip model and other information
89 extern const char *gl_renderer;
90 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
91 extern const char *gl_version;
92 // extensions list, space separated
93 extern const char *gl_extensions;
94 // WGL, GLX, or AGL
95 extern const char *gl_platform;
96 // another extensions list, containing platform-specific extensions that are
97 // not in the main list
98 extern const char *gl_platformextensions;
99 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
100 extern char gl_driver[256];
101
102 // compatibility hacks
103 extern qboolean isG200;
104 extern qboolean isRagePro;
105
106 // LordHavoc: GLX_SGI_swap_control and WGL_EXT_swap_control
107 extern int gl_videosyncavailable;
108
109 void *GL_GetProcAddress(const char *name);
110 int GL_CheckExtension(const char *name, const dllfunction_t *funcs, const char *disableparm, int silent);
111
112 void VID_Shared_Init(void);
113
114 void GL_Init (void);
115
116 void VID_CheckExtensions(void);
117
118 void VID_Init (void);
119 // Called at startup
120
121 void VID_Shutdown (void);
122 // Called at shutdown
123
124 int VID_SetMode (int modenum);
125 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
126 // base mode) on memory allocation failures
127
128 int VID_InitMode(int fullscreen, int width, int height, int bpp, int refreshrate, int stereobuffer);
129 // allocates and opens an appropriate OpenGL context (and its window)
130
131
132 // sets hardware gamma correction, returns false if the device does not
133 // support gamma control
134 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
135 int VID_SetGamma(unsigned short *ramps, int rampsize);
136 // gets hardware gamma correction, returns false if the device does not
137 // support gamma control
138 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
139 int VID_GetGamma(unsigned short *ramps, int rampsize);
140 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
141 // (ONLY to be called from VID_Finish!)
142 void VID_UpdateGamma(qboolean force, int rampsize);
143 // turns off hardware gamma ramps immediately
144 // (called from various shutdown/deactivation functions)
145 void VID_RestoreSystemGamma(void);
146
147 void VID_Finish (qboolean allowmousegrab);
148
149 void VID_Restart_f(void);
150
151 void VID_Start(void);
152
153 extern unsigned int vid_gammatables_serial; // so other subsystems can poll if gamma parameters have changed; this starts with 0 and gets increased by 1 each time the gamma parameters get changed and VID_BuildGammaTables should be called again
154 extern qboolean vid_gammatables_trivial; // this is set to true if all color control values are at default setting, and it therefore would make no sense to use the gamma table
155 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
156 #endif
157