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