added RENDERPATH_GLES2
[xonotic/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         RENDERPATH_SOFT,
41         RENDERPATH_GLES2
42 }
43 renderpath_t;
44
45 typedef struct viddef_support_s
46 {
47         qboolean gl20shaders;
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 }
71 viddef_support_t;
72
73 typedef struct viddef_mode_s
74 {
75         int width;
76         int height;
77         int bitsperpixel;
78         qboolean fullscreen;
79         float refreshrate;
80         qboolean userefreshrate;
81         qboolean stereobuffer;
82         int samples;
83 }
84 viddef_mode_t;
85
86 typedef struct viddef_s
87 {
88         // these are set by VID_Mode
89         viddef_mode_t mode;
90         // used in many locations in the renderer
91         int width;
92         int height;
93         int bitsperpixel;
94         qboolean fullscreen;
95         float refreshrate;
96         qboolean userefreshrate;
97         qboolean stereobuffer;
98         int samples;
99         qboolean stencil;
100
101         void *cgcontext;
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 } viddef_t;
128
129 // global video state
130 extern viddef_t vid;
131 extern void (*vid_menudrawfn)(void);
132 extern void (*vid_menukeyfn)(int key);
133
134 extern qboolean vid_hidden;
135 extern qboolean vid_activewindow;
136 extern cvar_t vid_hardwaregammasupported;
137 extern qboolean vid_usinghwgamma;
138 extern qboolean vid_supportrefreshrate;
139
140 extern cvar_t vid_fullscreen;
141 extern cvar_t vid_width;
142 extern cvar_t vid_height;
143 extern cvar_t vid_bitsperpixel;
144 extern cvar_t vid_samples;
145 extern cvar_t vid_refreshrate;
146 extern cvar_t vid_userefreshrate;
147 extern cvar_t vid_vsync;
148 extern cvar_t vid_mouse;
149 extern cvar_t vid_grabkeyboard;
150 extern cvar_t vid_stick_mouse;
151 extern cvar_t vid_resizable;
152 extern cvar_t vid_minwidth;
153 extern cvar_t vid_minheight;
154
155 extern cvar_t gl_finish;
156
157 extern cvar_t v_gamma;
158 extern cvar_t v_contrast;
159 extern cvar_t v_brightness;
160 extern cvar_t v_color_enable;
161 extern cvar_t v_color_black_r;
162 extern cvar_t v_color_black_g;
163 extern cvar_t v_color_black_b;
164 extern cvar_t v_color_grey_r;
165 extern cvar_t v_color_grey_g;
166 extern cvar_t v_color_grey_b;
167 extern cvar_t v_color_white_r;
168 extern cvar_t v_color_white_g;
169 extern cvar_t v_color_white_b;
170 extern cvar_t v_hwgamma;
171
172 // brand of graphics chip
173 extern const char *gl_vendor;
174 // graphics chip model and other information
175 extern const char *gl_renderer;
176 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
177 extern const char *gl_version;
178 // extensions list, space separated
179 extern const char *gl_extensions;
180 // WGL, GLX, or AGL
181 extern const char *gl_platform;
182 // another extensions list, containing platform-specific extensions that are
183 // not in the main list
184 extern const char *gl_platformextensions;
185 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
186 extern char gl_driver[256];
187
188 // compatibility hacks
189 extern qboolean isG200;
190 extern qboolean isRagePro;
191
192 void *GL_GetProcAddress(const char *name);
193 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
194
195 void VID_Shared_Init(void);
196
197 void GL_Init (void);
198
199 void VID_ClearExtensions(void);
200 void VID_CheckExtensions(void);
201
202 void VID_Init (void);
203 // Called at startup
204
205 void VID_Shutdown (void);
206 // Called at shutdown
207
208 int VID_SetMode (int modenum);
209 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
210 // base mode) on memory allocation failures
211
212 qboolean VID_InitMode(viddef_mode_t *mode);
213 // allocates and opens an appropriate OpenGL context (and its window)
214
215
216 // sets hardware gamma correction, returns false if the device does not
217 // support gamma control
218 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
219 int VID_SetGamma(unsigned short *ramps, int rampsize);
220 // gets hardware gamma correction, returns false if the device does not
221 // support gamma control
222 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
223 int VID_GetGamma(unsigned short *ramps, int rampsize);
224 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
225 // (ONLY to be called from VID_Finish!)
226 void VID_UpdateGamma(qboolean force, int rampsize);
227 // turns off hardware gamma ramps immediately
228 // (called from various shutdown/deactivation functions)
229 void VID_RestoreSystemGamma(void);
230
231 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
232 void VID_Finish (void);
233
234 void VID_Restart_f(void);
235
236 void VID_Start(void);
237
238 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
239 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
240 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
241
242 typedef struct
243 {
244         int width, height, bpp, refreshrate;
245         int pixelheight_num, pixelheight_denom;
246 }
247 vid_mode_t;
248 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
249 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
250 #endif
251