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