removed gl_videosyncavailable variable because on all known platforms it
[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_mode_s
30 {
31         int width;
32         int height;
33         int bitsperpixel;
34         qboolean fullscreen;
35         float refreshrate;
36         qboolean userefreshrate;
37         qboolean stereobuffer;
38         int samples;
39 }
40 viddef_mode_t;
41
42 typedef struct viddef_s
43 {
44         // these are set by VID_Mode
45         viddef_mode_t mode;
46         // used in many locations in the renderer
47         int width;
48         int height;
49         int bitsperpixel;
50         qboolean fullscreen;
51         float refreshrate;
52         qboolean userefreshrate;
53         qboolean stereobuffer;
54         int samples;
55         qboolean stencil;
56 } viddef_t;
57
58 // global video state
59 extern viddef_t vid;
60 extern void (*vid_menudrawfn)(void);
61 extern void (*vid_menukeyfn)(int key);
62
63 extern qboolean vid_hidden;
64 extern qboolean vid_activewindow;
65 extern cvar_t vid_hardwaregammasupported;
66 extern qboolean vid_usinghwgamma;
67 extern qboolean vid_supportrefreshrate;
68
69 extern cvar_t vid_fullscreen;
70 extern cvar_t vid_width;
71 extern cvar_t vid_height;
72 extern cvar_t vid_bitsperpixel;
73 extern cvar_t vid_samples;
74 extern cvar_t vid_refreshrate;
75 extern cvar_t vid_userefreshrate;
76 extern cvar_t vid_vsync;
77 extern cvar_t vid_mouse;
78 extern cvar_t vid_grabkeyboard;
79 extern cvar_t vid_stick_mouse;
80 extern cvar_t vid_resizable;
81 extern cvar_t vid_minwidth;
82 extern cvar_t vid_minheight;
83
84 extern cvar_t gl_combine;
85 extern cvar_t gl_finish;
86
87 extern cvar_t v_gamma;
88 extern cvar_t v_contrast;
89 extern cvar_t v_brightness;
90 extern cvar_t v_color_enable;
91 extern cvar_t v_color_black_r;
92 extern cvar_t v_color_black_g;
93 extern cvar_t v_color_black_b;
94 extern cvar_t v_color_grey_r;
95 extern cvar_t v_color_grey_g;
96 extern cvar_t v_color_grey_b;
97 extern cvar_t v_color_white_r;
98 extern cvar_t v_color_white_g;
99 extern cvar_t v_color_white_b;
100 extern cvar_t v_hwgamma;
101
102 // brand of graphics chip
103 extern const char *gl_vendor;
104 // graphics chip model and other information
105 extern const char *gl_renderer;
106 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
107 extern const char *gl_version;
108 // extensions list, space separated
109 extern const char *gl_extensions;
110 // WGL, GLX, or AGL
111 extern const char *gl_platform;
112 // another extensions list, containing platform-specific extensions that are
113 // not in the main list
114 extern const char *gl_platformextensions;
115 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
116 extern char gl_driver[256];
117
118 // compatibility hacks
119 extern qboolean isG200;
120 extern qboolean isRagePro;
121
122 void *GL_GetProcAddress(const char *name);
123 int GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
124
125 void VID_Shared_Init(void);
126
127 void GL_Init (void);
128
129 void VID_CheckExtensions(void);
130
131 void VID_Init (void);
132 // Called at startup
133
134 void VID_Shutdown (void);
135 // Called at shutdown
136
137 int VID_SetMode (int modenum);
138 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
139 // base mode) on memory allocation failures
140
141 qboolean VID_InitMode(viddef_mode_t *mode);
142 // allocates and opens an appropriate OpenGL context (and its window)
143
144
145 // sets hardware gamma correction, returns false if the device does not
146 // support gamma control
147 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
148 int VID_SetGamma(unsigned short *ramps, int rampsize);
149 // gets hardware gamma correction, returns false if the device does not
150 // support gamma control
151 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
152 int VID_GetGamma(unsigned short *ramps, int rampsize);
153 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
154 // (ONLY to be called from VID_Finish!)
155 void VID_UpdateGamma(qboolean force, int rampsize);
156 // turns off hardware gamma ramps immediately
157 // (called from various shutdown/deactivation functions)
158 void VID_RestoreSystemGamma(void);
159
160 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
161 void VID_Finish (void);
162
163 void VID_Restart_f(void);
164
165 void VID_Start(void);
166
167 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
168 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
169 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
170
171 typedef struct
172 {
173         int width, height, bpp, refreshrate;
174         int pixelheight_num, pixelheight_denom;
175 }
176 vid_mode_t;
177 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
178 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
179 #endif
180