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