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