be more clear in the overflow message of OGG_FetchSound
[divverent/darkplaces.git] / 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_CGGL,
37         RENDERPATH_D3D9,
38         RENDERPATH_D3D10,
39         RENDERPATH_D3D11
40 }
41 renderpath_t;
42
43 typedef struct viddef_support_s
44 {
45         qboolean amd_texture_texture4;
46         qboolean arb_depth_texture;
47         qboolean arb_draw_buffers;
48         qboolean arb_fragment_shader;
49         qboolean arb_multitexture;
50         qboolean arb_occlusion_query;
51         qboolean arb_shader_objects;
52         qboolean arb_shading_language_100;
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 arb_vertex_shader;
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 }
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         void *cgcontext;
103
104         renderpath_t renderpath;
105         qboolean forcevbo; // some renderpaths can not operate without it
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 } viddef_t;
121
122 // global video state
123 extern viddef_t vid;
124 extern void (*vid_menudrawfn)(void);
125 extern void (*vid_menukeyfn)(int key);
126
127 extern qboolean vid_hidden;
128 extern qboolean vid_activewindow;
129 extern cvar_t vid_hardwaregammasupported;
130 extern qboolean vid_usinghwgamma;
131 extern qboolean vid_supportrefreshrate;
132
133 extern cvar_t vid_fullscreen;
134 extern cvar_t vid_width;
135 extern cvar_t vid_height;
136 extern cvar_t vid_bitsperpixel;
137 extern cvar_t vid_samples;
138 extern cvar_t vid_refreshrate;
139 extern cvar_t vid_userefreshrate;
140 extern cvar_t vid_vsync;
141 extern cvar_t vid_mouse;
142 extern cvar_t vid_grabkeyboard;
143 extern cvar_t vid_stick_mouse;
144 extern cvar_t vid_resizable;
145 extern cvar_t vid_minwidth;
146 extern cvar_t vid_minheight;
147
148 extern cvar_t gl_finish;
149
150 extern cvar_t v_gamma;
151 extern cvar_t v_contrast;
152 extern cvar_t v_brightness;
153 extern cvar_t v_color_enable;
154 extern cvar_t v_color_black_r;
155 extern cvar_t v_color_black_g;
156 extern cvar_t v_color_black_b;
157 extern cvar_t v_color_grey_r;
158 extern cvar_t v_color_grey_g;
159 extern cvar_t v_color_grey_b;
160 extern cvar_t v_color_white_r;
161 extern cvar_t v_color_white_g;
162 extern cvar_t v_color_white_b;
163 extern cvar_t v_hwgamma;
164
165 // brand of graphics chip
166 extern const char *gl_vendor;
167 // graphics chip model and other information
168 extern const char *gl_renderer;
169 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
170 extern const char *gl_version;
171 // extensions list, space separated
172 extern const char *gl_extensions;
173 // WGL, GLX, or AGL
174 extern const char *gl_platform;
175 // another extensions list, containing platform-specific extensions that are
176 // not in the main list
177 extern const char *gl_platformextensions;
178 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
179 extern char gl_driver[256];
180
181 // compatibility hacks
182 extern qboolean isG200;
183 extern qboolean isRagePro;
184
185 void *GL_GetProcAddress(const char *name);
186 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
187
188 void VID_Shared_Init(void);
189
190 void GL_Init (void);
191
192 void VID_ClearExtensions(void);
193 void VID_CheckExtensions(void);
194
195 void VID_Init (void);
196 // Called at startup
197
198 void VID_Shutdown (void);
199 // Called at shutdown
200
201 int VID_SetMode (int modenum);
202 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
203 // base mode) on memory allocation failures
204
205 qboolean VID_InitMode(viddef_mode_t *mode);
206 // allocates and opens an appropriate OpenGL context (and its window)
207
208
209 // sets hardware gamma correction, returns false if the device does not
210 // support gamma control
211 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
212 int VID_SetGamma(unsigned short *ramps, int rampsize);
213 // gets 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_GetGamma(unsigned short *ramps, int rampsize);
217 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
218 // (ONLY to be called from VID_Finish!)
219 void VID_UpdateGamma(qboolean force, int rampsize);
220 // turns off hardware gamma ramps immediately
221 // (called from various shutdown/deactivation functions)
222 void VID_RestoreSystemGamma(void);
223
224 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
225 void VID_Finish (void);
226
227 void VID_Restart_f(void);
228
229 void VID_Start(void);
230
231 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
232 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
233 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
234
235 typedef struct
236 {
237         int width, height, bpp, refreshrate;
238         int pixelheight_num, pixelheight_denom;
239 }
240 vid_mode_t;
241 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
242 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
243 #endif
244