rename netwmfullscreen to desktopfullscreen; implement in other drivers (except agl)
[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 #define MAX_TEXTUREUNITS 16
30
31 typedef enum renderpath_e
32 {
33         RENDERPATH_GL11,
34         RENDERPATH_GL13,
35         RENDERPATH_GL20,
36         RENDERPATH_D3D9,
37         RENDERPATH_D3D10,
38         RENDERPATH_D3D11,
39         RENDERPATH_SOFT,
40         RENDERPATH_GLES1,
41         RENDERPATH_GLES2
42 }
43 renderpath_t;
44
45 typedef struct viddef_support_s
46 {
47         qboolean gl20shaders;
48         qboolean gl20shaders130; // indicates glBindFragDataLocation is available
49         int glshaderversion; // typical values: 100 110 120 130 140 ...
50         qboolean amd_texture_texture4;
51         qboolean arb_depth_texture;
52         qboolean arb_draw_buffers;
53         qboolean arb_framebuffer_object;
54         qboolean arb_multitexture;
55         qboolean arb_occlusion_query;
56         qboolean arb_shadow;
57         qboolean arb_texture_compression;
58         qboolean arb_texture_cube_map;
59         qboolean arb_texture_env_combine;
60         qboolean arb_texture_gather;
61         qboolean arb_texture_non_power_of_two;
62         qboolean arb_vertex_buffer_object;
63         qboolean arb_uniform_buffer_object;
64         qboolean ati_separate_stencil;
65         qboolean ext_blend_minmax;
66         qboolean ext_blend_subtract;
67         qboolean ext_blend_func_separate;
68         qboolean ext_draw_range_elements;
69         qboolean ext_framebuffer_object;
70         qboolean ext_packed_depth_stencil;
71         qboolean ext_stencil_two_side;
72         qboolean ext_texture_3d;
73         qboolean ext_texture_compression_s3tc;
74         qboolean ext_texture_edge_clamp;
75         qboolean ext_texture_filter_anisotropic;
76         qboolean ext_texture_srgb;
77         qboolean arb_multisample;
78 }
79 viddef_support_t;
80
81 typedef struct viddef_mode_s
82 {
83         int width;
84         int height;
85         int bitsperpixel;
86         qboolean fullscreen;
87         float refreshrate;
88         qboolean userefreshrate;
89         qboolean stereobuffer;
90         int samples;
91 }
92 viddef_mode_t;
93
94 typedef struct viddef_s
95 {
96         // these are set by VID_Mode
97         viddef_mode_t mode;
98         // used in many locations in the renderer
99         int width;
100         int height;
101         int bitsperpixel;
102         qboolean fullscreen;
103         float refreshrate;
104         qboolean userefreshrate;
105         qboolean stereobuffer;
106         int samples;
107         qboolean stencil;
108         qboolean sRGB2D; // whether 2D rendering is sRGB corrected (based on sRGBcapable2D)
109         qboolean sRGB3D; // whether 3D rendering is sRGB corrected (based on sRGBcapable3D)
110         qboolean sRGBcapable2D; // whether 2D rendering can be sRGB corrected (renderpath, v_hwgamma)
111         qboolean sRGBcapable3D; // whether 3D rendering can be sRGB corrected (renderpath, v_hwgamma)
112
113         renderpath_t renderpath;
114         qboolean forcevbo; // some renderpaths can not operate without it
115         qboolean useinterleavedarrays; // required by some renderpaths
116         qboolean allowalphatocoverage; // indicates the GL_AlphaToCoverage function works on this renderpath and framebuffer
117
118         unsigned int texunits;
119         unsigned int teximageunits;
120         unsigned int texarrayunits;
121         unsigned int drawrangeelements_maxvertices;
122         unsigned int drawrangeelements_maxindices;
123
124         unsigned int maxtexturesize_2d;
125         unsigned int maxtexturesize_3d;
126         unsigned int maxtexturesize_cubemap;
127         unsigned int max_anisotropy;
128         unsigned int maxdrawbuffers;
129
130         viddef_support_t support;
131
132         // in RENDERPATH_SOFT this is a 32bpp native-endian ARGB framebuffer
133         // (native-endian ARGB meaning that in little endian it is BGRA bytes,
134         //  in big endian it is ARGB byte order, the format is converted during
135         //  blit to the window)
136         unsigned int *softpixels;
137         unsigned int *softdepthpixels;
138
139         int forcetextype; // always use GL_BGRA for D3D, always use GL_RGBA for GLES, etc
140 } viddef_t;
141
142 // global video state
143 extern viddef_t vid;
144 extern void (*vid_menudrawfn)(void);
145 extern void (*vid_menukeyfn)(int key);
146
147 #define MAXJOYAXIS 16
148 // if this is changed, the corresponding code in vid_shared.c must be updated
149 #define MAXJOYBUTTON 36
150 typedef struct vid_joystate_s
151 {
152         float axis[MAXJOYAXIS]; // -1 to +1
153         unsigned char button[MAXJOYBUTTON]; // 0 or 1
154         qboolean is360; // indicates this joystick is a Microsoft Xbox 360 Controller For Windows
155 }
156 vid_joystate_t;
157
158 extern vid_joystate_t vid_joystate;
159
160 extern cvar_t joy_index;
161 extern cvar_t joy_enable;
162 extern cvar_t joy_detected;
163 extern cvar_t joy_active;
164
165 float VID_JoyState_GetAxis(const vid_joystate_t *joystate, int axis, float sensitivity, float deadzone);
166 void VID_ApplyJoyState(vid_joystate_t *joystate);
167 void VID_BuildJoyState(vid_joystate_t *joystate);
168 void VID_Shared_BuildJoyState_Begin(vid_joystate_t *joystate);
169 void VID_Shared_BuildJoyState_Finish(vid_joystate_t *joystate);
170 int VID_Shared_SetJoystick(int index);
171 qboolean VID_JoyBlockEmulatedKeys(int keycode);
172 void VID_EnableJoystick(qboolean enable);
173
174 extern qboolean vid_hidden;
175 extern qboolean vid_activewindow;
176 extern cvar_t vid_hardwaregammasupported;
177 extern qboolean vid_usinghwgamma;
178 extern qboolean vid_supportrefreshrate;
179
180 extern cvar_t vid_soft;
181 extern cvar_t vid_soft_threads;
182 extern cvar_t vid_soft_interlace;
183
184 extern cvar_t vid_fullscreen;
185 extern cvar_t vid_width;
186 extern cvar_t vid_height;
187 extern cvar_t vid_bitsperpixel;
188 extern cvar_t vid_samples;
189 extern cvar_t vid_refreshrate;
190 extern cvar_t vid_userefreshrate;
191 extern cvar_t vid_touchscreen_density;
192 extern cvar_t vid_touchscreen_xdpi;
193 extern cvar_t vid_touchscreen_ydpi;
194 extern cvar_t vid_vsync;
195 extern cvar_t vid_mouse;
196 extern cvar_t vid_grabkeyboard;
197 extern cvar_t vid_touchscreen;
198 extern cvar_t vid_touchscreen_showkeyboard;
199 extern cvar_t vid_touchscreen_supportshowkeyboard;
200 extern cvar_t vid_stick_mouse;
201 extern cvar_t vid_resizable;
202 extern cvar_t vid_desktopfullscreen;
203 extern cvar_t vid_minwidth;
204 extern cvar_t vid_minheight;
205 extern cvar_t vid_sRGB;
206 extern cvar_t vid_sRGB_fallback;
207
208 extern cvar_t gl_finish;
209
210 extern cvar_t v_gamma;
211 extern cvar_t v_contrast;
212 extern cvar_t v_brightness;
213 extern cvar_t v_color_enable;
214 extern cvar_t v_color_black_r;
215 extern cvar_t v_color_black_g;
216 extern cvar_t v_color_black_b;
217 extern cvar_t v_color_grey_r;
218 extern cvar_t v_color_grey_g;
219 extern cvar_t v_color_grey_b;
220 extern cvar_t v_color_white_r;
221 extern cvar_t v_color_white_g;
222 extern cvar_t v_color_white_b;
223 extern cvar_t v_hwgamma;
224
225 // brand of graphics chip
226 extern const char *gl_vendor;
227 // graphics chip model and other information
228 extern const char *gl_renderer;
229 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
230 extern const char *gl_version;
231 // extensions list, space separated
232 extern const char *gl_extensions;
233 // WGL, GLX, or AGL
234 extern const char *gl_platform;
235 // another extensions list, containing platform-specific extensions that are
236 // not in the main list
237 extern const char *gl_platformextensions;
238 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
239 extern char gl_driver[256];
240
241 void *GL_GetProcAddress(const char *name);
242 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
243
244 void VID_Shared_Init(void);
245
246 void GL_Init (void);
247
248 void VID_ClearExtensions(void);
249 void VID_CheckExtensions(void);
250
251 void VID_Init (void);
252 // Called at startup
253
254 void VID_Shutdown (void);
255 // Called at shutdown
256
257 int VID_SetMode (int modenum);
258 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
259 // base mode) on memory allocation failures
260
261 qboolean VID_InitMode(viddef_mode_t *mode);
262 // allocates and opens an appropriate OpenGL context (and its window)
263
264
265 // sets hardware gamma correction, returns false if the device does not
266 // support gamma control
267 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
268 int VID_SetGamma(unsigned short *ramps, int rampsize);
269 // gets hardware gamma correction, returns false if the device does not
270 // support gamma control
271 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
272 int VID_GetGamma(unsigned short *ramps, int rampsize);
273 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
274 // (ONLY to be called from VID_Finish!)
275 void VID_UpdateGamma(qboolean force, int rampsize);
276 // turns off hardware gamma ramps immediately
277 // (called from various shutdown/deactivation functions)
278 void VID_RestoreSystemGamma(void);
279
280 qboolean VID_HasScreenKeyboardSupport(void);
281 void VID_ShowKeyboard(qboolean show);
282 qboolean VID_ShowingKeyboard(void);
283
284 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
285 void VID_Finish (void);
286
287 void VID_Restart_f(void);
288
289 void VID_Start(void);
290 void VID_Stop(void);
291
292 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
293 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
294 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
295
296 typedef struct
297 {
298         int width, height, bpp, refreshrate;
299         int pixelheight_num, pixelheight_denom;
300 }
301 vid_mode_t;
302 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
303 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
304 void VID_Soft_SharedSetup(void);
305
306 #endif
307