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