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