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