added DPSOFTRAST software rasterizer, a work in progress
[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 }
42 renderpath_t;
43
44 typedef struct viddef_support_s
45 {
46         qboolean amd_texture_texture4;
47         qboolean arb_depth_texture;
48         qboolean arb_draw_buffers;
49         qboolean arb_fragment_shader;
50         qboolean arb_multitexture;
51         qboolean arb_occlusion_query;
52         qboolean arb_shader_objects;
53         qboolean arb_shading_language_100;
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 arb_vertex_shader;
62         qboolean ati_separate_stencil;
63         qboolean ext_blend_minmax;
64         qboolean ext_blend_subtract;
65         qboolean ext_draw_range_elements;
66         qboolean ext_framebuffer_object;
67         qboolean ext_stencil_two_side;
68         qboolean ext_texture_3d;
69         qboolean ext_texture_compression_s3tc;
70         qboolean ext_texture_edge_clamp;
71         qboolean ext_texture_filter_anisotropic;
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         void *cgcontext;
104
105         renderpath_t renderpath;
106         qboolean forcevbo; // some renderpaths can not operate without it
107         qboolean useinterleavedarrays; // required by some renderpaths
108
109         unsigned int texunits;
110         unsigned int teximageunits;
111         unsigned int texarrayunits;
112         unsigned int drawrangeelements_maxvertices;
113         unsigned int drawrangeelements_maxindices;
114
115         unsigned int maxtexturesize_2d;
116         unsigned int maxtexturesize_3d;
117         unsigned int maxtexturesize_cubemap;
118         unsigned int max_anisotropy;
119         unsigned int maxdrawbuffers;
120
121         viddef_support_t support;
122
123         // in RENDERPATH_SOFT this is a 32bpp native-endian ARGB framebuffer
124         // (native-endian ARGB meaning that in little endian it is BGRA bytes,
125         //  in big endian it is ARGB byte order, the format is converted during
126         //  blit to the window)
127         unsigned int *softpixels;
128         unsigned int *softdepthpixels;
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_fullscreen;
143 extern cvar_t vid_width;
144 extern cvar_t vid_height;
145 extern cvar_t vid_bitsperpixel;
146 extern cvar_t vid_samples;
147 extern cvar_t vid_refreshrate;
148 extern cvar_t vid_userefreshrate;
149 extern cvar_t vid_vsync;
150 extern cvar_t vid_mouse;
151 extern cvar_t vid_grabkeyboard;
152 extern cvar_t vid_stick_mouse;
153 extern cvar_t vid_resizable;
154 extern cvar_t vid_minwidth;
155 extern cvar_t vid_minheight;
156
157 extern cvar_t gl_finish;
158
159 extern cvar_t v_gamma;
160 extern cvar_t v_contrast;
161 extern cvar_t v_brightness;
162 extern cvar_t v_color_enable;
163 extern cvar_t v_color_black_r;
164 extern cvar_t v_color_black_g;
165 extern cvar_t v_color_black_b;
166 extern cvar_t v_color_grey_r;
167 extern cvar_t v_color_grey_g;
168 extern cvar_t v_color_grey_b;
169 extern cvar_t v_color_white_r;
170 extern cvar_t v_color_white_g;
171 extern cvar_t v_color_white_b;
172 extern cvar_t v_hwgamma;
173
174 // brand of graphics chip
175 extern const char *gl_vendor;
176 // graphics chip model and other information
177 extern const char *gl_renderer;
178 // begins with 1.0.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.3.1, or 1.4.0
179 extern const char *gl_version;
180 // extensions list, space separated
181 extern const char *gl_extensions;
182 // WGL, GLX, or AGL
183 extern const char *gl_platform;
184 // another extensions list, containing platform-specific extensions that are
185 // not in the main list
186 extern const char *gl_platformextensions;
187 // name of driver library (opengl32.dll, libGL.so.1, or whatever)
188 extern char gl_driver[256];
189
190 // compatibility hacks
191 extern qboolean isG200;
192 extern qboolean isRagePro;
193
194 void *GL_GetProcAddress(const char *name);
195 qboolean GL_CheckExtension(const char *minglver_or_ext, const dllfunction_t *funcs, const char *disableparm, int silent);
196
197 void VID_Shared_Init(void);
198
199 void GL_Init (void);
200
201 void VID_ClearExtensions(void);
202 void VID_CheckExtensions(void);
203
204 void VID_Init (void);
205 // Called at startup
206
207 void VID_Shutdown (void);
208 // Called at shutdown
209
210 int VID_SetMode (int modenum);
211 // sets the mode; only used by the Quake engine for resetting to mode 0 (the
212 // base mode) on memory allocation failures
213
214 qboolean VID_InitMode(viddef_mode_t *mode);
215 // allocates and opens an appropriate OpenGL context (and its window)
216
217
218 // sets hardware gamma correction, returns false if the device does not
219 // support gamma control
220 // (ONLY called by VID_UpdateGamma and VID_RestoreSystemGamma)
221 int VID_SetGamma(unsigned short *ramps, int rampsize);
222 // gets 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_GetGamma(unsigned short *ramps, int rampsize);
226 // makes sure ramp arrays are big enough and calls VID_GetGamma/VID_SetGamma
227 // (ONLY to be called from VID_Finish!)
228 void VID_UpdateGamma(qboolean force, int rampsize);
229 // turns off hardware gamma ramps immediately
230 // (called from various shutdown/deactivation functions)
231 void VID_RestoreSystemGamma(void);
232
233 void VID_SetMouse (qboolean fullscreengrab, qboolean relative, qboolean hidecursor);
234 void VID_Finish (void);
235
236 void VID_Restart_f(void);
237
238 void VID_Start(void);
239
240 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
241 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
242 void VID_BuildGammaTables(unsigned short *ramps, int rampsize); // builds the current gamma tables into an array (needs 3*rampsize items)
243
244 typedef struct
245 {
246         int width, height, bpp, refreshrate;
247         int pixelheight_num, pixelheight_denom;
248 }
249 vid_mode_t;
250 size_t VID_ListModes(vid_mode_t *modes, size_t maxcount);
251 size_t VID_SortModes(vid_mode_t *modes, size_t count, qboolean usebpp, qboolean userefreshrate, qboolean useaspect);
252 #endif
253