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_GL20,
  34         RENDERPATH_GLES2
  35 }
  36 renderpath_t;
  37
  38 typedef struct viddef_support_s
  39 {
  40         qboolean gl20shaders;
  41         qboolean gl20shaders130; // indicates glBindFragDataLocation is available
  42         int glshaderversion; // typical values: 100 110 120 130 140 ...
  43         qboolean amd_texture_texture4;
  44         qboolean arb_depth_texture;
  45         qboolean arb_draw_buffers;
  46         qboolean arb_framebuffer_object;
  47         qboolean arb_multitexture;
  48         qboolean arb_occlusion_query;
  49         qboolean arb_query_buffer_object;
  50         qboolean arb_shadow;
  51         qboolean arb_texture_compression;
  52         qboolean arb_texture_cube_map;
  53         qboolean arb_texture_env_combine;
  54         qboolean arb_texture_gather;
  55         qboolean arb_texture_non_power_of_two;
  56         qboolean arb_vertex_buffer_object;
  57         qboolean arb_uniform_buffer_object;
  58         qboolean ext_blend_minmax;
  59         qboolean ext_blend_subtract;
  60         qboolean ext_blend_func_separate;
  61         qboolean ext_draw_range_elements;
  62         qboolean ext_framebuffer_object;
  63         qboolean ext_packed_depth_stencil;
  64         qboolean ext_texture_3d;
  65         qboolean ext_texture_compression_s3tc;
  66         qboolean ext_texture_edge_clamp;
  67         qboolean ext_texture_filter_anisotropic;
  68         qboolean ext_texture_srgb;
  69         qboolean arb_texture_float;
  70         qboolean arb_half_float_pixel;
  71         qboolean arb_half_float_vertex;
  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)
 106         qboolean sRGBcapable3D; // whether 3D rendering can be sRGB corrected (renderpath)
 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         int forcetextype; // always use GL_BGRA for D3D, always use GL_RGBA for GLES, etc
 128 } viddef_t;
 129
 130 // global video state
 131 extern viddef_t vid;
 132 extern void (*vid_menudrawfn)(void);
 133 extern void (*vid_menukeyfn)(int key);
 134
 135 #define MAXJOYAXIS 16
 136 // if this is changed, the corresponding code in vid_shared.c must be updated
 137 #define MAXJOYBUTTON 36
 138 typedef struct vid_joystate_s
 139 {
 140         float axis[MAXJOYAXIS]; // -1 to +1
 141         unsigned char button[MAXJOYBUTTON]; // 0 or 1
 142         qboolean is360; // indicates this joystick is a Microsoft Xbox 360 Controller For Windows
 143 }
 144 vid_joystate_t;
 145
 146 extern vid_joystate_t vid_joystate;
 147
 148 extern cvar_t joy_index;
 149 extern cvar_t joy_enable;
 150 extern cvar_t joy_detected;
 151 extern cvar_t joy_active;
 152
 153 float VID_JoyState_GetAxis(const vid_joystate_t *joystate, int axis, float sensitivity, float deadzone);
 154 void VID_ApplyJoyState(vid_joystate_t *joystate);
 155 void VID_BuildJoyState(vid_joystate_t *joystate);
 156 void VID_Shared_BuildJoyState_Begin(vid_joystate_t *joystate);
 157 void VID_Shared_BuildJoyState_Finish(vid_joystate_t *joystate);
 158 int VID_Shared_SetJoystick(int index);
 159 qboolean VID_JoyBlockEmulatedKeys(int keycode);
 160 void VID_EnableJoystick(qboolean enable);
 161
 162 extern qboolean vid_hidden;
 163 extern qboolean vid_activewindow;
 164 extern qboolean vid_supportrefreshrate;
 165
 166 extern cvar_t vid_fullscreen;
 167 extern cvar_t vid_width;
 168 extern cvar_t vid_height;
 169 extern cvar_t vid_bitsperpixel;
 170 extern cvar_t vid_samples;
 171 extern cvar_t vid_refreshrate;
 172 extern cvar_t vid_userefreshrate;
 173 extern cvar_t vid_touchscreen_density;
 174 extern cvar_t vid_touchscreen_xdpi;
 175 extern cvar_t vid_touchscreen_ydpi;
 176 extern cvar_t vid_vsync;
 177 extern cvar_t vid_mouse;
 178 extern cvar_t vid_grabkeyboard;
 179 extern cvar_t vid_touchscreen;
 180 extern cvar_t vid_touchscreen_showkeyboard;
 181 extern cvar_t vid_touchscreen_supportshowkeyboard;
 182 extern cvar_t vid_stick_mouse;
 183 extern cvar_t vid_resizable;
 184 extern cvar_t vid_desktopfullscreen;
 185 extern cvar_t vid_minwidth;
 186 extern cvar_t vid_minheight;
 187 extern cvar_t vid_sRGB;
 188 extern cvar_t vid_sRGB_fallback;
 189
 190 extern cvar_t gl_finish;
 191
 192 extern cvar_t v_gamma;
 193 extern cvar_t v_contrast;
 194 extern cvar_t v_brightness;
 195 extern cvar_t v_color_enable;
 196 extern cvar_t v_color_black_r;
 197 extern cvar_t v_color_black_g;
 198 extern cvar_t v_color_black_b;
 199 extern cvar_t v_color_grey_r;
 200 extern cvar_t v_color_grey_g;
 201 extern cvar_t v_color_grey_b;
 202 extern cvar_t v_color_white_r;
 203 extern cvar_t v_color_white_g;
 204 extern cvar_t v_color_white_b;
 205
 206 // brand of graphics chip
 207 extern const char *gl_vendor;
 208 // graphics chip model and other information
 209 extern const char *gl_renderer;
 210 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
 211 extern const char *gl_version;
 212 // extensions list, space separated
 213 extern const char *gl_extensions;
 214 // WGL, GLX, or AGL
 215 extern const char *gl_platform;
 216 // another extensions list, containing platform-specific extensions that are
 217 // not in the main list
 218 extern const char *gl_platformextensions;
 219 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
 220 extern char gl_driver[256];
 221
 222 void *GL_GetProcAddress(const char *name);
 223 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
 224
 225 void VID_Shared_Init(void);
 226
 227 void GL_Init (void);
 228
 229 void VID_ClearExtensions(void);
 230 void VID_CheckExtensions(void);
 231
 232 void VID_Init (void);
 233 // Called at startup
 234
 235 void VID_Shutdown (void);
 236 // Called at shutdown
 237
 238 int VID_SetMode (int modenum);
 239 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
 240 // base mode) on memory allocation failures
 241
 242 qboolean VID_InitMode(viddef_mode_t *mode);
 243 // allocates and opens an appropriate OpenGL context (and its window)
 244
 245
 246 // updates cachegamma variables and bumps vid_gammatables_serial if anything changed
 247 // (ONLY to be called from VID_Finish!)
 248 void VID_UpdateGamma(void);
 249
 250 qboolean VID_HasScreenKeyboardSupport(void);
 251 void VID_ShowKeyboard(qboolean show);
 252 qboolean VID_ShowingKeyboard(void);
 253
 254 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
 255 void VID_Finish (void);
 256
 257 void VID_Restart_f(void);
 258
 259 void VID_Start(void);
 260 void VID_Stop(void);
 261
 262 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
 263 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
 264 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
 265 void VID_ApplyGammaToColor(const float *rgb, float *out); // applies current gamma settings to a color (0-1 range)
 266
 267 typedef struct
 268 {
 269         int width, height, bpp, refreshrate;
 270         int pixelheight_num, pixelheight_denom;
 271 }
 272 vid_mode_t;
 273 vid_mode_t *VID_GetDesktopMode(void);
 274 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
 275 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
 276 void VID_Soft_SharedSetup(void);
 277
 278 #endif
 279