2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // vid.h -- video driver defs
25 #define ENGINE_ICON ( (gamemode == GAME_NEXUIZ) ? nexuiz_xpm : darkplaces_xpm )
27 extern int cl_available;
29 #define MAX_TEXTUREUNITS 16
31 typedef enum renderpath_e
45 typedef struct viddef_support_s
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_query_buffer_object;
58 qboolean arb_texture_compression;
59 qboolean arb_texture_cube_map;
60 qboolean arb_texture_env_combine;
61 qboolean arb_texture_gather;
62 qboolean arb_texture_non_power_of_two;
63 qboolean arb_vertex_buffer_object;
64 qboolean arb_uniform_buffer_object;
65 qboolean ati_separate_stencil;
66 qboolean ext_blend_minmax;
67 qboolean ext_blend_subtract;
68 qboolean ext_blend_func_separate;
69 qboolean ext_draw_range_elements;
70 qboolean ext_framebuffer_object;
71 qboolean ext_packed_depth_stencil;
72 qboolean ext_stencil_two_side;
73 qboolean ext_texture_3d;
74 qboolean ext_texture_compression_s3tc;
75 qboolean ext_texture_edge_clamp;
76 qboolean ext_texture_filter_anisotropic;
77 qboolean ext_texture_srgb;
78 qboolean arb_texture_float;
79 qboolean arb_half_float_pixel;
80 qboolean arb_half_float_vertex;
81 qboolean arb_multisample;
85 typedef struct viddef_mode_s
92 qboolean userefreshrate;
93 qboolean stereobuffer;
98 typedef struct viddef_s
100 // these are set by VID_Mode
102 // used in many locations in the renderer
108 qboolean userefreshrate;
109 qboolean stereobuffer;
112 qboolean sRGB2D; // whether 2D rendering is sRGB corrected (based on sRGBcapable2D)
113 qboolean sRGB3D; // whether 3D rendering is sRGB corrected (based on sRGBcapable3D)
114 qboolean sRGBcapable2D; // whether 2D rendering can be sRGB corrected (renderpath)
115 qboolean sRGBcapable3D; // whether 3D rendering can be sRGB corrected (renderpath)
117 renderpath_t renderpath;
118 qboolean forcevbo; // some renderpaths can not operate without it
119 qboolean useinterleavedarrays; // required by some renderpaths
120 qboolean allowalphatocoverage; // indicates the GL_AlphaToCoverage function works on this renderpath and framebuffer
122 unsigned int texunits;
123 unsigned int teximageunits;
124 unsigned int texarrayunits;
125 unsigned int drawrangeelements_maxvertices;
126 unsigned int drawrangeelements_maxindices;
128 unsigned int maxtexturesize_2d;
129 unsigned int maxtexturesize_3d;
130 unsigned int maxtexturesize_cubemap;
131 unsigned int max_anisotropy;
132 unsigned int maxdrawbuffers;
134 viddef_support_t support;
136 // in RENDERPATH_SOFT this is a 32bpp native-endian ARGB framebuffer
137 // (native-endian ARGB meaning that in little endian it is BGRA bytes,
138 // in big endian it is ARGB byte order, the format is converted during
139 // blit to the window)
140 unsigned int *softpixels;
141 unsigned int *softdepthpixels;
143 int forcetextype; // always use GL_BGRA for D3D, always use GL_RGBA for GLES, etc
146 // global video state
148 extern void (*vid_menudrawfn)(void);
149 extern void (*vid_menukeyfn)(int key);
151 #define MAXJOYAXIS 16
152 // if this is changed, the corresponding code in vid_shared.c must be updated
153 #define MAXJOYBUTTON 36
154 typedef struct vid_joystate_s
156 float axis[MAXJOYAXIS]; // -1 to +1
157 unsigned char button[MAXJOYBUTTON]; // 0 or 1
158 qboolean is360; // indicates this joystick is a Microsoft Xbox 360 Controller For Windows
162 extern vid_joystate_t vid_joystate;
164 extern cvar_t joy_index;
165 extern cvar_t joy_enable;
166 extern cvar_t joy_detected;
167 extern cvar_t joy_active;
169 float VID_JoyState_GetAxis(const vid_joystate_t *joystate, int axis, float sensitivity, float deadzone);
170 void VID_ApplyJoyState(vid_joystate_t *joystate);
171 void VID_BuildJoyState(vid_joystate_t *joystate);
172 void VID_Shared_BuildJoyState_Begin(vid_joystate_t *joystate);
173 void VID_Shared_BuildJoyState_Finish(vid_joystate_t *joystate);
174 int VID_Shared_SetJoystick(int index);
175 qboolean VID_JoyBlockEmulatedKeys(int keycode);
176 void VID_EnableJoystick(qboolean enable);
178 extern qboolean vid_hidden;
179 extern qboolean vid_activewindow;
180 extern qboolean vid_supportrefreshrate;
182 extern cvar_t vid_soft;
183 extern cvar_t vid_soft_threads;
184 extern cvar_t vid_soft_interlace;
186 extern cvar_t vid_fullscreen;
187 extern cvar_t vid_width;
188 extern cvar_t vid_height;
189 extern cvar_t vid_bitsperpixel;
190 extern cvar_t vid_samples;
191 extern cvar_t vid_refreshrate;
192 extern cvar_t vid_userefreshrate;
193 extern cvar_t vid_touchscreen_density;
194 extern cvar_t vid_touchscreen_xdpi;
195 extern cvar_t vid_touchscreen_ydpi;
196 extern cvar_t vid_vsync;
197 extern cvar_t vid_mouse;
198 extern cvar_t vid_grabkeyboard;
199 extern cvar_t vid_touchscreen;
200 extern cvar_t vid_touchscreen_showkeyboard;
201 extern cvar_t vid_touchscreen_supportshowkeyboard;
202 extern cvar_t vid_stick_mouse;
203 extern cvar_t vid_resizable;
204 extern cvar_t vid_desktopfullscreen;
205 extern cvar_t vid_minwidth;
206 extern cvar_t vid_minheight;
207 extern cvar_t vid_sRGB;
208 extern cvar_t vid_sRGB_fallback;
210 extern cvar_t gl_finish;
212 extern cvar_t v_gamma;
213 extern cvar_t v_contrast;
214 extern cvar_t v_brightness;
215 extern cvar_t v_color_enable;
216 extern cvar_t v_color_black_r;
217 extern cvar_t v_color_black_g;
218 extern cvar_t v_color_black_b;
219 extern cvar_t v_color_grey_r;
220 extern cvar_t v_color_grey_g;
221 extern cvar_t v_color_grey_b;
222 extern cvar_t v_color_white_r;
223 extern cvar_t v_color_white_g;
224 extern cvar_t v_color_white_b;
226 // brand of graphics chip
227 extern const char *gl_vendor;
228 // graphics chip model and other information
229 extern const char *gl_renderer;
230 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
231 extern const char *gl_version;
232 // extensions list, space separated
233 extern const char *gl_extensions;
235 extern const char *gl_platform;
236 // another extensions list, containing platform-specific extensions that are
237 // not in the main list
238 extern const char *gl_platformextensions;
239 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
240 extern char gl_driver[256];
242 void *GL_GetProcAddress(const char *name);
243 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
245 void VID_Shared_Init(void);
249 void VID_ClearExtensions(void);
250 void VID_CheckExtensions(void);
252 void VID_Init (void);
255 void VID_Shutdown (void);
256 // Called at shutdown
258 int VID_SetMode (int modenum);
259 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
260 // base mode) on memory allocation failures
262 qboolean VID_InitMode(viddef_mode_t *mode);
263 // allocates and opens an appropriate OpenGL context (and its window)
266 // updates cachegamma variables and bumps vid_gammatables_serial if anything changed
267 // (ONLY to be called from VID_Finish!)
268 void VID_UpdateGamma(void);
270 qboolean VID_HasScreenKeyboardSupport(void);
271 void VID_ShowKeyboard(qboolean show);
272 qboolean VID_ShowingKeyboard(void);
274 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
275 void VID_Finish (void);
277 void VID_Restart_f(void);
279 void VID_Start(void);
282 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
283 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
284 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
285 void VID_ApplyGammaToColor(const float *rgb, float *out); // applies current gamma settings to a color (0-1 range)
289 int width, height, bpp, refreshrate;
290 int pixelheight_num, pixelheight_denom;
293 vid_mode_t *VID_GetDesktopMode(void);
294 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
295 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
296 void VID_Soft_SharedSetup(void);