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