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