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 16
  30
  31 typedef enum renderpath_e
  32 {
  33         RENDERPATH_GL11,
  34         RENDERPATH_GL13,
  35         RENDERPATH_GL20,
  36         RENDERPATH_D3D9,
  37         RENDERPATH_D3D10,
  38         RENDERPATH_D3D11,
  39         RENDERPATH_SOFT,
  40         RENDERPATH_GLES1,
  41         RENDERPATH_GLES2
  42 }
  43 renderpath_t;
  44
  45 typedef struct viddef_support_s
  46 {
  47         qboolean gl20shaders;
  48         qboolean gl20shaders130;
  49         qboolean amd_texture_texture4;
  50         qboolean arb_depth_texture;
  51         qboolean arb_draw_buffers;
  52         qboolean arb_multitexture;
  53         qboolean arb_occlusion_query;
  54         qboolean arb_shadow;
  55         qboolean arb_texture_compression;
  56         qboolean arb_texture_cube_map;
  57         qboolean arb_texture_env_combine;
  58         qboolean arb_texture_gather;
  59         qboolean arb_texture_non_power_of_two;
  60         qboolean arb_vertex_buffer_object;
  61         qboolean ati_separate_stencil;
  62         qboolean ext_blend_minmax;
  63         qboolean ext_blend_subtract;
  64         qboolean ext_draw_range_elements;
  65         qboolean ext_framebuffer_object;
  66         qboolean ext_stencil_two_side;
  67         qboolean ext_texture_3d;
  68         qboolean ext_texture_compression_s3tc;
  69         qboolean ext_texture_edge_clamp;
  70         qboolean ext_texture_filter_anisotropic;
  71         qboolean ext_texture_srgb;
  72 }
  73 viddef_support_t;
  74
  75 typedef struct viddef_mode_s
  76 {
  77         int width;
  78         int height;
  79         int bitsperpixel;
  80         qboolean fullscreen;
  81         float refreshrate;
  82         qboolean userefreshrate;
  83         qboolean stereobuffer;
  84         int samples;
  85 }
  86 viddef_mode_t;
  87
  88 typedef struct viddef_s
  89 {
  90         // these are set by VID_Mode
  91         viddef_mode_t mode;
  92         // used in many locations in the renderer
  93         int width;
  94         int height;
  95         int bitsperpixel;
  96         qboolean fullscreen;
  97         float refreshrate;
  98         qboolean userefreshrate;
  99         qboolean stereobuffer;
 100         int samples;
 101         qboolean stencil;
 102
 103         renderpath_t renderpath;
 104         qboolean forcevbo; // some renderpaths can not operate without it
 105         qboolean useinterleavedarrays; // required by some renderpaths
 106
 107         unsigned int texunits;
 108         unsigned int teximageunits;
 109         unsigned int texarrayunits;
 110         unsigned int drawrangeelements_maxvertices;
 111         unsigned int drawrangeelements_maxindices;
 112
 113         unsigned int maxtexturesize_2d;
 114         unsigned int maxtexturesize_3d;
 115         unsigned int maxtexturesize_cubemap;
 116         unsigned int max_anisotropy;
 117         unsigned int maxdrawbuffers;
 118
 119         viddef_support_t support;
 120
 121         // in RENDERPATH_SOFT this is a 32bpp native-endian ARGB framebuffer
 122         // (native-endian ARGB meaning that in little endian it is BGRA bytes,
 123         //  in big endian it is ARGB byte order, the format is converted during
 124         //  blit to the window)
 125         unsigned int *softpixels;
 126         unsigned int *softdepthpixels;
 127
 128         int forcetextype; // always use GL_BGRA for D3D, always use GL_RGBA for GLES, etc
 129 } viddef_t;
 130
 131 // global video state
 132 extern viddef_t vid;
 133 extern void (*vid_menudrawfn)(void);
 134 extern void (*vid_menukeyfn)(int key);
 135
 136 extern qboolean vid_hidden;
 137 extern qboolean vid_activewindow;
 138 extern cvar_t vid_hardwaregammasupported;
 139 extern qboolean vid_usinghwgamma;
 140 extern qboolean vid_supportrefreshrate;
 141
 142 extern cvar_t vid_soft;
 143 extern cvar_t vid_soft_threads;
 144 extern cvar_t vid_soft_interlace;
 145
 146 extern cvar_t vid_fullscreen;
 147 extern cvar_t vid_width;
 148 extern cvar_t vid_height;
 149 extern cvar_t vid_bitsperpixel;
 150 extern cvar_t vid_samples;
 151 extern cvar_t vid_refreshrate;
 152 extern cvar_t vid_userefreshrate;
 153 extern cvar_t vid_vsync;
 154 extern cvar_t vid_mouse;
 155 extern cvar_t vid_grabkeyboard;
 156 extern cvar_t vid_touchscreen;
 157 extern cvar_t vid_stick_mouse;
 158 extern cvar_t vid_resizable;
 159 extern cvar_t vid_minwidth;
 160 extern cvar_t vid_minheight;
 161
 162 extern cvar_t gl_finish;
 163
 164 extern cvar_t v_gamma;
 165 extern cvar_t v_contrast;
 166 extern cvar_t v_brightness;
 167 extern cvar_t v_color_enable;
 168 extern cvar_t v_color_black_r;
 169 extern cvar_t v_color_black_g;
 170 extern cvar_t v_color_black_b;
 171 extern cvar_t v_color_grey_r;
 172 extern cvar_t v_color_grey_g;
 173 extern cvar_t v_color_grey_b;
 174 extern cvar_t v_color_white_r;
 175 extern cvar_t v_color_white_g;
 176 extern cvar_t v_color_white_b;
 177 extern cvar_t v_hwgamma;
 178
 179 // brand of graphics chip
 180 extern const char *gl_vendor;
 181 // graphics chip model and other information
 182 extern const char *gl_renderer;
 183 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
 184 extern const char *gl_version;
 185 // extensions list, space separated
 186 extern const char *gl_extensions;
 187 // WGL, GLX, or AGL
 188 extern const char *gl_platform;
 189 // another extensions list, containing platform-specific extensions that are
 190 // not in the main list
 191 extern const char *gl_platformextensions;
 192 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
 193 extern char gl_driver[256];
 194
 195 // compatibility hacks
 196 extern qboolean isG200;
 197 extern qboolean isRagePro;
 198
 199 void *GL_GetProcAddress(const char *name);
 200 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
 201
 202 void VID_Shared_Init(void);
 203
 204 void GL_Init (void);
 205
 206 void VID_ClearExtensions(void);
 207 void VID_CheckExtensions(void);
 208
 209 void VID_Init (void);
 210 // Called at startup
 211
 212 void VID_Shutdown (void);
 213 // Called at shutdown
 214
 215 int VID_SetMode (int modenum);
 216 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
 217 // base mode) on memory allocation failures
 218
 219 qboolean VID_InitMode(viddef_mode_t *mode);
 220 // allocates and opens an appropriate OpenGL context (and its window)
 221
 222
 223 // sets hardware gamma correction, returns false if the device does not
 224 // support gamma control
 225 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
 226 int VID_SetGamma(unsigned short *ramps, int rampsize);
 227 // gets hardware gamma correction, returns false if the device does not
 228 // support gamma control
 229 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
 230 int VID_GetGamma(unsigned short *ramps, int rampsize);
 231 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
 232 // (ONLY to be called from VID_Finish!)
 233 void VID_UpdateGamma(qboolean force, int rampsize);
 234 // turns off hardware gamma ramps immediately
 235 // (called from various shutdown/deactivation functions)
 236 void VID_RestoreSystemGamma(void);
 237
 238 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
 239 void VID_Finish (void);
 240
 241 void VID_Restart_f(void);
 242
 243 void VID_Start(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 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
 247 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
 248
 249 typedef struct
 250 {
 251         int width, height, bpp, refreshrate;
 252         int pixelheight_num, pixelheight_denom;
 253 }
 254 vid_mode_t;
 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 #endif
 259