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