Add gl_debug cvar, if enabled the GL context will have GL_ARB_debug_output enabled...
[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 32
30
31 typedef enum renderpath_e
32 {
33         RENDERPATH_GL32,
34         RENDERPATH_GLES2
35 }
36 renderpath_t;
37
38 typedef struct viddef_support_s
39 {
40         qboolean gl20shaders130; // indicates glBindFragDataLocation is available
41         int glshaderversion; // typical values: 100 110 120 130 140 ...
42         qboolean amd_texture_texture4;
43         qboolean arb_draw_buffers;
44         qboolean arb_occlusion_query;
45         qboolean arb_query_buffer_object;
46         qboolean arb_texture_compression;
47         qboolean arb_texture_gather;
48         qboolean ext_blend_minmax;
49         qboolean ext_blend_subtract;
50         qboolean ext_blend_func_separate;
51         qboolean ext_packed_depth_stencil;
52         qboolean ext_texture_compression_s3tc;
53         qboolean ext_texture_filter_anisotropic;
54         qboolean ext_texture_srgb;
55         qboolean arb_texture_float;
56         qboolean arb_half_float_pixel;
57         qboolean arb_half_float_vertex;
58         qboolean arb_multisample;
59         qboolean arb_debug_output;
60 }
61 viddef_support_t;
62
63 typedef struct viddef_mode_s
64 {
65         int width;
66         int height;
67         int bitsperpixel;
68         qboolean fullscreen;
69         float refreshrate;
70         qboolean userefreshrate;
71         qboolean stereobuffer;
72         int samples;
73 }
74 viddef_mode_t;
75
76 typedef struct viddef_s
77 {
78         // these are set by VID_Mode
79         viddef_mode_t mode;
80         // used in many locations in the renderer
81         int width;
82         int height;
83         int bitsperpixel;
84         qboolean fullscreen;
85         float refreshrate;
86         qboolean userefreshrate;
87         qboolean stereobuffer;
88         int samples;
89         qboolean stencil;
90         qboolean sRGB2D; // whether 2D rendering is sRGB corrected (based on sRGBcapable2D)
91         qboolean sRGB3D; // whether 3D rendering is sRGB corrected (based on sRGBcapable3D)
92         qboolean sRGBcapable2D; // whether 2D rendering can be sRGB corrected (renderpath)
93         qboolean sRGBcapable3D; // whether 3D rendering can be sRGB corrected (renderpath)
94
95         renderpath_t renderpath;
96         qboolean allowalphatocoverage; // indicates the GL_AlphaToCoverage function works on this renderpath and framebuffer
97
98         unsigned int drawrangeelements_maxvertices;
99         unsigned int drawrangeelements_maxindices;
100
101         unsigned int maxtexturesize_2d;
102         unsigned int maxtexturesize_3d;
103         unsigned int maxtexturesize_cubemap;
104         unsigned int max_anisotropy;
105         unsigned int maxdrawbuffers;
106
107         viddef_support_t support;
108
109         int forcetextype; // always use GL_BGRA for D3D, always use GL_RGBA for GLES, etc
110 } viddef_t;
111
112 // global video state
113 extern viddef_t vid;
114 extern void (*vid_menudrawfn)(void);
115 extern void (*vid_menukeyfn)(int key);
116
117 #define MAXJOYAXIS 16
118 // if this is changed, the corresponding code in vid_shared.c must be updated
119 #define MAXJOYBUTTON 36
120 typedef struct vid_joystate_s
121 {
122         float axis[MAXJOYAXIS]; // -1 to +1
123         unsigned char button[MAXJOYBUTTON]; // 0 or 1
124         qboolean is360; // indicates this joystick is a Microsoft Xbox 360 Controller For Windows
125 }
126 vid_joystate_t;
127
128 extern vid_joystate_t vid_joystate;
129
130 extern cvar_t joy_index;
131 extern cvar_t joy_enable;
132 extern cvar_t joy_detected;
133 extern cvar_t joy_active;
134
135 float VID_JoyState_GetAxis(const vid_joystate_t *joystate, int axis, float sensitivity, float deadzone);
136 void VID_ApplyJoyState(vid_joystate_t *joystate);
137 void VID_BuildJoyState(vid_joystate_t *joystate);
138 void VID_Shared_BuildJoyState_Begin(vid_joystate_t *joystate);
139 void VID_Shared_BuildJoyState_Finish(vid_joystate_t *joystate);
140 int VID_Shared_SetJoystick(int index);
141 qboolean VID_JoyBlockEmulatedKeys(int keycode);
142 void VID_EnableJoystick(qboolean enable);
143
144 extern qboolean vid_hidden;
145 extern qboolean vid_activewindow;
146 extern qboolean vid_supportrefreshrate;
147
148 extern cvar_t vid_fullscreen;
149 extern cvar_t vid_width;
150 extern cvar_t vid_height;
151 extern cvar_t vid_bitsperpixel;
152 extern cvar_t vid_samples;
153 extern cvar_t vid_refreshrate;
154 extern cvar_t vid_userefreshrate;
155 extern cvar_t vid_touchscreen_density;
156 extern cvar_t vid_touchscreen_xdpi;
157 extern cvar_t vid_touchscreen_ydpi;
158 extern cvar_t vid_vsync;
159 extern cvar_t vid_mouse;
160 extern cvar_t vid_grabkeyboard;
161 extern cvar_t vid_touchscreen;
162 extern cvar_t vid_touchscreen_showkeyboard;
163 extern cvar_t vid_touchscreen_supportshowkeyboard;
164 extern cvar_t vid_stick_mouse;
165 extern cvar_t vid_resizable;
166 extern cvar_t vid_desktopfullscreen;
167 extern cvar_t vid_minwidth;
168 extern cvar_t vid_minheight;
169 extern cvar_t vid_sRGB;
170 extern cvar_t vid_sRGB_fallback;
171
172 extern cvar_t gl_finish;
173
174 extern cvar_t v_gamma;
175 extern cvar_t v_contrast;
176 extern cvar_t v_brightness;
177 extern cvar_t v_color_enable;
178 extern cvar_t v_color_black_r;
179 extern cvar_t v_color_black_g;
180 extern cvar_t v_color_black_b;
181 extern cvar_t v_color_grey_r;
182 extern cvar_t v_color_grey_g;
183 extern cvar_t v_color_grey_b;
184 extern cvar_t v_color_white_r;
185 extern cvar_t v_color_white_g;
186 extern cvar_t v_color_white_b;
187
188 // brand of graphics chip
189 extern const char *gl_vendor;
190 // graphics chip model and other information
191 extern const char *gl_renderer;
192 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
193 extern const char *gl_version;
194 // extensions list, space separated
195 extern const char *gl_extensions;
196 // WGL, GLX, or AGL
197 extern const char *gl_platform;
198 // another extensions list, containing platform-specific extensions that are
199 // not in the main list
200 extern const char *gl_platformextensions;
201 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
202 extern char gl_driver[256];
203
204 void *GL_GetProcAddress(const char *name);
205 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
206
207 void VID_Shared_Init(void);
208
209 void GL_Init (void);
210
211 void VID_ClearExtensions(void);
212 void VID_CheckExtensions(void);
213
214 void VID_Init (void);
215 // Called at startup
216
217 void VID_Shutdown (void);
218 // Called at shutdown
219
220 int VID_SetMode (int modenum);
221 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
222 // base mode) on memory allocation failures
223
224 qboolean VID_InitMode(viddef_mode_t *mode);
225 // allocates and opens an appropriate OpenGL context (and its window)
226
227
228 // updates cachegamma variables and bumps vid_gammatables_serial if anything changed
229 // (ONLY to be called from VID_Finish!)
230 void VID_UpdateGamma(void);
231
232 qboolean VID_HasScreenKeyboardSupport(void);
233 void VID_ShowKeyboard(qboolean show);
234 qboolean VID_ShowingKeyboard(void);
235
236 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
237 void VID_Finish (void);
238
239 void VID_Restart_f(void);
240
241 void VID_Start(void);
242 void VID_Stop(void);
243
244 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
245 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
246 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
247 void VID_ApplyGammaToColor(const float *rgb, float *out); // applies current gamma settings to a color (0-1 range)
248
249 typedef struct
250 {
251         int width, height, bpp, refreshrate;
252         int pixelheight_num, pixelheight_denom;
253 }
254 vid_mode_t;
255 vid_mode_t *VID_GetDesktopMode(void);
256 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
257 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
258 void VID_Soft_SharedSetup(void);
259
260 #endif
261