wined3d: Don't single-allocate new gl shaders.
[wine] / dlls / wined3d / wined3d_private.h
1 /*
2  * Direct3D wine internal private include file
3  *
4  * Copyright 2002-2003 The wine-d3d team
5  * Copyright 2002-2003 Raphael Junqueira
6  * Copyright 2004 Jason Edmeades
7  * Copyright 2005 Oliver Stieber
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23
24 #ifndef __WINE_WINED3D_PRIVATE_H
25 #define __WINE_WINED3D_PRIVATE_H
26
27 #include <stdarg.h>
28 #include <math.h>
29 #define NONAMELESSUNION
30 #define NONAMELESSSTRUCT
31 #define COBJMACROS
32 #include "windef.h"
33 #include "winbase.h"
34 #include "winreg.h"
35 #include "wingdi.h"
36 #include "winuser.h"
37 #include "wine/debug.h"
38 #include "wine/unicode.h"
39
40 #include "objbase.h"
41 #include "wined3d_private_types.h"
42 #include "wine/wined3d.h"
43 #include "wined3d_gl.h"
44 #include "wine/list.h"
45
46 /* Texture format fixups */
47
48 enum fixup_channel_source
49 {
50     CHANNEL_SOURCE_ZERO = 0,
51     CHANNEL_SOURCE_ONE = 1,
52     CHANNEL_SOURCE_X = 2,
53     CHANNEL_SOURCE_Y = 3,
54     CHANNEL_SOURCE_Z = 4,
55     CHANNEL_SOURCE_W = 5,
56     CHANNEL_SOURCE_YUV0 = 6,
57     CHANNEL_SOURCE_YUV1 = 7,
58 };
59
60 enum yuv_fixup
61 {
62     YUV_FIXUP_YUY2 = 0,
63     YUV_FIXUP_UYVY = 1,
64     YUV_FIXUP_YV12 = 2,
65 };
66
67 #include <pshpack2.h>
68 struct color_fixup_desc
69 {
70     unsigned x_sign_fixup : 1;
71     unsigned x_source : 3;
72     unsigned y_sign_fixup : 1;
73     unsigned y_source : 3;
74     unsigned z_sign_fixup : 1;
75     unsigned z_source : 3;
76     unsigned w_sign_fixup : 1;
77     unsigned w_source : 3;
78 };
79 #include <poppack.h>
80
81 static const struct color_fixup_desc COLOR_FIXUP_IDENTITY =
82         {0, CHANNEL_SOURCE_X, 0, CHANNEL_SOURCE_Y, 0, CHANNEL_SOURCE_Z, 0, CHANNEL_SOURCE_W};
83
84 static inline struct color_fixup_desc create_color_fixup_desc(
85         int sign0, enum fixup_channel_source src0, int sign1, enum fixup_channel_source src1,
86         int sign2, enum fixup_channel_source src2, int sign3, enum fixup_channel_source src3)
87 {
88     struct color_fixup_desc fixup =
89     {
90         sign0, src0,
91         sign1, src1,
92         sign2, src2,
93         sign3, src3,
94     };
95     return fixup;
96 }
97
98 static inline struct color_fixup_desc create_yuv_fixup_desc(enum yuv_fixup yuv_fixup)
99 {
100     struct color_fixup_desc fixup =
101     {
102         0, yuv_fixup & (1 << 0) ? CHANNEL_SOURCE_YUV1 : CHANNEL_SOURCE_YUV0,
103         0, yuv_fixup & (1 << 1) ? CHANNEL_SOURCE_YUV1 : CHANNEL_SOURCE_YUV0,
104         0, yuv_fixup & (1 << 2) ? CHANNEL_SOURCE_YUV1 : CHANNEL_SOURCE_YUV0,
105         0, yuv_fixup & (1 << 3) ? CHANNEL_SOURCE_YUV1 : CHANNEL_SOURCE_YUV0,
106     };
107     return fixup;
108 }
109
110 static inline BOOL is_identity_fixup(struct color_fixup_desc fixup)
111 {
112     return !memcmp(&fixup, &COLOR_FIXUP_IDENTITY, sizeof(fixup));
113 }
114
115 static inline BOOL is_yuv_fixup(struct color_fixup_desc fixup)
116 {
117     return fixup.x_source == CHANNEL_SOURCE_YUV0 || fixup.x_source == CHANNEL_SOURCE_YUV1;
118 }
119
120 static inline enum yuv_fixup get_yuv_fixup(struct color_fixup_desc fixup)
121 {
122     enum yuv_fixup yuv_fixup = 0;
123     if (fixup.x_source == CHANNEL_SOURCE_YUV1) yuv_fixup |= (1 << 0);
124     if (fixup.y_source == CHANNEL_SOURCE_YUV1) yuv_fixup |= (1 << 1);
125     if (fixup.z_source == CHANNEL_SOURCE_YUV1) yuv_fixup |= (1 << 2);
126     if (fixup.w_source == CHANNEL_SOURCE_YUV1) yuv_fixup |= (1 << 3);
127     return yuv_fixup;
128 }
129
130 /* Hash table functions */
131 typedef unsigned int (hash_function_t)(const void *key);
132 typedef BOOL (compare_function_t)(const void *keya, const void *keyb);
133
134 struct hash_table_entry_t {
135     void *key;
136     void *value;
137     unsigned int hash;
138     struct list entry;
139 };
140
141 struct hash_table_t {
142     hash_function_t *hash_function;
143     compare_function_t *compare_function;
144     struct list *buckets;
145     unsigned int bucket_count;
146     struct hash_table_entry_t *entries;
147     unsigned int entry_count;
148     struct list free_entries;
149     unsigned int count;
150     unsigned int grow_size;
151     unsigned int shrink_size;
152 };
153
154 struct hash_table_t *hash_table_create(hash_function_t *hash_function, compare_function_t *compare_function);
155 void hash_table_destroy(struct hash_table_t *table, void (*free_value)(void *value, void *cb), void *cb);
156 void hash_table_for_each_entry(struct hash_table_t *table, void (*callback)(void *value, void *context), void *context);
157 void *hash_table_get(const struct hash_table_t *table, const void *key);
158 void hash_table_put(struct hash_table_t *table, void *key, void *value);
159 void hash_table_remove(struct hash_table_t *table, void *key);
160
161 /* Device caps */
162 #define MAX_PALETTES            65536
163 #define MAX_STREAMS             16
164 #define MAX_TEXTURES            8
165 #define MAX_FRAGMENT_SAMPLERS   16
166 #define MAX_VERTEX_SAMPLERS     4
167 #define MAX_COMBINED_SAMPLERS   (MAX_FRAGMENT_SAMPLERS + MAX_VERTEX_SAMPLERS)
168 #define MAX_ACTIVE_LIGHTS       8
169 #define MAX_CLIPPLANES          WINED3DMAXUSERCLIPPLANES
170 #define MAX_LEVELS              256
171
172 #define MAX_CONST_I 16
173 #define MAX_CONST_B 16
174
175 /* Used for CreateStateBlock */
176 #define NUM_SAVEDPIXELSTATES_R     35
177 #define NUM_SAVEDPIXELSTATES_T     18
178 #define NUM_SAVEDPIXELSTATES_S     12
179 #define NUM_SAVEDVERTEXSTATES_R    34
180 #define NUM_SAVEDVERTEXSTATES_T    2
181 #define NUM_SAVEDVERTEXSTATES_S    1
182
183 extern const DWORD SavedPixelStates_R[NUM_SAVEDPIXELSTATES_R];
184 extern const DWORD SavedPixelStates_T[NUM_SAVEDPIXELSTATES_T];
185 extern const DWORD SavedPixelStates_S[NUM_SAVEDPIXELSTATES_S];
186 extern const DWORD SavedVertexStates_R[NUM_SAVEDVERTEXSTATES_R];
187 extern const DWORD SavedVertexStates_T[NUM_SAVEDVERTEXSTATES_T];
188 extern const DWORD SavedVertexStates_S[NUM_SAVEDVERTEXSTATES_S];
189
190 typedef enum _WINELOOKUP {
191     WINELOOKUP_WARPPARAM = 0,
192     MAX_LOOKUPS          = 1
193 } WINELOOKUP;
194
195 extern const int minLookup[MAX_LOOKUPS];
196 extern const int maxLookup[MAX_LOOKUPS];
197 extern DWORD *stateLookup[MAX_LOOKUPS];
198
199 struct min_lookup
200 {
201     GLenum mip[WINED3DTEXF_LINEAR + 1];
202 };
203
204 struct min_lookup minMipLookup[WINED3DTEXF_ANISOTROPIC + 1];
205 const struct min_lookup minMipLookup_noFilter[WINED3DTEXF_ANISOTROPIC + 1];
206 GLenum magLookup[WINED3DTEXF_ANISOTROPIC + 1];
207 const GLenum magLookup_noFilter[WINED3DTEXF_ANISOTROPIC + 1];
208
209 extern const struct filter_lookup filter_lookup_nofilter;
210 extern struct filter_lookup filter_lookup;
211
212 void init_type_lookup(WineD3D_GL_Info *gl_info);
213 #define WINED3D_ATR_TYPE(type)          GLINFO_LOCATION.glTypeLookup[type].d3dType
214 #define WINED3D_ATR_SIZE(type)          GLINFO_LOCATION.glTypeLookup[type].size
215 #define WINED3D_ATR_GLTYPE(type)        GLINFO_LOCATION.glTypeLookup[type].glType
216 #define WINED3D_ATR_FORMAT(type)        GLINFO_LOCATION.glTypeLookup[type].format
217 #define WINED3D_ATR_NORMALIZED(type)    GLINFO_LOCATION.glTypeLookup[type].normalized
218 #define WINED3D_ATR_TYPESIZE(type)      GLINFO_LOCATION.glTypeLookup[type].typesize
219
220 /* float_16_to_32() and float_32_to_16() (see implementation in
221  * surface_base.c) convert 16 bit floats in the FLOAT16 data type
222  * to standard C floats and vice versa. They do not depend on the encoding
223  * of the C float, so they are platform independent, but slow. On x86 and
224  * other IEEE 754 compliant platforms the conversion can be accelerated by
225  * bit shifting the exponent and mantissa. There are also some SSE-based
226  * assembly routines out there.
227  *
228  * See GL_NV_half_float for a reference of the FLOAT16 / GL_HALF format
229  */
230 static inline float float_16_to_32(const unsigned short *in) {
231     const unsigned short s = ((*in) & 0x8000);
232     const unsigned short e = ((*in) & 0x7C00) >> 10;
233     const unsigned short m = (*in) & 0x3FF;
234     const float sgn = (s ? -1.0 : 1.0);
235
236     if(e == 0) {
237         if(m == 0) return sgn * 0.0; /* +0.0 or -0.0 */
238         else return sgn * pow(2, -14.0) * ( (float) m / 1024.0);
239     } else if(e < 31) {
240         return sgn * pow(2, (float) e-15.0) * (1.0 + ((float) m / 1024.0));
241     } else {
242         if(m == 0) return sgn / 0.0; /* +INF / -INF */
243         else return 0.0 / 0.0; /* NAN */
244     }
245 }
246
247 /**
248  * Settings 
249  */
250 #define VS_NONE    0
251 #define VS_HW      1
252
253 #define PS_NONE    0
254 #define PS_HW      1
255
256 #define VBO_NONE   0
257 #define VBO_HW     1
258
259 #define NP2_NONE   0
260 #define NP2_REPACK 1
261 #define NP2_NATIVE 2
262
263 #define ORM_BACKBUFFER  0
264 #define ORM_PBUFFER     1
265 #define ORM_FBO         2
266
267 #define SHADER_ARB  1
268 #define SHADER_GLSL 2
269 #define SHADER_ATI  3
270 #define SHADER_NONE 4
271
272 #define RTL_DISABLE   -1
273 #define RTL_AUTO       0
274 #define RTL_READDRAW   1
275 #define RTL_READTEX    2
276 #define RTL_TEXDRAW    3
277 #define RTL_TEXTEX     4
278
279 #define PCI_VENDOR_NONE 0xffff /* e.g. 0x8086 for Intel and 0x10de for Nvidia */
280 #define PCI_DEVICE_NONE 0xffff /* e.g. 0x14f for a Geforce6200 */
281
282 /* NOTE: When adding fields to this structure, make sure to update the default
283  * values in wined3d_main.c as well. */
284 typedef struct wined3d_settings_s {
285 /* vertex and pixel shader modes */
286   int vs_mode;
287   int ps_mode;
288   int vbo_mode;
289 /* Ideally, we don't want the user to have to request GLSL.  If the hardware supports GLSL,
290     we should use it.  However, until it's fully implemented, we'll leave it as a registry
291     setting for developers. */
292   BOOL glslRequested;
293   int offscreen_rendering_mode;
294   int rendertargetlock_mode;
295   unsigned short pci_vendor_id;
296   unsigned short pci_device_id;
297 /* Memory tracking and object counting */
298   unsigned int emulated_textureram;
299   char *logo;
300   int allow_multisampling;
301 } wined3d_settings_t;
302
303 extern wined3d_settings_t wined3d_settings;
304
305 /* Shader backends */
306 struct SHADER_OPCODE_ARG;
307
308 #define SHADER_PGMSIZE 65535
309 typedef struct SHADER_BUFFER {
310     char* buffer;
311     unsigned int bsize;
312     unsigned int lineNo;
313     BOOL newline;
314 } SHADER_BUFFER;
315
316 enum WINED3D_SHADER_INSTRUCTION_HANDLER
317 {
318     WINED3DSIH_ABS,
319     WINED3DSIH_ADD,
320     WINED3DSIH_BEM,
321     WINED3DSIH_BREAK,
322     WINED3DSIH_BREAKC,
323     WINED3DSIH_BREAKP,
324     WINED3DSIH_CALL,
325     WINED3DSIH_CALLNZ,
326     WINED3DSIH_CMP,
327     WINED3DSIH_CND,
328     WINED3DSIH_CRS,
329     WINED3DSIH_DCL,
330     WINED3DSIH_DEF,
331     WINED3DSIH_DEFB,
332     WINED3DSIH_DEFI,
333     WINED3DSIH_DP2ADD,
334     WINED3DSIH_DP3,
335     WINED3DSIH_DP4,
336     WINED3DSIH_DST,
337     WINED3DSIH_DSX,
338     WINED3DSIH_DSY,
339     WINED3DSIH_ELSE,
340     WINED3DSIH_ENDIF,
341     WINED3DSIH_ENDLOOP,
342     WINED3DSIH_ENDREP,
343     WINED3DSIH_EXP,
344     WINED3DSIH_EXPP,
345     WINED3DSIH_FRC,
346     WINED3DSIH_IF,
347     WINED3DSIH_IFC,
348     WINED3DSIH_LABEL,
349     WINED3DSIH_LIT,
350     WINED3DSIH_LOG,
351     WINED3DSIH_LOGP,
352     WINED3DSIH_LOOP,
353     WINED3DSIH_LRP,
354     WINED3DSIH_M3x2,
355     WINED3DSIH_M3x3,
356     WINED3DSIH_M3x4,
357     WINED3DSIH_M4x3,
358     WINED3DSIH_M4x4,
359     WINED3DSIH_MAD,
360     WINED3DSIH_MAX,
361     WINED3DSIH_MIN,
362     WINED3DSIH_MOV,
363     WINED3DSIH_MOVA,
364     WINED3DSIH_MUL,
365     WINED3DSIH_NOP,
366     WINED3DSIH_NRM,
367     WINED3DSIH_PHASE,
368     WINED3DSIH_POW,
369     WINED3DSIH_RCP,
370     WINED3DSIH_REP,
371     WINED3DSIH_RET,
372     WINED3DSIH_RSQ,
373     WINED3DSIH_SETP,
374     WINED3DSIH_SGE,
375     WINED3DSIH_SGN,
376     WINED3DSIH_SINCOS,
377     WINED3DSIH_SLT,
378     WINED3DSIH_SUB,
379     WINED3DSIH_TEX,
380     WINED3DSIH_TEXBEM,
381     WINED3DSIH_TEXBEML,
382     WINED3DSIH_TEXCOORD,
383     WINED3DSIH_TEXDEPTH,
384     WINED3DSIH_TEXDP3,
385     WINED3DSIH_TEXDP3TEX,
386     WINED3DSIH_TEXKILL,
387     WINED3DSIH_TEXLDD,
388     WINED3DSIH_TEXLDL,
389     WINED3DSIH_TEXM3x2DEPTH,
390     WINED3DSIH_TEXM3x2PAD,
391     WINED3DSIH_TEXM3x2TEX,
392     WINED3DSIH_TEXM3x3,
393     WINED3DSIH_TEXM3x3DIFF,
394     WINED3DSIH_TEXM3x3PAD,
395     WINED3DSIH_TEXM3x3SPEC,
396     WINED3DSIH_TEXM3x3TEX,
397     WINED3DSIH_TEXM3x3VSPEC,
398     WINED3DSIH_TEXREG2AR,
399     WINED3DSIH_TEXREG2GB,
400     WINED3DSIH_TEXREG2RGB,
401     WINED3DSIH_TABLE_SIZE
402 };
403
404 typedef void (*SHADER_HANDLER)(const struct SHADER_OPCODE_ARG *);
405
406 struct shader_caps {
407     DWORD               VertexShaderVersion;
408     DWORD               MaxVertexShaderConst;
409
410     DWORD               PixelShaderVersion;
411     float               PixelShader1xMaxValue;
412
413     WINED3DVSHADERCAPS2_0   VS20Caps;
414     WINED3DPSHADERCAPS2_0   PS20Caps;
415
416     DWORD               MaxVShaderInstructionsExecuted;
417     DWORD               MaxPShaderInstructionsExecuted;
418     DWORD               MaxVertexShader30InstructionSlots;
419     DWORD               MaxPixelShader30InstructionSlots;
420 };
421
422 enum tex_types
423 {
424     tex_1d       = 0,
425     tex_2d       = 1,
426     tex_3d       = 2,
427     tex_cube     = 3,
428     tex_rect     = 4,
429     tex_type_count = 5,
430 };
431
432 enum vertexprocessing_mode {
433     fixedfunction,
434     vertexshader,
435     pretransformed
436 };
437
438 struct stb_const_desc {
439     char                    texunit;
440     UINT                    const_num;
441 };
442
443 enum fogmode {
444     FOG_OFF,
445     FOG_LINEAR,
446     FOG_EXP,
447     FOG_EXP2
448 };
449
450 /* Stateblock dependent parameters which have to be hardcoded
451  * into the shader code
452  */
453 struct ps_compile_args {
454     struct color_fixup_desc     color_fixup[MAX_FRAGMENT_SAMPLERS];
455     BOOL                        srgb_correction;
456     enum vertexprocessing_mode  vp_mode;
457     enum fogmode                fog;
458     /* Projected textures(ps 1.0-1.3) */
459     /* Texture types(2D, Cube, 3D) in ps 1.x */
460 };
461
462 typedef struct {
463     const SHADER_HANDLER *shader_instruction_handler_table;
464     void (*shader_select)(IWineD3DDevice *iface, BOOL usePS, BOOL useVS);
465     void (*shader_select_depth_blt)(IWineD3DDevice *iface, enum tex_types tex_type);
466     void (*shader_deselect_depth_blt)(IWineD3DDevice *iface);
467     void (*shader_update_float_vertex_constants)(IWineD3DDevice *iface, UINT start, UINT count);
468     void (*shader_update_float_pixel_constants)(IWineD3DDevice *iface, UINT start, UINT count);
469     void (*shader_load_constants)(IWineD3DDevice *iface, char usePS, char useVS);
470     void (*shader_color_correction)(const struct SHADER_OPCODE_ARG *arg, struct color_fixup_desc fixup);
471     void (*shader_destroy)(IWineD3DBaseShader *iface);
472     HRESULT (*shader_alloc_private)(IWineD3DDevice *iface);
473     void (*shader_free_private)(IWineD3DDevice *iface);
474     BOOL (*shader_dirtifyable_constants)(IWineD3DDevice *iface);
475     GLuint (*shader_generate_pshader)(IWineD3DPixelShader *iface, SHADER_BUFFER *buffer, const struct ps_compile_args *args);
476     void (*shader_generate_vshader)(IWineD3DVertexShader *iface, SHADER_BUFFER *buffer);
477     void (*shader_get_caps)(WINED3DDEVTYPE devtype, const WineD3D_GL_Info *gl_info, struct shader_caps *caps);
478     BOOL (*shader_color_fixup_supported)(struct color_fixup_desc fixup);
479 } shader_backend_t;
480
481 extern const shader_backend_t glsl_shader_backend;
482 extern const shader_backend_t arb_program_shader_backend;
483 extern const shader_backend_t none_shader_backend;
484
485 /* X11 locking */
486
487 extern void (* CDECL wine_tsx11_lock_ptr)(void);
488 extern void (* CDECL wine_tsx11_unlock_ptr)(void);
489
490 /* As GLX relies on X, this is needed */
491 extern int num_lock;
492
493 #if 0
494 #define ENTER_GL() ++num_lock; if (num_lock > 1) FIXME("Recursive use of GL lock to: %d\n", num_lock); wine_tsx11_lock_ptr()
495 #define LEAVE_GL() if (num_lock != 1) FIXME("Recursive use of GL lock: %d\n", num_lock); --num_lock; wine_tsx11_unlock_ptr()
496 #else
497 #define ENTER_GL() wine_tsx11_lock_ptr()
498 #define LEAVE_GL() wine_tsx11_unlock_ptr()
499 #endif
500
501 /*****************************************************************************
502  * Defines
503  */
504
505 /* GL related defines */
506 /* ------------------ */
507 #define GL_SUPPORT(ExtName)           (GLINFO_LOCATION.supported[ExtName] != 0)
508 #define GL_LIMITS(ExtName)            (GLINFO_LOCATION.max_##ExtName)
509 #define GL_EXTCALL(FuncName)          (GLINFO_LOCATION.FuncName)
510 #define GL_VEND(_VendName)            (GLINFO_LOCATION.gl_vendor == VENDOR_##_VendName ? TRUE : FALSE)
511
512 #define D3DCOLOR_B_R(dw) (((dw) >> 16) & 0xFF)
513 #define D3DCOLOR_B_G(dw) (((dw) >>  8) & 0xFF)
514 #define D3DCOLOR_B_B(dw) (((dw) >>  0) & 0xFF)
515 #define D3DCOLOR_B_A(dw) (((dw) >> 24) & 0xFF)
516
517 #define D3DCOLOR_R(dw) (((float) (((dw) >> 16) & 0xFF)) / 255.0f)
518 #define D3DCOLOR_G(dw) (((float) (((dw) >>  8) & 0xFF)) / 255.0f)
519 #define D3DCOLOR_B(dw) (((float) (((dw) >>  0) & 0xFF)) / 255.0f)
520 #define D3DCOLOR_A(dw) (((float) (((dw) >> 24) & 0xFF)) / 255.0f)
521
522 #define D3DCOLORTOGLFLOAT4(dw, vec) do { \
523   (vec)[0] = D3DCOLOR_R(dw); \
524   (vec)[1] = D3DCOLOR_G(dw); \
525   (vec)[2] = D3DCOLOR_B(dw); \
526   (vec)[3] = D3DCOLOR_A(dw); \
527 } while(0)
528
529 /* DirectX Device Limits */
530 /* --------------------- */
531 #define MAX_LEVELS  256  /* Maximum number of mipmap levels. Guessed at 256 */
532
533 #define MAX_STREAMS  16  /* Maximum possible streams - used for fixed size arrays
534                             See MaxStreams in MSDN under GetDeviceCaps */
535 #define HIGHEST_TRANSFORMSTATE WINED3DTS_WORLDMATRIX(255) /* Highest value in WINED3DTRANSFORMSTATETYPE */
536
537 /* Checking of API calls */
538 /* --------------------- */
539 #ifndef WINE_NO_DEBUG_MSGS
540 #define checkGLcall(A)                                          \
541 do {                                                            \
542     GLint err = glGetError();                                   \
543     if (err == GL_NO_ERROR) {                                   \
544        TRACE("%s call ok %s / %d\n", A, __FILE__, __LINE__);    \
545                                                                 \
546     } else do {                                                 \
547         FIXME(">>>>>>>>>>>>>>>>> %s (%#x) from %s @ %s / %d\n", \
548             debug_glerror(err), err, A, __FILE__, __LINE__);    \
549        err = glGetError();                                      \
550     } while (err != GL_NO_ERROR);                               \
551 } while(0)
552 #else
553 #define checkGLcall(A) do {} while(0)
554 #endif
555
556 /* Trace routines / diagnostics */
557 /* ---------------------------- */
558
559 /* Dump out a matrix and copy it */
560 #define conv_mat(mat,gl_mat)                                                                \
561 do {                                                                                        \
562     TRACE("%f %f %f %f\n", (mat)->u.s._11, (mat)->u.s._12, (mat)->u.s._13, (mat)->u.s._14); \
563     TRACE("%f %f %f %f\n", (mat)->u.s._21, (mat)->u.s._22, (mat)->u.s._23, (mat)->u.s._24); \
564     TRACE("%f %f %f %f\n", (mat)->u.s._31, (mat)->u.s._32, (mat)->u.s._33, (mat)->u.s._34); \
565     TRACE("%f %f %f %f\n", (mat)->u.s._41, (mat)->u.s._42, (mat)->u.s._43, (mat)->u.s._44); \
566     memcpy(gl_mat, (mat), 16 * sizeof(float));                                              \
567 } while (0)
568
569 /* Macro to dump out the current state of the light chain */
570 #define DUMP_LIGHT_CHAIN()                    \
571 do {                                          \
572   PLIGHTINFOEL *el = This->stateBlock->lights;\
573   while (el) {                                \
574     TRACE("Light %p (glIndex %ld, d3dIndex %ld, enabled %d)\n", el, el->glIndex, el->OriginalIndex, el->lightEnabled);\
575     el = el->next;                            \
576   }                                           \
577 } while(0)
578
579 /* Trace vector and strided data information */
580 #define TRACE_VECTOR(name) TRACE( #name "=(%f, %f, %f, %f)\n", name.x, name.y, name.z, name.w);
581 #define TRACE_STRIDED(sd,name) TRACE( #name "=(data:%p, stride:%d, type:%d, vbo %d, stream %u)\n", \
582         sd->u.s.name.lpData, sd->u.s.name.dwStride, sd->u.s.name.dwType, sd->u.s.name.VBO, sd->u.s.name.streamNo);
583
584 /* Defines used for optimizations */
585
586 /*    Only reapply what is necessary */
587 #define REAPPLY_ALPHAOP  0x0001
588 #define REAPPLY_ALL      0xFFFF
589
590 /* Advance declaration of structures to satisfy compiler */
591 typedef struct IWineD3DStateBlockImpl IWineD3DStateBlockImpl;
592 typedef struct IWineD3DSurfaceImpl    IWineD3DSurfaceImpl;
593 typedef struct IWineD3DPaletteImpl    IWineD3DPaletteImpl;
594 typedef struct IWineD3DDeviceImpl     IWineD3DDeviceImpl;
595
596 /* Global variables */
597 extern const float identity[16];
598
599 /*****************************************************************************
600  * Compilable extra diagnostics
601  */
602
603 /* Trace information per-vertex: (extremely high amount of trace) */
604 #if 0 /* NOTE: Must be 0 in cvs */
605 # define VTRACE(A) TRACE A
606 #else 
607 # define VTRACE(A) 
608 #endif
609
610 /* TODO: Confirm each of these works when wined3d move completed */
611 #if 0 /* NOTE: Must be 0 in cvs */
612   /* To avoid having to get gigabytes of trace, the following can be compiled in, and at the start
613      of each frame, a check is made for the existence of C:\D3DTRACE, and if it exists d3d trace
614      is enabled, and if it doesn't exist it is disabled. */
615 # define FRAME_DEBUGGING
616   /*  Adding in the SINGLE_FRAME_DEBUGGING gives a trace of just what makes up a single frame, before
617       the file is deleted                                                                            */
618 # if 1 /* NOTE: Must be 1 in cvs, as this is mostly more useful than a trace from program start */
619 #  define SINGLE_FRAME_DEBUGGING
620 # endif  
621   /* The following, when enabled, lets you see the makeup of the frame, by drawprimitive calls.
622      It can only be enabled when FRAME_DEBUGGING is also enabled                               
623      The contents of the back buffer are written into /tmp/backbuffer_* after each primitive 
624      array is drawn.                                                                            */
625 # if 0 /* NOTE: Must be 0 in cvs, as this give a lot of ppm files when compiled in */                                                                                       
626 #  define SHOW_FRAME_MAKEUP 1
627 # endif  
628   /* The following, when enabled, lets you see the makeup of the all the textures used during each
629      of the drawprimitive calls. It can only be enabled when SHOW_FRAME_MAKEUP is also enabled.
630      The contents of the textures assigned to each stage are written into 
631      /tmp/texture_*_<Stage>.ppm after each primitive array is drawn.                            */
632 # if 0 /* NOTE: Must be 0 in cvs, as this give a lot of ppm files when compiled in */
633 #  define SHOW_TEXTURE_MAKEUP 0
634 # endif  
635 extern BOOL isOn;
636 extern BOOL isDumpingFrames;
637 extern LONG primCounter;
638 #endif
639
640 /*****************************************************************************
641  * Prototypes
642  */
643
644 /* Routine common to the draw primitive and draw indexed primitive routines */
645 void drawPrimitive(IWineD3DDevice *iface, int PrimitiveType, long NumPrimitives,
646         UINT numberOfVertices, long start_idx, short idxBytes, const void *idxData, int minIndex);
647
648 void primitiveDeclarationConvertToStridedData(
649      IWineD3DDevice *iface,
650      BOOL useVertexShaderFunction,
651      WineDirect3DVertexStridedData *strided,
652      BOOL *fixup);
653
654 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
655
656 typedef void (WINE_GLAPI *glAttribFunc)(const void *data);
657 typedef void (WINE_GLAPI *glMultiTexCoordFunc)(GLenum unit, const void *data);
658 extern glAttribFunc position_funcs[WINED3DDECLTYPE_UNUSED];
659 extern glAttribFunc diffuse_funcs[WINED3DDECLTYPE_UNUSED];
660 extern glAttribFunc specular_funcs[WINED3DDECLTYPE_UNUSED];
661 extern glAttribFunc normal_funcs[WINED3DDECLTYPE_UNUSED];
662 extern glMultiTexCoordFunc multi_texcoord_funcs[WINED3DDECLTYPE_UNUSED];
663
664 #define eps 1e-8
665
666 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
667     (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
668
669 /* Routines and structures related to state management */
670 typedef struct WineD3DContext WineD3DContext;
671 typedef void (*APPLYSTATEFUNC)(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *ctx);
672
673 #define STATE_RENDER(a) (a)
674 #define STATE_IS_RENDER(a) ((a) >= STATE_RENDER(1) && (a) <= STATE_RENDER(WINEHIGHEST_RENDER_STATE))
675
676 #define STATE_TEXTURESTAGE(stage, num) (STATE_RENDER(WINEHIGHEST_RENDER_STATE) + 1 + (stage) * (WINED3D_HIGHEST_TEXTURE_STATE + 1) + (num))
677 #define STATE_IS_TEXTURESTAGE(a) ((a) >= STATE_TEXTURESTAGE(0, 1) && (a) <= STATE_TEXTURESTAGE(MAX_TEXTURES - 1, WINED3D_HIGHEST_TEXTURE_STATE))
678
679 /* + 1 because samplers start with 0 */
680 #define STATE_SAMPLER(num) (STATE_TEXTURESTAGE(MAX_TEXTURES - 1, WINED3D_HIGHEST_TEXTURE_STATE) + 1 + (num))
681 #define STATE_IS_SAMPLER(num) ((num) >= STATE_SAMPLER(0) && (num) <= STATE_SAMPLER(MAX_COMBINED_SAMPLERS - 1))
682
683 #define STATE_PIXELSHADER (STATE_SAMPLER(MAX_COMBINED_SAMPLERS - 1) + 1)
684 #define STATE_IS_PIXELSHADER(a) ((a) == STATE_PIXELSHADER)
685
686 #define STATE_TRANSFORM(a) (STATE_PIXELSHADER + (a))
687 #define STATE_IS_TRANSFORM(a) ((a) >= STATE_TRANSFORM(1) && (a) <= STATE_TRANSFORM(WINED3DTS_WORLDMATRIX(255)))
688
689 #define STATE_STREAMSRC (STATE_TRANSFORM(WINED3DTS_WORLDMATRIX(255)) + 1)
690 #define STATE_IS_STREAMSRC(a) ((a) == STATE_STREAMSRC)
691 #define STATE_INDEXBUFFER (STATE_STREAMSRC + 1)
692 #define STATE_IS_INDEXBUFFER(a) ((a) == STATE_INDEXBUFFER)
693
694 #define STATE_VDECL (STATE_INDEXBUFFER + 1)
695 #define STATE_IS_VDECL(a) ((a) == STATE_VDECL)
696
697 #define STATE_VSHADER (STATE_VDECL + 1)
698 #define STATE_IS_VSHADER(a) ((a) == STATE_VSHADER)
699
700 #define STATE_VIEWPORT (STATE_VSHADER + 1)
701 #define STATE_IS_VIEWPORT(a) ((a) == STATE_VIEWPORT)
702
703 #define STATE_VERTEXSHADERCONSTANT (STATE_VIEWPORT + 1)
704 #define STATE_PIXELSHADERCONSTANT (STATE_VERTEXSHADERCONSTANT + 1)
705 #define STATE_IS_VERTEXSHADERCONSTANT(a) ((a) == STATE_VERTEXSHADERCONSTANT)
706 #define STATE_IS_PIXELSHADERCONSTANT(a) ((a) == STATE_PIXELSHADERCONSTANT)
707
708 #define STATE_ACTIVELIGHT(a) (STATE_PIXELSHADERCONSTANT + (a) + 1)
709 #define STATE_IS_ACTIVELIGHT(a) ((a) >= STATE_ACTIVELIGHT(0) && (a) < STATE_ACTIVELIGHT(MAX_ACTIVE_LIGHTS))
710
711 #define STATE_SCISSORRECT (STATE_ACTIVELIGHT(MAX_ACTIVE_LIGHTS - 1) + 1)
712 #define STATE_IS_SCISSORRECT(a) ((a) == STATE_SCISSORRECT)
713
714 #define STATE_CLIPPLANE(a) (STATE_SCISSORRECT + 1 + (a))
715 #define STATE_IS_CLIPPLANE(a) ((a) >= STATE_CLIPPLANE(0) && (a) <= STATE_CLIPPLANE(MAX_CLIPPLANES - 1))
716
717 #define STATE_MATERIAL (STATE_CLIPPLANE(MAX_CLIPPLANES))
718
719 #define STATE_FRONTFACE (STATE_MATERIAL + 1)
720
721 #define STATE_HIGHEST (STATE_FRONTFACE)
722
723 struct StateEntry
724 {
725     DWORD               representative;
726     APPLYSTATEFUNC      apply;
727 };
728
729 struct StateEntryTemplate
730 {
731     DWORD               state;
732     struct StateEntry   content;
733     GL_SupportedExt     extension;
734 };
735
736 struct fragment_caps {
737     DWORD               PrimitiveMiscCaps;
738
739     DWORD               TextureOpCaps;
740     DWORD               MaxTextureBlendStages;
741     DWORD               MaxSimultaneousTextures;
742 };
743
744 struct fragment_pipeline {
745     void (*enable_extension)(IWineD3DDevice *iface, BOOL enable);
746     void (*get_caps)(WINED3DDEVTYPE devtype, const WineD3D_GL_Info *gl_info, struct fragment_caps *caps);
747     HRESULT (*alloc_private)(IWineD3DDevice *iface);
748     void (*free_private)(IWineD3DDevice *iface);
749     BOOL (*color_fixup_supported)(struct color_fixup_desc fixup);
750     const struct StateEntryTemplate *states;
751     BOOL ffp_proj_control;
752 };
753
754 extern const struct StateEntryTemplate misc_state_template[];
755 extern const struct StateEntryTemplate ffp_vertexstate_template[];
756 extern const struct fragment_pipeline ffp_fragment_pipeline;
757 extern const struct fragment_pipeline atifs_fragment_pipeline;
758 extern const struct fragment_pipeline arbfp_fragment_pipeline;
759 extern const struct fragment_pipeline nvts_fragment_pipeline;
760 extern const struct fragment_pipeline nvrc_fragment_pipeline;
761
762 /* "Base" state table */
763 HRESULT compile_state_table(struct StateEntry *StateTable, APPLYSTATEFUNC **dev_multistate_funcs,
764         const WineD3D_GL_Info *gl_info, const struct StateEntryTemplate *vertex,
765         const struct fragment_pipeline *fragment, const struct StateEntryTemplate *misc);
766
767 /* Shaders for color conversions in blits */
768 struct blit_shader {
769     HRESULT (*alloc_private)(IWineD3DDevice *iface);
770     void (*free_private)(IWineD3DDevice *iface);
771     HRESULT (*set_shader)(IWineD3DDevice *iface, WINED3DFORMAT fmt, GLenum textype, UINT width, UINT height);
772     void (*unset_shader)(IWineD3DDevice *iface);
773     BOOL (*color_fixup_supported)(struct color_fixup_desc fixup);
774 };
775
776 extern const struct blit_shader ffp_blit;
777 extern const struct blit_shader arbfp_blit;
778
779 enum fogsource {
780     FOGSOURCE_FFP,
781     FOGSOURCE_VS,
782     FOGSOURCE_COORD,
783 };
784
785 /* The new context manager that should deal with onscreen and offscreen rendering */
786 struct WineD3DContext {
787     /* State dirtification
788      * dirtyArray is an array that contains markers for dirty states. numDirtyEntries states are dirty, their numbers are in indices
789      * 0...numDirtyEntries - 1. isStateDirty is a redundant copy of the dirtyArray. Technically only one of them would be needed,
790      * but with the help of both it is easy to find out if a state is dirty(just check the array index), and for applying dirty states
791      * only numDirtyEntries array elements have to be checked, not STATE_HIGHEST states.
792      */
793     DWORD                   dirtyArray[STATE_HIGHEST + 1]; /* Won't get bigger than that, a state is never marked dirty 2 times */
794     DWORD                   numDirtyEntries;
795     DWORD                   isStateDirty[STATE_HIGHEST/32 + 1]; /* Bitmap to find out quickly if a state is dirty */
796
797     IWineD3DSurface         *surface;
798     DWORD                   tid;    /* Thread ID which owns this context at the moment */
799
800     /* Stores some information about the context state for optimization */
801     WORD draw_buffer_dirty : 1;
802     WORD last_was_rhw : 1;              /* true iff last draw_primitive was in xyzrhw mode */
803     WORD last_was_pshader : 1;
804     WORD last_was_vshader : 1;
805     WORD last_was_foggy_shader : 1;
806     WORD namedArraysLoaded : 1;
807     WORD numberedArraysLoaded : 1;
808     WORD last_was_blit : 1;
809     WORD last_was_ckey : 1;
810     WORD fog_coord : 1;
811     WORD isPBuffer : 1;
812     WORD fog_enabled : 1;
813     WORD num_untracked_materials : 2;   /* Max value 2 */
814     WORD padding : 2;
815     BYTE texShaderBumpMap;              /* MAX_TEXTURES, 8 */
816     BYTE lastWasPow2Texture;            /* MAX_TEXTURES, 8 */
817     DWORD                   numbered_array_mask;
818     GLenum                  tracking_parm;     /* Which source is tracking current colour         */
819     GLenum                  untracked_materials[2];
820     UINT                    blit_w, blit_h;
821     enum fogsource          fog_source;
822
823     char                    *vshader_const_dirty, *pshader_const_dirty;
824
825     /* The actual opengl context */
826     HGLRC                   glCtx;
827     HWND                    win_handle;
828     HDC                     hdc;
829     HPBUFFERARB             pbuffer;
830     GLint                   aux_buffers;
831
832     /* FBOs */
833     struct list             fbo_list;
834     struct fbo_entry        *current_fbo;
835     GLuint                  src_fbo;
836     GLuint                  dst_fbo;
837
838     /* Extension emulation */
839     GLint                   gl_fog_source;
840     GLfloat                 fog_coord_value;
841     GLfloat                 color[4], fogstart, fogend, fogcolor[4];
842 };
843
844 typedef enum ContextUsage {
845     CTXUSAGE_RESOURCELOAD       = 1,    /* Only loads textures: No State is applied */
846     CTXUSAGE_DRAWPRIM           = 2,    /* OpenGL states are set up for blitting DirectDraw surfaces */
847     CTXUSAGE_BLIT               = 3,    /* OpenGL states are set up 3D drawing */
848     CTXUSAGE_CLEAR              = 4,    /* Drawable and states are set up for clearing */
849 } ContextUsage;
850
851 void ActivateContext(IWineD3DDeviceImpl *device, IWineD3DSurface *target, ContextUsage usage);
852 WineD3DContext *getActiveContext(void);
853 WineD3DContext *CreateContext(IWineD3DDeviceImpl *This, IWineD3DSurfaceImpl *target, HWND win, BOOL create_pbuffer, const WINED3DPRESENT_PARAMETERS *pPresentParms);
854 void DestroyContext(IWineD3DDeviceImpl *This, WineD3DContext *context);
855 void context_resource_released(IWineD3DDevice *iface, IWineD3DResource *resource, WINED3DRESOURCETYPE type);
856 void context_bind_fbo(IWineD3DDevice *iface, GLenum target, GLuint *fbo);
857 void context_attach_depth_stencil_fbo(IWineD3DDeviceImpl *This, GLenum fbo_target, IWineD3DSurface *depth_stencil, BOOL use_render_buffer);
858 void context_attach_surface_fbo(IWineD3DDeviceImpl *This, GLenum fbo_target, DWORD idx, IWineD3DSurface *surface);
859
860 void delete_opengl_contexts(IWineD3DDevice *iface, IWineD3DSwapChain *swapchain);
861 HRESULT create_primary_opengl_context(IWineD3DDevice *iface, IWineD3DSwapChain *swapchain);
862
863 /* Macros for doing basic GPU detection based on opengl capabilities */
864 #define WINE_D3D6_CAPABLE(gl_info) (gl_info->supported[ARB_MULTITEXTURE])
865 #define WINE_D3D7_CAPABLE(gl_info) (gl_info->supported[ARB_TEXTURE_COMPRESSION] && gl_info->supported[ARB_TEXTURE_CUBE_MAP] && gl_info->supported[ARB_TEXTURE_ENV_DOT3])
866 #define WINE_D3D8_CAPABLE(gl_info) WINE_D3D7_CAPABLE(gl_info) && (gl_info->supported[ARB_MULTISAMPLE] && gl_info->supported[ARB_TEXTURE_BORDER_CLAMP])
867 #define WINE_D3D9_CAPABLE(gl_info) WINE_D3D8_CAPABLE(gl_info) && (gl_info->supported[ARB_FRAGMENT_PROGRAM] && gl_info->supported[ARB_VERTEX_SHADER])
868
869 /* Default callbacks for implicit object destruction */
870 extern ULONG WINAPI D3DCB_DefaultDestroySurface(IWineD3DSurface *pSurface);
871
872 extern ULONG WINAPI D3DCB_DefaultDestroyVolume(IWineD3DVolume *pSurface);
873
874 /*****************************************************************************
875  * Internal representation of a light
876  */
877 typedef struct PLIGHTINFOEL PLIGHTINFOEL;
878 struct PLIGHTINFOEL {
879     WINED3DLIGHT OriginalParms; /* Note D3D8LIGHT == D3D9LIGHT */
880     DWORD        OriginalIndex;
881     LONG         glIndex;
882     BOOL         changed;
883     BOOL         enabledChanged;
884     BOOL         enabled;
885
886     /* Converted parms to speed up swapping lights */
887     float                         lightPosn[4];
888     float                         lightDirn[4];
889     float                         exponent;
890     float                         cutoff;
891
892     struct list entry;
893 };
894
895 /* The default light parameters */
896 extern const WINED3DLIGHT WINED3D_default_light;
897
898 typedef struct WineD3D_PixelFormat
899 {
900     int iPixelFormat; /* WGL pixel format */
901     int iPixelType; /* WGL pixel type e.g. WGL_TYPE_RGBA_ARB, WGL_TYPE_RGBA_FLOAT_ARB or WGL_TYPE_COLORINDEX_ARB */
902     int redSize, greenSize, blueSize, alphaSize;
903     int depthSize, stencilSize;
904     BOOL windowDrawable;
905     BOOL pbufferDrawable;
906     BOOL doubleBuffer;
907     int auxBuffers;
908     int numSamples;
909 } WineD3D_PixelFormat;
910
911 /* The adapter structure */
912 struct WineD3DAdapter
913 {
914     UINT                    num;
915     BOOL                    opengl;
916     POINT                   monitorPoint;
917     WineD3D_GL_Info         gl_info;
918     const char              *driver;
919     const char              *description;
920     WCHAR                   DeviceName[CCHDEVICENAME]; /* DeviceName for use with e.g. ChangeDisplaySettings */
921     int                     nCfgs;
922     WineD3D_PixelFormat     *cfgs;
923     BOOL                    brokenStencil; /* Set on cards which only offer mixed depth+stencil */
924     unsigned int            TextureRam; /* Amount of texture memory both video ram + AGP/TurboCache/HyperMemory/.. */
925     unsigned int            UsedTextureRam;
926 };
927
928 extern BOOL InitAdapters(void);
929 extern BOOL initPixelFormats(WineD3D_GL_Info *gl_info);
930 extern long WineD3DAdapterChangeGLRam(IWineD3DDeviceImpl *D3DDevice, long glram);
931 extern void add_gl_compat_wrappers(WineD3D_GL_Info *gl_info);
932
933 /*****************************************************************************
934  * High order patch management
935  */
936 struct WineD3DRectPatch
937 {
938     UINT                            Handle;
939     float                          *mem;
940     WineDirect3DVertexStridedData   strided;
941     WINED3DRECTPATCH_INFO           RectPatchInfo;
942     float                           numSegs[4];
943     char                            has_normals, has_texcoords;
944     struct list                     entry;
945 };
946
947 HRESULT tesselate_rectpatch(IWineD3DDeviceImpl *This, struct WineD3DRectPatch *patch);
948
949 enum projection_types
950 {
951     proj_none    = 0,
952     proj_count3  = 1,
953     proj_count4  = 2
954 };
955
956 enum dst_arg
957 {
958     resultreg    = 0,
959     tempreg      = 1
960 };
961
962 /*****************************************************************************
963  * Fixed function pipeline replacements
964  */
965 #define ARG_UNUSED          0xff
966 struct texture_stage_op
967 {
968     unsigned                cop : 8;
969     unsigned                carg1 : 8;
970     unsigned                carg2 : 8;
971     unsigned                carg0 : 8;
972
973     unsigned                aop : 8;
974     unsigned                aarg1 : 8;
975     unsigned                aarg2 : 8;
976     unsigned                aarg0 : 8;
977
978     struct color_fixup_desc color_fixup;
979     unsigned                tex_type : 3;
980     unsigned                dst : 1;
981     unsigned                projected : 2;
982     unsigned                padding : 10;
983 };
984
985 struct ffp_frag_settings {
986     struct texture_stage_op     op[MAX_TEXTURES];
987     enum fogmode fog;
988     /* Use an int instead of a char to get dword alignment */
989     unsigned int sRGB_write;
990 };
991
992 struct ffp_frag_desc
993 {
994     struct ffp_frag_settings    settings;
995 };
996
997 void gen_ffp_frag_op(IWineD3DStateBlockImpl *stateblock, struct ffp_frag_settings *settings, BOOL ignore_textype);
998 const struct ffp_frag_desc *find_ffp_frag_shader(const struct hash_table_t *fragment_shaders,
999         const struct ffp_frag_settings *settings);
1000 void add_ffp_frag_shader(struct hash_table_t *shaders, struct ffp_frag_desc *desc);
1001 BOOL ffp_frag_program_key_compare(const void *keya, const void *keyb);
1002 unsigned int ffp_frag_program_key_hash(const void *key);
1003
1004 /*****************************************************************************
1005  * IWineD3D implementation structure
1006  */
1007 typedef struct IWineD3DImpl
1008 {
1009     /* IUnknown fields */
1010     const IWineD3DVtbl     *lpVtbl;
1011     LONG                    ref;     /* Note: Ref counting not required */
1012
1013     /* WineD3D Information */
1014     IUnknown               *parent;
1015     UINT                    dxVersion;
1016 } IWineD3DImpl;
1017
1018 extern const IWineD3DVtbl IWineD3D_Vtbl;
1019
1020 /* TODO: setup some flags in the registry to enable, disable pbuffer support
1021 (since it will break quite a few things until contexts are managed properly!) */
1022 extern BOOL pbuffer_support;
1023 /* allocate one pbuffer per surface */
1024 extern BOOL pbuffer_per_surface;
1025
1026 /* A helper function that dumps a resource list */
1027 void dumpResources(struct list *list);
1028
1029 /*****************************************************************************
1030  * IWineD3DDevice implementation structure
1031  */
1032 struct IWineD3DDeviceImpl
1033 {
1034     /* IUnknown fields      */
1035     const IWineD3DDeviceVtbl *lpVtbl;
1036     LONG                    ref;     /* Note: Ref counting not required */
1037
1038     /* WineD3D Information  */
1039     IUnknown               *parent;
1040     IWineD3DDeviceParent   *device_parent;
1041     IWineD3D               *wineD3D;
1042     struct WineD3DAdapter  *adapter;
1043
1044     /* Window styles to restore when switching fullscreen mode */
1045     LONG                    style;
1046     LONG                    exStyle;
1047
1048     /* X and GL Information */
1049     GLint                   maxConcurrentLights;
1050     GLenum                  offscreenBuffer;
1051
1052     /* Selected capabilities */
1053     int vs_selected_mode;
1054     int ps_selected_mode;
1055     const shader_backend_t *shader_backend;
1056     void *shader_priv;
1057     void *fragment_priv;
1058     void *blit_priv;
1059     struct StateEntry StateTable[STATE_HIGHEST + 1];
1060     /* Array of functions for states which are handled by more than one pipeline part */
1061     APPLYSTATEFUNC *multistate_funcs[STATE_HIGHEST + 1];
1062     const struct fragment_pipeline *frag_pipe;
1063     const struct blit_shader *blitter;
1064
1065     unsigned int max_ffp_textures, max_ffp_texture_stages;
1066
1067     WORD view_ident : 1;                /* true iff view matrix is identity */
1068     WORD untransformed : 1;
1069     WORD vertexBlendUsed : 1;           /* To avoid needless setting of the blend matrices */
1070     WORD isRecordingState : 1;
1071     WORD isInDraw : 1;
1072     WORD render_offscreen : 1;
1073     WORD bCursorVisible : 1;
1074     WORD haveHardwareCursor : 1;
1075     WORD d3d_initialized : 1;
1076     WORD inScene : 1;                   /* A flag to check for proper BeginScene / EndScene call pairs */
1077     WORD softwareVertexProcessing : 1;  /* process vertex shaders using software or hardware */
1078     WORD useDrawStridedSlow : 1;
1079     WORD instancedDraw : 1;
1080     WORD padding : 3;
1081
1082     BYTE fixed_function_usage_map;      /* MAX_TEXTURES, 8 */
1083
1084 #define DDRAW_PITCH_ALIGNMENT 8
1085 #define D3D8_PITCH_ALIGNMENT 4
1086     unsigned char           surface_alignment; /* Line Alignment of surfaces                      */
1087
1088     /* State block related */
1089     IWineD3DStateBlockImpl *stateBlock;
1090     IWineD3DStateBlockImpl *updateStateBlock;
1091
1092     /* Internal use fields  */
1093     WINED3DDEVICE_CREATION_PARAMETERS createParms;
1094     UINT                            adapterNo;
1095     WINED3DDEVTYPE                  devType;
1096
1097     IWineD3DSwapChain     **swapchains;
1098     UINT                    NumberOfSwapChains;
1099
1100     struct list             resources; /* a linked list to track resources created by the device */
1101     struct list             shaders;   /* a linked list to track shaders (pixel and vertex)      */
1102     unsigned int            highest_dirty_ps_const, highest_dirty_vs_const;
1103
1104     /* Render Target Support */
1105     IWineD3DSurface       **render_targets;
1106     IWineD3DSurface        *auto_depth_stencil_buffer;
1107     IWineD3DSurface        *stencilBufferTarget;
1108
1109     /* Caches to avoid unneeded context changes */
1110     IWineD3DSurface        *lastActiveRenderTarget;
1111     IWineD3DSwapChain      *lastActiveSwapChain;
1112
1113     /* palettes texture management */
1114     UINT                    NumberOfPalettes;
1115     PALETTEENTRY            **palettes;
1116     UINT                    currentPalette;
1117     UINT                    paletteConversionShader;
1118
1119     /* For rendering to a texture using glCopyTexImage */
1120     GLenum                  *draw_buffers;
1121     GLuint                  depth_blt_texture;
1122     GLuint                  depth_blt_rb;
1123     UINT                    depth_blt_rb_w;
1124     UINT                    depth_blt_rb_h;
1125
1126     /* Cursor management */
1127     UINT                    xHotSpot;
1128     UINT                    yHotSpot;
1129     UINT                    xScreenSpace;
1130     UINT                    yScreenSpace;
1131     UINT                    cursorWidth, cursorHeight;
1132     GLuint                  cursorTexture;
1133     HCURSOR                 hardwareCursor;
1134
1135     /* The Wine logo surface */
1136     IWineD3DSurface        *logo_surface;
1137
1138     /* Textures for when no other textures are mapped */
1139     UINT                          dummyTextureName[MAX_TEXTURES];
1140
1141     /* Device state management */
1142     HRESULT                 state;
1143
1144     /* DirectDraw stuff */
1145     DWORD ddraw_width, ddraw_height;
1146     WINED3DFORMAT ddraw_format;
1147
1148     /* Final position fixup constant */
1149     float                       posFixup[4];
1150
1151     /* With register combiners we can skip junk texture stages */
1152     DWORD                     texUnitMap[MAX_COMBINED_SAMPLERS];
1153     DWORD                     rev_tex_unit_map[MAX_COMBINED_SAMPLERS];
1154
1155     /* Stream source management */
1156     WineDirect3DVertexStridedData strided_streams;
1157     const WineDirect3DVertexStridedData *up_strided;
1158
1159     /* Context management */
1160     WineD3DContext          **contexts;                  /* Dynamic array containing pointers to context structures */
1161     WineD3DContext          *activeContext;
1162     DWORD                   lastThread;
1163     UINT                    numContexts;
1164     WineD3DContext          *pbufferContext;             /* The context that has a pbuffer as drawable */
1165     DWORD                   pbufferWidth, pbufferHeight; /* Size of the buffer drawable */
1166
1167     /* High level patch management */
1168 #define PATCHMAP_SIZE 43
1169 #define PATCHMAP_HASHFUNC(x) ((x) % PATCHMAP_SIZE) /* Primitive and simple function */
1170     struct list             patches[PATCHMAP_SIZE];
1171     struct WineD3DRectPatch *currentPatch;
1172 };
1173
1174 extern const IWineD3DDeviceVtbl IWineD3DDevice_Vtbl;
1175
1176 HRESULT IWineD3DDeviceImpl_ClearSurface(IWineD3DDeviceImpl *This,  IWineD3DSurfaceImpl *target, DWORD Count,
1177                                         CONST WINED3DRECT* pRects, DWORD Flags, WINED3DCOLOR Color,
1178                                         float Z, DWORD Stencil);
1179 void IWineD3DDeviceImpl_FindTexUnitMap(IWineD3DDeviceImpl *This);
1180 void IWineD3DDeviceImpl_MarkStateDirty(IWineD3DDeviceImpl *This, DWORD state);
1181 static inline BOOL isStateDirty(WineD3DContext *context, DWORD state) {
1182     DWORD idx = state >> 5;
1183     BYTE shift = state & 0x1f;
1184     return context->isStateDirty[idx] & (1 << shift);
1185 }
1186
1187 /* Support for IWineD3DResource ::Set/Get/FreePrivateData. */
1188 typedef struct PrivateData
1189 {
1190     struct list entry;
1191
1192     GUID tag;
1193     DWORD flags; /* DDSPD_* */
1194
1195     union
1196     {
1197         LPVOID data;
1198         LPUNKNOWN object;
1199     } ptr;
1200
1201     DWORD size;
1202 } PrivateData;
1203
1204 /*****************************************************************************
1205  * IWineD3DResource implementation structure
1206  */
1207 typedef struct IWineD3DResourceClass
1208 {
1209     /* IUnknown fields */
1210     LONG                    ref;     /* Note: Ref counting not required */
1211
1212     /* WineD3DResource Information */
1213     IUnknown               *parent;
1214     WINED3DRESOURCETYPE     resourceType;
1215     IWineD3DDeviceImpl     *wineD3DDevice;
1216     WINED3DPOOL             pool;
1217     UINT                    size;
1218     DWORD                   usage;
1219     WINED3DFORMAT           format;
1220     DWORD                   priority;
1221     BYTE                   *allocatedMemory; /* Pointer to the real data location */
1222     BYTE                   *heapMemory; /* Pointer to the HeapAlloced block of memory */
1223     struct list             privateData;
1224     struct list             resource_list_entry;
1225
1226 } IWineD3DResourceClass;
1227
1228 typedef struct IWineD3DResourceImpl
1229 {
1230     /* IUnknown & WineD3DResource Information     */
1231     const IWineD3DResourceVtbl *lpVtbl;
1232     IWineD3DResourceClass   resource;
1233 } IWineD3DResourceImpl;
1234
1235 void resource_cleanup(IWineD3DResource *iface);
1236 HRESULT resource_free_private_data(IWineD3DResource *iface, REFGUID guid);
1237 HRESULT resource_get_device(IWineD3DResource *iface, IWineD3DDevice **device);
1238 HRESULT resource_get_parent(IWineD3DResource *iface, IUnknown **parent);
1239 DWORD resource_get_priority(IWineD3DResource *iface);
1240 HRESULT resource_get_private_data(IWineD3DResource *iface, REFGUID guid,
1241         void *data, DWORD *data_size);
1242 HRESULT resource_init(struct IWineD3DResourceClass *resource, WINED3DRESOURCETYPE resource_type,
1243         IWineD3DDeviceImpl *device, UINT size, DWORD usage, WINED3DFORMAT format, WINED3DPOOL pool, IUnknown *parent);
1244 WINED3DRESOURCETYPE resource_get_type(IWineD3DResource *iface);
1245 DWORD resource_set_priority(IWineD3DResource *iface, DWORD new_priority);
1246 HRESULT resource_set_private_data(IWineD3DResource *iface, REFGUID guid,
1247         const void *data, DWORD data_size, DWORD flags);
1248
1249 /* Tests show that the start address of resources is 32 byte aligned */
1250 #define RESOURCE_ALIGNMENT 32
1251
1252 /*****************************************************************************
1253  * IWineD3DVertexBuffer implementation structure (extends IWineD3DResourceImpl)
1254  */
1255 enum vbo_conversion_type {
1256     CONV_NONE               = 0,
1257     CONV_D3DCOLOR           = 1,
1258     CONV_POSITIONT          = 2,
1259     CONV_FLOAT16_2          = 3 /* Also handles FLOAT16_4 */
1260
1261     /* TODO: Add tests and support for FLOAT16_4 POSITIONT, D3DCOLOR position, other
1262      * fixed function semantics as D3DCOLOR or FLOAT16
1263      */
1264 };
1265
1266 typedef struct IWineD3DVertexBufferImpl
1267 {
1268     /* IUnknown & WineD3DResource Information     */
1269     const IWineD3DVertexBufferVtbl *lpVtbl;
1270     IWineD3DResourceClass     resource;
1271
1272     /* WineD3DVertexBuffer specifics */
1273     DWORD                     fvf;
1274
1275     /* Vertex buffer object support */
1276     GLuint                    vbo;
1277     BYTE                      Flags;
1278     LONG                      bindCount;
1279     LONG                      vbo_size;
1280     GLenum                    vbo_usage;
1281
1282     UINT                      dirtystart, dirtyend;
1283     LONG                      lockcount;
1284
1285     LONG                      declChanges, draws;
1286     /* Last description of the buffer */
1287     DWORD                     stride;       /* 0 if no conversion               */
1288     enum vbo_conversion_type  *conv_map;    /* NULL if no conversion            */
1289
1290     /* Extra load offsets, for FLOAT16 conversion */
1291     DWORD                     *conv_shift;  /* NULL if no shifted conversion    */
1292     DWORD                     conv_stride;  /* 0 if no shifted conversion       */
1293 } IWineD3DVertexBufferImpl;
1294
1295 extern const IWineD3DVertexBufferVtbl IWineD3DVertexBuffer_Vtbl;
1296
1297 #define VBFLAG_OPTIMIZED      0x01    /* Optimize has been called for the VB */
1298 #define VBFLAG_DIRTY          0x02    /* Buffer data has been modified */
1299 #define VBFLAG_HASDESC        0x04    /* A vertex description has been found */
1300 #define VBFLAG_CREATEVBO      0x08    /* Attempt to create a VBO next PreLoad */
1301
1302 /*****************************************************************************
1303  * IWineD3DIndexBuffer implementation structure (extends IWineD3DResourceImpl)
1304  */
1305 typedef struct IWineD3DIndexBufferImpl
1306 {
1307     /* IUnknown & WineD3DResource Information     */
1308     const IWineD3DIndexBufferVtbl *lpVtbl;
1309     IWineD3DResourceClass     resource;
1310
1311     GLuint                    vbo;
1312     UINT                      dirtystart, dirtyend;
1313     LONG                      lockcount;
1314
1315     /* WineD3DVertexBuffer specifics */
1316 } IWineD3DIndexBufferImpl;
1317
1318 extern const IWineD3DIndexBufferVtbl IWineD3DIndexBuffer_Vtbl;
1319
1320 /*****************************************************************************
1321  * IWineD3DBaseTexture D3D- > openGL state map lookups
1322  */
1323 #define WINED3DFUNC_NOTSUPPORTED  -2
1324 #define WINED3DFUNC_UNIMPLEMENTED -1
1325
1326 typedef enum winetexturestates {
1327     WINED3DTEXSTA_ADDRESSU       = 0,
1328     WINED3DTEXSTA_ADDRESSV       = 1,
1329     WINED3DTEXSTA_ADDRESSW       = 2,
1330     WINED3DTEXSTA_BORDERCOLOR    = 3,
1331     WINED3DTEXSTA_MAGFILTER      = 4,
1332     WINED3DTEXSTA_MINFILTER      = 5,
1333     WINED3DTEXSTA_MIPFILTER      = 6,
1334     WINED3DTEXSTA_MAXMIPLEVEL    = 7,
1335     WINED3DTEXSTA_MAXANISOTROPY  = 8,
1336     WINED3DTEXSTA_SRGBTEXTURE    = 9,
1337     WINED3DTEXSTA_ELEMENTINDEX   = 10,
1338     WINED3DTEXSTA_DMAPOFFSET     = 11,
1339     WINED3DTEXSTA_TSSADDRESSW    = 12,
1340     MAX_WINETEXTURESTATES        = 13,
1341 } winetexturestates;
1342
1343 /*****************************************************************************
1344  * IWineD3DBaseTexture implementation structure (extends IWineD3DResourceImpl)
1345  */
1346 typedef struct IWineD3DBaseTextureClass
1347 {
1348     DWORD                   states[MAX_WINETEXTURESTATES];
1349     UINT                    levels;
1350     BOOL                    dirty;
1351     UINT                    textureName;
1352     float                   pow2Matrix[16];
1353     UINT                    LOD;
1354     WINED3DTEXTUREFILTERTYPE filterType;
1355     LONG                    bindCount;
1356     DWORD                   sampler;
1357     BOOL                    is_srgb;
1358     UINT                    srgb_mode_change_count;
1359     const struct min_lookup *minMipLookup;
1360     const GLenum            *magLookup;
1361     struct color_fixup_desc shader_color_fixup;
1362 } IWineD3DBaseTextureClass;
1363
1364 typedef struct IWineD3DBaseTextureImpl
1365 {
1366     /* IUnknown & WineD3DResource Information     */
1367     const IWineD3DBaseTextureVtbl *lpVtbl;
1368     IWineD3DResourceClass     resource;
1369     IWineD3DBaseTextureClass  baseTexture;
1370
1371 } IWineD3DBaseTextureImpl;
1372
1373 void basetexture_apply_state_changes(IWineD3DBaseTexture *iface,
1374         const DWORD texture_states[WINED3D_HIGHEST_TEXTURE_STATE + 1],
1375         const DWORD sampler_states[WINED3D_HIGHEST_SAMPLER_STATE + 1]);
1376 HRESULT basetexture_bind(IWineD3DBaseTexture *iface);
1377 void basetexture_cleanup(IWineD3DBaseTexture *iface);
1378 void basetexture_generate_mipmaps(IWineD3DBaseTexture *iface);
1379 WINED3DTEXTUREFILTERTYPE basetexture_get_autogen_filter_type(IWineD3DBaseTexture *iface);
1380 BOOL basetexture_get_dirty(IWineD3DBaseTexture *iface);
1381 DWORD basetexture_get_level_count(IWineD3DBaseTexture *iface);
1382 DWORD basetexture_get_lod(IWineD3DBaseTexture *iface);
1383 void basetexture_init(struct IWineD3DBaseTextureClass *texture, UINT levels, DWORD usage);
1384 HRESULT basetexture_set_autogen_filter_type(IWineD3DBaseTexture *iface, WINED3DTEXTUREFILTERTYPE filter_type);
1385 BOOL basetexture_set_dirty(IWineD3DBaseTexture *iface, BOOL dirty);
1386 DWORD basetexture_set_lod(IWineD3DBaseTexture *iface, DWORD new_lod);
1387 void basetexture_unload(IWineD3DBaseTexture *iface);
1388
1389 /*****************************************************************************
1390  * IWineD3DTexture implementation structure (extends IWineD3DBaseTextureImpl)
1391  */
1392 typedef struct IWineD3DTextureImpl
1393 {
1394     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
1395     const IWineD3DTextureVtbl *lpVtbl;
1396     IWineD3DResourceClass     resource;
1397     IWineD3DBaseTextureClass  baseTexture;
1398
1399     /* IWineD3DTexture */
1400     IWineD3DSurface          *surfaces[MAX_LEVELS];
1401     
1402     UINT                      width;
1403     UINT                      height;
1404     UINT                      target;
1405     BOOL                      cond_np2;
1406
1407 } IWineD3DTextureImpl;
1408
1409 extern const IWineD3DTextureVtbl IWineD3DTexture_Vtbl;
1410
1411 /*****************************************************************************
1412  * IWineD3DCubeTexture implementation structure (extends IWineD3DBaseTextureImpl)
1413  */
1414 typedef struct IWineD3DCubeTextureImpl
1415 {
1416     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
1417     const IWineD3DCubeTextureVtbl *lpVtbl;
1418     IWineD3DResourceClass     resource;
1419     IWineD3DBaseTextureClass  baseTexture;
1420
1421     /* IWineD3DCubeTexture */
1422     IWineD3DSurface          *surfaces[6][MAX_LEVELS];
1423 } IWineD3DCubeTextureImpl;
1424
1425 extern const IWineD3DCubeTextureVtbl IWineD3DCubeTexture_Vtbl;
1426
1427 typedef struct _WINED3DVOLUMET_DESC
1428 {
1429     UINT                    Width;
1430     UINT                    Height;
1431     UINT                    Depth;
1432 } WINED3DVOLUMET_DESC;
1433
1434 /*****************************************************************************
1435  * IWineD3DVolume implementation structure (extends IUnknown)
1436  */
1437 typedef struct IWineD3DVolumeImpl
1438 {
1439     /* IUnknown & WineD3DResource fields */
1440     const IWineD3DVolumeVtbl  *lpVtbl;
1441     IWineD3DResourceClass      resource;
1442
1443     /* WineD3DVolume Information */
1444     WINED3DVOLUMET_DESC      currentDesc;
1445     IWineD3DBase            *container;
1446     UINT                    bytesPerPixel;
1447
1448     BOOL                    lockable;
1449     BOOL                    locked;
1450     WINED3DBOX              lockedBox;
1451     WINED3DBOX              dirtyBox;
1452     BOOL                    dirty;
1453
1454
1455 } IWineD3DVolumeImpl;
1456
1457 extern const IWineD3DVolumeVtbl IWineD3DVolume_Vtbl;
1458
1459 void volume_add_dirty_box(IWineD3DVolume *iface, const WINED3DBOX *dirty_box);
1460
1461 /*****************************************************************************
1462  * IWineD3DVolumeTexture implementation structure (extends IWineD3DBaseTextureImpl)
1463  */
1464 typedef struct IWineD3DVolumeTextureImpl
1465 {
1466     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
1467     const IWineD3DVolumeTextureVtbl *lpVtbl;
1468     IWineD3DResourceClass     resource;
1469     IWineD3DBaseTextureClass  baseTexture;
1470
1471     /* IWineD3DVolumeTexture */
1472     IWineD3DVolume           *volumes[MAX_LEVELS];
1473 } IWineD3DVolumeTextureImpl;
1474
1475 extern const IWineD3DVolumeTextureVtbl IWineD3DVolumeTexture_Vtbl;
1476
1477 typedef struct _WINED3DSURFACET_DESC
1478 {
1479     WINED3DMULTISAMPLE_TYPE MultiSampleType;
1480     DWORD                   MultiSampleQuality;
1481     UINT                    Width;
1482     UINT                    Height;
1483 } WINED3DSURFACET_DESC;
1484
1485 /*****************************************************************************
1486  * Structure for DIB Surfaces (GetDC and GDI surfaces)
1487  */
1488 typedef struct wineD3DSurface_DIB {
1489     HBITMAP DIBsection;
1490     void* bitmap_data;
1491     UINT bitmap_size;
1492     HGDIOBJ holdbitmap;
1493     BOOL client_memory;
1494 } wineD3DSurface_DIB;
1495
1496 typedef struct {
1497     struct list entry;
1498     GLuint id;
1499     UINT width;
1500     UINT height;
1501 } renderbuffer_entry_t;
1502
1503 struct fbo_entry
1504 {
1505     struct list entry;
1506     IWineD3DSurface **render_targets;
1507     IWineD3DSurface *depth_stencil;
1508     BOOL attached;
1509     GLuint id;
1510 };
1511
1512 /*****************************************************************************
1513  * IWineD3DClipp implementation structure
1514  */
1515 typedef struct IWineD3DClipperImpl
1516 {
1517     const IWineD3DClipperVtbl *lpVtbl;
1518     LONG ref;
1519
1520     IUnknown *Parent;
1521     HWND hWnd;
1522 } IWineD3DClipperImpl;
1523
1524
1525 /*****************************************************************************
1526  * IWineD3DSurface implementation structure
1527  */
1528 struct IWineD3DSurfaceImpl
1529 {
1530     /* IUnknown & IWineD3DResource Information     */
1531     const IWineD3DSurfaceVtbl *lpVtbl;
1532     IWineD3DResourceClass     resource;
1533
1534     /* IWineD3DSurface fields */
1535     IWineD3DBase              *container;
1536     WINED3DSURFACET_DESC      currentDesc;
1537     IWineD3DPaletteImpl       *palette; /* D3D7 style palette handling */
1538     PALETTEENTRY              *palette9; /* D3D8/9 style palette handling */
1539
1540     UINT                      bytesPerPixel;
1541
1542     /* TODO: move this off into a management class(maybe!) */
1543     DWORD                      Flags;
1544
1545     UINT                      pow2Width;
1546     UINT                      pow2Height;
1547     float                     heightscale;
1548
1549     /* A method to retrieve the drawable size. Not in the Vtable to make it changeable */
1550     void (*get_drawable_size)(IWineD3DSurfaceImpl *This, UINT *width, UINT *height);
1551
1552     /* Oversized texture */
1553     RECT                      glRect;
1554
1555     /* PBO */
1556     GLuint                    pbo;
1557
1558     RECT                      lockedRect;
1559     RECT                      dirtyRect;
1560     int                       lockCount;
1561 #define MAXLOCKCOUNT          50 /* After this amount of locks do not free the sysmem copy */
1562
1563     glDescriptor              glDescription;
1564     BOOL                      srgb;
1565
1566     /* For GetDC */
1567     wineD3DSurface_DIB        dib;
1568     HDC                       hDC;
1569
1570     /* Color keys for DDraw */
1571     WINEDDCOLORKEY            DestBltCKey;
1572     WINEDDCOLORKEY            DestOverlayCKey;
1573     WINEDDCOLORKEY            SrcOverlayCKey;
1574     WINEDDCOLORKEY            SrcBltCKey;
1575     DWORD                     CKeyFlags;
1576
1577     WINEDDCOLORKEY            glCKey;
1578
1579     struct list               renderbuffers;
1580     renderbuffer_entry_t      *current_renderbuffer;
1581
1582     /* DirectDraw clippers */
1583     IWineD3DClipper           *clipper;
1584
1585     /* DirectDraw Overlay handling */
1586     RECT                      overlay_srcrect;
1587     RECT                      overlay_destrect;
1588     IWineD3DSurfaceImpl       *overlay_dest;
1589     struct list               overlays;
1590     struct list               overlay_entry;
1591 };
1592
1593 extern const IWineD3DSurfaceVtbl IWineD3DSurface_Vtbl;
1594 extern const IWineD3DSurfaceVtbl IWineGDISurface_Vtbl;
1595
1596 /* Predeclare the shared Surface functions */
1597 HRESULT WINAPI IWineD3DBaseSurfaceImpl_QueryInterface(IWineD3DSurface *iface, REFIID riid, LPVOID *ppobj);
1598 ULONG WINAPI IWineD3DBaseSurfaceImpl_AddRef(IWineD3DSurface *iface);
1599 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetParent(IWineD3DSurface *iface, IUnknown **pParent);
1600 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetDevice(IWineD3DSurface *iface, IWineD3DDevice** ppDevice);
1601 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetPrivateData(IWineD3DSurface *iface, REFGUID refguid, CONST void* pData, DWORD SizeOfData, DWORD Flags);
1602 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetPrivateData(IWineD3DSurface *iface, REFGUID refguid, void* pData, DWORD* pSizeOfData);
1603 HRESULT WINAPI IWineD3DBaseSurfaceImpl_FreePrivateData(IWineD3DSurface *iface, REFGUID refguid);
1604 DWORD   WINAPI IWineD3DBaseSurfaceImpl_SetPriority(IWineD3DSurface *iface, DWORD PriorityNew);
1605 DWORD   WINAPI IWineD3DBaseSurfaceImpl_GetPriority(IWineD3DSurface *iface);
1606 WINED3DRESOURCETYPE WINAPI IWineD3DBaseSurfaceImpl_GetType(IWineD3DSurface *iface);
1607 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetContainer(IWineD3DSurface* iface, REFIID riid, void** ppContainer);
1608 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetDesc(IWineD3DSurface *iface, WINED3DSURFACE_DESC *pDesc);
1609 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetBltStatus(IWineD3DSurface *iface, DWORD Flags);
1610 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetFlipStatus(IWineD3DSurface *iface, DWORD Flags);
1611 HRESULT WINAPI IWineD3DBaseSurfaceImpl_IsLost(IWineD3DSurface *iface);
1612 HRESULT WINAPI IWineD3DBaseSurfaceImpl_Restore(IWineD3DSurface *iface);
1613 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetPalette(IWineD3DSurface *iface, IWineD3DPalette **Pal);
1614 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetPalette(IWineD3DSurface *iface, IWineD3DPalette *Pal);
1615 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetColorKey(IWineD3DSurface *iface, DWORD Flags, const WINEDDCOLORKEY *CKey);
1616 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetContainer(IWineD3DSurface *iface, IWineD3DBase *container);
1617 DWORD WINAPI IWineD3DBaseSurfaceImpl_GetPitch(IWineD3DSurface *iface);
1618 HRESULT WINAPI IWineD3DBaseSurfaceImpl_RealizePalette(IWineD3DSurface *iface);
1619 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetOverlayPosition(IWineD3DSurface *iface, LONG X, LONG Y);
1620 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetOverlayPosition(IWineD3DSurface *iface, LONG *X, LONG *Y);
1621 HRESULT WINAPI IWineD3DBaseSurfaceImpl_UpdateOverlayZOrder(IWineD3DSurface *iface, DWORD Flags, IWineD3DSurface *Ref);
1622 HRESULT WINAPI IWineD3DBaseSurfaceImpl_UpdateOverlay(IWineD3DSurface *iface, const RECT *SrcRect,
1623         IWineD3DSurface *DstSurface, const RECT *DstRect, DWORD Flags, const WINEDDOVERLAYFX *FX);
1624 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetClipper(IWineD3DSurface *iface, IWineD3DClipper *clipper);
1625 HRESULT WINAPI IWineD3DBaseSurfaceImpl_GetClipper(IWineD3DSurface *iface, IWineD3DClipper **clipper);
1626 HRESULT WINAPI IWineD3DBaseSurfaceImpl_SetFormat(IWineD3DSurface *iface, WINED3DFORMAT format);
1627 HRESULT IWineD3DBaseSurfaceImpl_CreateDIBSection(IWineD3DSurface *iface);
1628 HRESULT WINAPI IWineD3DBaseSurfaceImpl_Blt(IWineD3DSurface *iface, const RECT *DestRect, IWineD3DSurface *SrcSurface,
1629         const RECT *SrcRect, DWORD Flags, const WINEDDBLTFX *DDBltFx, WINED3DTEXTUREFILTERTYPE Filter);
1630 HRESULT WINAPI IWineD3DBaseSurfaceImpl_BltFast(IWineD3DSurface *iface, DWORD dstx, DWORD dsty,
1631         IWineD3DSurface *Source, const RECT *rsrc, DWORD trans);
1632 HRESULT WINAPI IWineD3DBaseSurfaceImpl_LockRect(IWineD3DSurface *iface, WINED3DLOCKED_RECT* pLockedRect, CONST RECT* pRect, DWORD Flags);
1633 void WINAPI IWineD3DBaseSurfaceImpl_BindTexture(IWineD3DSurface *iface);
1634 const void *WINAPI IWineD3DBaseSurfaceImpl_GetData(IWineD3DSurface *iface);
1635
1636 void get_drawable_size_swapchain(IWineD3DSurfaceImpl *This, UINT *width, UINT *height);
1637 void get_drawable_size_backbuffer(IWineD3DSurfaceImpl *This, UINT *width, UINT *height);
1638 void get_drawable_size_pbuffer(IWineD3DSurfaceImpl *This, UINT *width, UINT *height);
1639 void get_drawable_size_fbo(IWineD3DSurfaceImpl *This, UINT *width, UINT *height);
1640
1641 void flip_surface(IWineD3DSurfaceImpl *front, IWineD3DSurfaceImpl *back);
1642
1643 /* Surface flags: */
1644 #define SFLAG_OVERSIZE      0x00000001 /* Surface is bigger than gl size, blts only */
1645 #define SFLAG_CONVERTED     0x00000002 /* Converted for color keying or Palettized */
1646 #define SFLAG_DIBSECTION    0x00000004 /* Has a DIB section attached for GetDC */
1647 #define SFLAG_LOCKABLE      0x00000008 /* Surface can be locked */
1648 #define SFLAG_DISCARD       0x00000010 /* ??? */
1649 #define SFLAG_LOCKED        0x00000020 /* Surface is locked atm */
1650 #define SFLAG_INTEXTURE     0x00000040 /* The GL texture contains the newest surface content */
1651 #define SFLAG_INDRAWABLE    0x00000080 /* The gl drawable contains the most up to date data */
1652 #define SFLAG_INSYSMEM      0x00000100 /* The system memory copy is most up to date */
1653 #define SFLAG_NONPOW2       0x00000200 /* Surface sizes are not a power of 2 */
1654 #define SFLAG_DYNLOCK       0x00000400 /* Surface is often locked by the app */
1655 #define SFLAG_DYNCHANGE     0x00000C00 /* Surface contents are changed very often, implies DYNLOCK */
1656 #define SFLAG_DCINUSE       0x00001000 /* Set between GetDC and ReleaseDC calls */
1657 #define SFLAG_LOST          0x00002000 /* Surface lost flag for DDraw */
1658 #define SFLAG_USERPTR       0x00004000 /* The application allocated the memory for this surface */
1659 #define SFLAG_GLCKEY        0x00008000 /* The gl texture was created with a color key */
1660 #define SFLAG_CLIENT        0x00010000 /* GL_APPLE_client_storage is used on that texture */
1661 #define SFLAG_ALLOCATED     0x00020000 /* A gl texture is allocated for this surface */
1662 #define SFLAG_PBO           0x00040000 /* Has a PBO attached for speeding up data transfers for dynamically locked surfaces */
1663 #define SFLAG_NORMCOORD     0x00080000 /* Set if the GL texture coords are normalized(non-texture rectangle) */
1664 #define SFLAG_DS_ONSCREEN   0x00100000 /* Is a depth stencil, last modified onscreen */
1665 #define SFLAG_DS_OFFSCREEN  0x00200000 /* Is a depth stencil, last modified offscreen */
1666 #define SFLAG_INOVERLAYDRAW 0x00400000 /* Overlay drawing is in progress. Recursion prevention */
1667
1668 /* In some conditions the surface memory must not be freed:
1669  * SFLAG_OVERSIZE: Not all data can be kept in GL
1670  * SFLAG_CONVERTED: Converting the data back would take too long
1671  * SFLAG_DIBSECTION: The dib code manages the memory
1672  * SFLAG_LOCKED: The app requires access to the surface data
1673  * SFLAG_DYNLOCK: Avoid freeing the data for performance
1674  * SFLAG_DYNCHANGE: Same reason as DYNLOCK
1675  * SFLAG_PBO: PBOs don't use 'normal' memory. It is either allocated by the driver or must be NULL.
1676  * SFLAG_CLIENT: OpenGL uses our memory as backup
1677  */
1678 #define SFLAG_DONOTFREE     (SFLAG_OVERSIZE   | \
1679                              SFLAG_CONVERTED  | \
1680                              SFLAG_DIBSECTION | \
1681                              SFLAG_LOCKED     | \
1682                              SFLAG_DYNLOCK    | \
1683                              SFLAG_DYNCHANGE  | \
1684                              SFLAG_USERPTR    | \
1685                              SFLAG_PBO        | \
1686                              SFLAG_CLIENT)
1687
1688 #define SFLAG_LOCATIONS     (SFLAG_INSYSMEM   | \
1689                              SFLAG_INTEXTURE  | \
1690                              SFLAG_INDRAWABLE)
1691
1692 #define SFLAG_DS_LOCATIONS  (SFLAG_DS_ONSCREEN | \
1693                              SFLAG_DS_OFFSCREEN)
1694 #define SFLAG_DS_DISCARDED   SFLAG_DS_LOCATIONS
1695
1696 BOOL CalculateTexRect(IWineD3DSurfaceImpl *This, RECT *Rect, float glTexCoord[4]);
1697
1698 typedef enum {
1699     NO_CONVERSION,
1700     CONVERT_PALETTED,
1701     CONVERT_PALETTED_CK,
1702     CONVERT_CK_565,
1703     CONVERT_CK_5551,
1704     CONVERT_CK_4444,
1705     CONVERT_CK_4444_ARGB,
1706     CONVERT_CK_1555,
1707     CONVERT_555,
1708     CONVERT_CK_RGB24,
1709     CONVERT_CK_8888,
1710     CONVERT_CK_8888_ARGB,
1711     CONVERT_RGB32_888,
1712     CONVERT_V8U8,
1713     CONVERT_L6V5U5,
1714     CONVERT_X8L8V8U8,
1715     CONVERT_Q8W8V8U8,
1716     CONVERT_V16U16,
1717     CONVERT_A4L4,
1718     CONVERT_G16R16,
1719 } CONVERT_TYPES;
1720
1721 HRESULT d3dfmt_get_conv(IWineD3DSurfaceImpl *This, BOOL need_alpha_ck, BOOL use_texturing, GLenum *format, GLenum *internal, GLenum *type, CONVERT_TYPES *convert, int *target_bpp, BOOL srgb_mode);
1722
1723 BOOL palette9_changed(IWineD3DSurfaceImpl *This);
1724
1725 /*****************************************************************************
1726  * IWineD3DVertexDeclaration implementation structure
1727  */
1728 #define MAX_ATTRIBS 16
1729
1730 typedef struct IWineD3DVertexDeclarationImpl {
1731     /* IUnknown  Information */
1732     const IWineD3DVertexDeclarationVtbl *lpVtbl;
1733     LONG                    ref;
1734
1735     IUnknown                *parent;
1736     IWineD3DDeviceImpl      *wineD3DDevice;
1737
1738     WINED3DVERTEXELEMENT    *pDeclarationWine;
1739     BOOL                    *ffp_valid;
1740     UINT                    declarationWNumElements;
1741
1742     DWORD                   streams[MAX_STREAMS];
1743     UINT                    num_streams;
1744     BOOL                    position_transformed;
1745     BOOL                    half_float_conv_needed;
1746 } IWineD3DVertexDeclarationImpl;
1747
1748 extern const IWineD3DVertexDeclarationVtbl IWineD3DVertexDeclaration_Vtbl;
1749
1750 /*****************************************************************************
1751  * IWineD3DStateBlock implementation structure
1752  */
1753
1754 /* Internal state Block for Begin/End/Capture/Create/Apply info  */
1755 /*   Note: Very long winded but gl Lists are not flexible enough */
1756 /*   to resolve everything we need, so doing it manually for now */
1757 typedef struct SAVEDSTATES {
1758     DWORD transform[(HIGHEST_TRANSFORMSTATE >> 5) + 1];
1759     WORD streamSource;                          /* MAX_STREAMS, 16 */
1760     WORD streamFreq;                            /* MAX_STREAMS, 16 */
1761     DWORD renderState[(WINEHIGHEST_RENDER_STATE >> 5) + 1];
1762     DWORD textureState[MAX_TEXTURES];           /* WINED3D_HIGHEST_TEXTURE_STATE + 1, 18 */
1763     WORD samplerState[MAX_COMBINED_SAMPLERS];   /* WINED3D_HIGHEST_SAMPLER_STATE + 1, 14 */
1764     DWORD textures;                             /* MAX_COMBINED_SAMPLERS, 20 */
1765     DWORD clipplane;                            /* WINED3DMAXUSERCLIPPLANES, 32 */
1766     WORD pixelShaderConstantsB;                 /* MAX_CONST_B, 16 */
1767     WORD pixelShaderConstantsI;                 /* MAX_CONST_I, 16 */
1768     BOOL *pixelShaderConstantsF;
1769     WORD vertexShaderConstantsB;                /* MAX_CONST_B, 16 */
1770     WORD vertexShaderConstantsI;                /* MAX_CONST_I, 16 */
1771     BOOL *vertexShaderConstantsF;
1772     BYTE indices : 1;
1773     BYTE material : 1;
1774     BYTE viewport : 1;
1775     BYTE vertexDecl : 1;
1776     BYTE pixelShader : 1;
1777     BYTE vertexShader : 1;
1778     BYTE scissorRect : 1;
1779     BYTE padding : 1;
1780 } SAVEDSTATES;
1781
1782 struct StageState {
1783     DWORD stage;
1784     DWORD state;
1785 };
1786
1787 struct IWineD3DStateBlockImpl
1788 {
1789     /* IUnknown fields */
1790     const IWineD3DStateBlockVtbl *lpVtbl;
1791     LONG                      ref;     /* Note: Ref counting not required */
1792
1793     /* IWineD3DStateBlock information */
1794     IUnknown                 *parent;
1795     IWineD3DDeviceImpl       *wineD3DDevice;
1796     WINED3DSTATEBLOCKTYPE     blockType;
1797
1798     /* Array indicating whether things have been set or changed */
1799     SAVEDSTATES               changed;
1800
1801     /* Vertex Shader Declaration */
1802     IWineD3DVertexDeclaration *vertexDecl;
1803
1804     IWineD3DVertexShader      *vertexShader;
1805
1806     /* Vertex Shader Constants */
1807     BOOL                       vertexShaderConstantB[MAX_CONST_B];
1808     INT                        vertexShaderConstantI[MAX_CONST_I * 4];
1809     float                     *vertexShaderConstantF;
1810
1811     /* Stream Source */
1812     BOOL                      streamIsUP;
1813     UINT                      streamStride[MAX_STREAMS];
1814     UINT                      streamOffset[MAX_STREAMS + 1 /* tesselated pseudo-stream */ ];
1815     IWineD3DVertexBuffer     *streamSource[MAX_STREAMS];
1816     UINT                      streamFreq[MAX_STREAMS + 1];
1817     UINT                      streamFlags[MAX_STREAMS + 1];     /*0 | WINED3DSTREAMSOURCE_INSTANCEDATA | WINED3DSTREAMSOURCE_INDEXEDDATA  */
1818
1819     /* Indices */
1820     IWineD3DIndexBuffer*      pIndexData;
1821     INT                       baseVertexIndex;
1822     INT                       loadBaseVertexIndex; /* non-indexed drawing needs 0 here, indexed baseVertexIndex */
1823
1824     /* Transform */
1825     WINED3DMATRIX             transforms[HIGHEST_TRANSFORMSTATE + 1];
1826
1827     /* Light hashmap . Collisions are handled using standard wine double linked lists */
1828 #define LIGHTMAP_SIZE 43 /* Use of a prime number recommended. Set to 1 for a linked list! */
1829 #define LIGHTMAP_HASHFUNC(x) ((x) % LIGHTMAP_SIZE) /* Primitive and simple function */
1830     struct list               lightMap[LIGHTMAP_SIZE]; /* Mashmap containing the lights */
1831     PLIGHTINFOEL             *activeLights[MAX_ACTIVE_LIGHTS]; /* Map of opengl lights to d3d lights */
1832
1833     /* Clipping */
1834     double                    clipplane[MAX_CLIPPLANES][4];
1835     WINED3DCLIPSTATUS         clip_status;
1836
1837     /* ViewPort */
1838     WINED3DVIEWPORT           viewport;
1839
1840     /* Material */
1841     WINED3DMATERIAL           material;
1842
1843     /* Pixel Shader */
1844     IWineD3DPixelShader      *pixelShader;
1845
1846     /* Pixel Shader Constants */
1847     BOOL                       pixelShaderConstantB[MAX_CONST_B];
1848     INT                        pixelShaderConstantI[MAX_CONST_I * 4];
1849     float                     *pixelShaderConstantF;
1850
1851     /* RenderState */
1852     DWORD                     renderState[WINEHIGHEST_RENDER_STATE + 1];
1853
1854     /* Texture */
1855     IWineD3DBaseTexture      *textures[MAX_COMBINED_SAMPLERS];
1856
1857     /* Texture State Stage */
1858     DWORD                     textureState[MAX_TEXTURES][WINED3D_HIGHEST_TEXTURE_STATE + 1];
1859     DWORD                     lowest_disabled_stage;
1860     /* Sampler States */
1861     DWORD                     samplerState[MAX_COMBINED_SAMPLERS][WINED3D_HIGHEST_SAMPLER_STATE + 1];
1862
1863     /* Scissor test rectangle */
1864     RECT                      scissorRect;
1865
1866     /* Contained state management */
1867     DWORD                     contained_render_states[WINEHIGHEST_RENDER_STATE + 1];
1868     unsigned int              num_contained_render_states;
1869     DWORD                     contained_transform_states[HIGHEST_TRANSFORMSTATE + 1];
1870     unsigned int              num_contained_transform_states;
1871     DWORD                     contained_vs_consts_i[MAX_CONST_I];
1872     unsigned int              num_contained_vs_consts_i;
1873     DWORD                     contained_vs_consts_b[MAX_CONST_B];
1874     unsigned int              num_contained_vs_consts_b;
1875     DWORD                     *contained_vs_consts_f;
1876     unsigned int              num_contained_vs_consts_f;
1877     DWORD                     contained_ps_consts_i[MAX_CONST_I];
1878     unsigned int              num_contained_ps_consts_i;
1879     DWORD                     contained_ps_consts_b[MAX_CONST_B];
1880     unsigned int              num_contained_ps_consts_b;
1881     DWORD                     *contained_ps_consts_f;
1882     unsigned int              num_contained_ps_consts_f;
1883     struct StageState         contained_tss_states[MAX_TEXTURES * (WINED3D_HIGHEST_TEXTURE_STATE + 1)];
1884     unsigned int              num_contained_tss_states;
1885     struct StageState         contained_sampler_states[MAX_COMBINED_SAMPLERS * WINED3D_HIGHEST_SAMPLER_STATE];
1886     unsigned int              num_contained_sampler_states;
1887 };
1888
1889 extern void stateblock_savedstates_set(
1890     IWineD3DStateBlock* iface,
1891     SAVEDSTATES* states,
1892     BOOL value);
1893
1894 extern void stateblock_copy(
1895     IWineD3DStateBlock* destination,
1896     IWineD3DStateBlock* source);
1897
1898 extern const IWineD3DStateBlockVtbl IWineD3DStateBlock_Vtbl;
1899
1900 /* Direct3D terminology with little modifications. We do not have an issued state
1901  * because only the driver knows about it, but we have a created state because d3d
1902  * allows GetData on a created issue, but opengl doesn't
1903  */
1904 enum query_state {
1905     QUERY_CREATED,
1906     QUERY_SIGNALLED,
1907     QUERY_BUILDING
1908 };
1909 /*****************************************************************************
1910  * IWineD3DQueryImpl implementation structure (extends IUnknown)
1911  */
1912 typedef struct IWineD3DQueryImpl
1913 {
1914     const IWineD3DQueryVtbl  *lpVtbl;
1915     LONG                      ref;     /* Note: Ref counting not required */
1916     
1917     IUnknown                 *parent;
1918     /*TODO: replace with iface usage */
1919 #if 0
1920     IWineD3DDevice         *wineD3DDevice;
1921 #else
1922     IWineD3DDeviceImpl       *wineD3DDevice;
1923 #endif
1924
1925     /* IWineD3DQuery fields */
1926     enum query_state         state;
1927     WINED3DQUERYTYPE         type;
1928     /* TODO: Think about using a IUnknown instead of a void* */
1929     void                     *extendedData;
1930     
1931   
1932 } IWineD3DQueryImpl;
1933
1934 extern const IWineD3DQueryVtbl IWineD3DQuery_Vtbl;
1935 extern const IWineD3DQueryVtbl IWineD3DEventQuery_Vtbl;
1936 extern const IWineD3DQueryVtbl IWineD3DOcclusionQuery_Vtbl;
1937
1938 /* Datastructures for IWineD3DQueryImpl.extendedData */
1939 typedef struct  WineQueryOcclusionData {
1940     GLuint  queryId;
1941     WineD3DContext *ctx;
1942 } WineQueryOcclusionData;
1943
1944 typedef struct  WineQueryEventData {
1945     GLuint  fenceId;
1946     WineD3DContext *ctx;
1947 } WineQueryEventData;
1948
1949 /*****************************************************************************
1950  * IWineD3DSwapChainImpl implementation structure (extends IUnknown)
1951  */
1952
1953 typedef struct IWineD3DSwapChainImpl
1954 {
1955     /*IUnknown part*/
1956     const IWineD3DSwapChainVtbl *lpVtbl;
1957     LONG                      ref;     /* Note: Ref counting not required */
1958
1959     IUnknown                 *parent;
1960     IWineD3DDeviceImpl       *wineD3DDevice;
1961
1962     /* IWineD3DSwapChain fields */
1963     IWineD3DSurface         **backBuffer;
1964     IWineD3DSurface          *frontBuffer;
1965     WINED3DPRESENT_PARAMETERS presentParms;
1966     DWORD                     orig_width, orig_height;
1967     WINED3DFORMAT             orig_fmt;
1968     WINED3DGAMMARAMP          orig_gamma;
1969
1970     long prev_time, frames;   /* Performance tracking */
1971     unsigned int vSyncCounter;
1972
1973     WineD3DContext        **context; /* Later a array for multithreading */
1974     unsigned int            num_contexts;
1975
1976     HWND                    win_handle;
1977 } IWineD3DSwapChainImpl;
1978
1979 extern const IWineD3DSwapChainVtbl IWineD3DSwapChain_Vtbl;
1980 const IWineD3DSwapChainVtbl IWineGDISwapChain_Vtbl;
1981 void x11_copy_to_screen(IWineD3DSwapChainImpl *This, const RECT *rc);
1982
1983 HRESULT WINAPI IWineD3DBaseSwapChainImpl_QueryInterface(IWineD3DSwapChain *iface, REFIID riid, LPVOID *ppobj);
1984 ULONG WINAPI IWineD3DBaseSwapChainImpl_AddRef(IWineD3DSwapChain *iface);
1985 ULONG WINAPI IWineD3DBaseSwapChainImpl_Release(IWineD3DSwapChain *iface);
1986 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetParent(IWineD3DSwapChain *iface, IUnknown ** ppParent);
1987 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetFrontBufferData(IWineD3DSwapChain *iface, IWineD3DSurface *pDestSurface);
1988 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetBackBuffer(IWineD3DSwapChain *iface, UINT iBackBuffer, WINED3DBACKBUFFER_TYPE Type, IWineD3DSurface **ppBackBuffer);
1989 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetRasterStatus(IWineD3DSwapChain *iface, WINED3DRASTER_STATUS *pRasterStatus);
1990 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetDisplayMode(IWineD3DSwapChain *iface, WINED3DDISPLAYMODE*pMode);
1991 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetDevice(IWineD3DSwapChain *iface, IWineD3DDevice**ppDevice);
1992 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetPresentParameters(IWineD3DSwapChain *iface, WINED3DPRESENT_PARAMETERS *pPresentationParameters);
1993 HRESULT WINAPI IWineD3DBaseSwapChainImpl_SetGammaRamp(IWineD3DSwapChain *iface, DWORD Flags, CONST WINED3DGAMMARAMP *pRamp);
1994 HRESULT WINAPI IWineD3DBaseSwapChainImpl_GetGammaRamp(IWineD3DSwapChain *iface, WINED3DGAMMARAMP *pRamp);
1995
1996 WineD3DContext *IWineD3DSwapChainImpl_CreateContextForThread(IWineD3DSwapChain *iface);
1997
1998 /*****************************************************************************
1999  * Utility function prototypes 
2000  */
2001
2002 /* Trace routines */
2003 const char* debug_d3dformat(WINED3DFORMAT fmt);
2004 const char* debug_d3ddevicetype(WINED3DDEVTYPE devtype);
2005 const char* debug_d3dresourcetype(WINED3DRESOURCETYPE res);
2006 const char* debug_d3dusage(DWORD usage);
2007 const char* debug_d3dusagequery(DWORD usagequery);
2008 const char* debug_d3ddeclmethod(WINED3DDECLMETHOD method);
2009 const char* debug_d3ddecltype(WINED3DDECLTYPE type);
2010 const char* debug_d3ddeclusage(BYTE usage);
2011 const char* debug_d3dprimitivetype(WINED3DPRIMITIVETYPE PrimitiveType);
2012 const char* debug_d3drenderstate(DWORD state);
2013 const char* debug_d3dsamplerstate(DWORD state);
2014 const char* debug_d3dtexturefiltertype(WINED3DTEXTUREFILTERTYPE filter_type);
2015 const char* debug_d3dtexturestate(DWORD state);
2016 const char* debug_d3dtstype(WINED3DTRANSFORMSTATETYPE tstype);
2017 const char* debug_d3dpool(WINED3DPOOL pool);
2018 const char *debug_fbostatus(GLenum status);
2019 const char *debug_glerror(GLenum error);
2020 const char *debug_d3dbasis(WINED3DBASISTYPE basis);
2021 const char *debug_d3ddegree(WINED3DDEGREETYPE order);
2022 const char* debug_d3dtop(WINED3DTEXTUREOP d3dtop);
2023 const char *debug_fixup_channel_source(enum fixup_channel_source source);
2024 const char *debug_yuv_fixup(enum yuv_fixup yuv_fixup);
2025 void dump_color_fixup_desc(struct color_fixup_desc fixup);
2026
2027 /* Routines for GL <-> D3D values */
2028 GLenum StencilOp(DWORD op);
2029 GLenum CompareFunc(DWORD func);
2030 BOOL is_invalid_op(IWineD3DDeviceImpl *This, int stage, WINED3DTEXTUREOP op, DWORD arg1, DWORD arg2, DWORD arg3);
2031 void   set_tex_op_nvrc(IWineD3DDevice *iface, BOOL is_alpha, int stage, WINED3DTEXTUREOP op, DWORD arg1, DWORD arg2, DWORD arg3, INT texture_idx, DWORD dst);
2032 void   set_texture_matrix(const float *smat, DWORD flags, BOOL calculatedCoords, BOOL transformed, DWORD coordtype, BOOL ffp_can_disable_proj);
2033 void texture_activate_dimensions(DWORD stage, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2034 void sampler_texdim(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2035 void tex_alphaop(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2036 void apply_pixelshader(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2037 void state_fogcolor(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2038 void state_fogdensity(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2039 void state_fogstartend(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2040 void state_fog_fragpart(DWORD state, IWineD3DStateBlockImpl *stateblock, WineD3DContext *context);
2041
2042 void surface_add_dirty_rect(IWineD3DSurface *iface, const RECT *dirty_rect);
2043 void surface_force_reload(IWineD3DSurface *iface);
2044 GLenum surface_get_gl_buffer(IWineD3DSurface *iface, IWineD3DSwapChain *swapchain);
2045 void surface_load_ds_location(IWineD3DSurface *iface, DWORD location);
2046 void surface_modify_ds_location(IWineD3DSurface *iface, DWORD location);
2047 void surface_set_compatible_renderbuffer(IWineD3DSurface *iface, unsigned int width, unsigned int height);
2048 void surface_set_texture_name(IWineD3DSurface *iface, GLuint name);
2049 void surface_set_texture_target(IWineD3DSurface *iface, GLenum target);
2050
2051 BOOL getColorBits(WINED3DFORMAT fmt, short *redSize, short *greenSize, short *blueSize, short *alphaSize, short *totalSize);
2052 BOOL getDepthStencilBits(WINED3DFORMAT fmt, short *depthSize, short *stencilSize);
2053
2054 /* Math utils */
2055 void multiply_matrix(WINED3DMATRIX *dest, const WINED3DMATRIX *src1, const WINED3DMATRIX *src2);
2056 unsigned int count_bits(unsigned int mask);
2057 UINT wined3d_log2i(UINT32 x);
2058
2059 /*****************************************************************************
2060  * To enable calling of inherited functions, requires prototypes 
2061  *
2062  * Note: Only require classes which are subclassed, ie resource, basetexture, 
2063  */
2064
2065     /* IWineD3DVertexBuffer */
2066     extern const BYTE *IWineD3DVertexBufferImpl_GetMemory(IWineD3DVertexBuffer* iface, DWORD iOffset, GLint *vbo);
2067
2068 /* TODO: Make this dynamic, based on shader limits ? */
2069 #define MAX_REG_ADDR 1
2070 #define MAX_REG_TEMP 32
2071 #define MAX_REG_TEXCRD 8
2072 #define MAX_REG_INPUT 12
2073 #define MAX_REG_OUTPUT 12
2074 #define MAX_CONST_I 16
2075 #define MAX_CONST_B 16
2076
2077 /* FIXME: This needs to go up to 2048 for
2078  * Shader model 3 according to msdn (and for software shaders) */
2079 #define MAX_LABELS 16
2080
2081 typedef struct semantic {
2082     DWORD usage;
2083     DWORD reg;
2084 } semantic;
2085
2086 typedef struct local_constant {
2087     struct list entry;
2088     unsigned int idx;
2089     DWORD value[4];
2090 } local_constant;
2091
2092 typedef struct shader_reg_maps {
2093     DWORD shader_version;
2094     char texcoord[MAX_REG_TEXCRD];          /* pixel < 3.0 */
2095     char temporary[MAX_REG_TEMP];           /* pixel, vertex */
2096     char address[MAX_REG_ADDR];             /* vertex */
2097     char packed_input[MAX_REG_INPUT];       /* pshader >= 3.0 */
2098     char packed_output[MAX_REG_OUTPUT];     /* vertex >= 3.0 */
2099     char attributes[MAX_ATTRIBS];           /* vertex */
2100     char labels[MAX_LABELS];                /* pixel, vertex */
2101     DWORD texcoord_mask[MAX_REG_TEXCRD];    /* vertex < 3.0 */
2102
2103     /* Sampler usage tokens 
2104      * Use 0 as default (bit 31 is always 1 on a valid token) */
2105     DWORD samplers[max(MAX_FRAGMENT_SAMPLERS, MAX_VERTEX_SAMPLERS)];
2106     BOOL bumpmat[MAX_TEXTURES], luminanceparams[MAX_TEXTURES];
2107     char usesnrm, vpos, usesdsy;
2108     char usesrelconstF;
2109
2110     /* Whether or not loops are used in this shader, and nesting depth */
2111     unsigned loop_depth;
2112
2113     /* Whether or not this shader uses fog */
2114     char fog;
2115
2116 } shader_reg_maps;
2117
2118 /* Undocumented opcode controls */
2119 #define INST_CONTROLS_SHIFT 16
2120 #define INST_CONTROLS_MASK 0x00ff0000
2121
2122 typedef enum COMPARISON_TYPE {
2123     COMPARISON_GT = 1,
2124     COMPARISON_EQ = 2,
2125     COMPARISON_GE = 3,
2126     COMPARISON_LT = 4,
2127     COMPARISON_NE = 5,
2128     COMPARISON_LE = 6
2129 } COMPARISON_TYPE;
2130
2131 typedef struct SHADER_OPCODE {
2132     unsigned int  opcode;
2133     const char*   name;
2134     char          dst_token;
2135     CONST UINT    num_params;
2136     enum WINED3D_SHADER_INSTRUCTION_HANDLER handler_idx;
2137     DWORD         min_version;
2138     DWORD         max_version;
2139 } SHADER_OPCODE;
2140
2141 typedef struct SHADER_OPCODE_ARG {
2142     IWineD3DBaseShader* shader;
2143     const shader_reg_maps *reg_maps;
2144     CONST SHADER_OPCODE* opcode;
2145     DWORD opcode_token;
2146     DWORD dst;
2147     DWORD dst_addr;
2148     DWORD predicate;
2149     DWORD src[4];
2150     DWORD src_addr[4];
2151     SHADER_BUFFER* buffer;
2152 } SHADER_OPCODE_ARG;
2153
2154 typedef struct SHADER_LIMITS {
2155     unsigned int temporary;
2156     unsigned int texcoord;
2157     unsigned int sampler;
2158     unsigned int constant_int;
2159     unsigned int constant_float;
2160     unsigned int constant_bool;
2161     unsigned int address;
2162     unsigned int packed_output;
2163     unsigned int packed_input;
2164     unsigned int attributes;
2165     unsigned int label;
2166 } SHADER_LIMITS;
2167
2168 /** Keeps track of details for TEX_M#x# shader opcodes which need to 
2169     maintain state information between multiple codes */
2170 typedef struct SHADER_PARSE_STATE {
2171     unsigned int current_row;
2172     DWORD texcoord_w[2];
2173 } SHADER_PARSE_STATE;
2174
2175 #ifdef __GNUC__
2176 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
2177 #else
2178 #define PRINTF_ATTR(fmt,args)
2179 #endif
2180
2181 /* Base Shader utility functions. 
2182  * (may move callers into the same file in the future) */
2183 extern int shader_addline(
2184     SHADER_BUFFER* buffer,
2185     const char* fmt, ...) PRINTF_ATTR(2,3);
2186
2187 const SHADER_OPCODE *shader_get_opcode(const SHADER_OPCODE *shader_ins, DWORD shader_version, DWORD code);
2188
2189 /* Vertex shader utility functions */
2190 extern BOOL vshader_get_input(
2191     IWineD3DVertexShader* iface,
2192     BYTE usage_req, BYTE usage_idx_req,
2193     unsigned int* regnum);
2194
2195 extern HRESULT allocate_shader_constants(IWineD3DStateBlockImpl* object);
2196
2197 /* GLSL helper functions */
2198 extern void shader_glsl_add_instruction_modifiers(const SHADER_OPCODE_ARG *arg);
2199
2200 /*****************************************************************************
2201  * IDirect3DBaseShader implementation structure
2202  */
2203 typedef struct IWineD3DBaseShaderClass
2204 {
2205     LONG                            ref;
2206     SHADER_LIMITS                   limits;
2207     SHADER_PARSE_STATE              parse_state;
2208     CONST SHADER_OPCODE             *shader_ins;
2209     DWORD                          *function;
2210     UINT                            functionLength;
2211     BOOL                            is_compiled;
2212     UINT                            cur_loop_depth, cur_loop_regno;
2213     BOOL                            load_local_constsF;
2214     BOOL                            uses_bool_consts, uses_int_consts;
2215
2216     /* Type of shader backend */
2217     int shader_mode;
2218
2219     /* Programs this shader is linked with */
2220     struct list linked_programs;
2221
2222     /* Immediate constants (override global ones) */
2223     struct list constantsB;
2224     struct list constantsF;
2225     struct list constantsI;
2226     shader_reg_maps reg_maps;
2227
2228     UINT                sampled_samplers[MAX_COMBINED_SAMPLERS];
2229     UINT                num_sampled_samplers;
2230
2231     UINT recompile_count;
2232
2233     /* Pointer to the parent device */
2234     IWineD3DDevice *device;
2235     struct list     shader_list_entry;
2236
2237 } IWineD3DBaseShaderClass;
2238
2239 typedef struct IWineD3DBaseShaderImpl {
2240     /* IUnknown */
2241     const IWineD3DBaseShaderVtbl    *lpVtbl;
2242
2243     /* IWineD3DBaseShader */
2244     IWineD3DBaseShaderClass         baseShader;
2245 } IWineD3DBaseShaderImpl;
2246
2247 void shader_buffer_init(struct SHADER_BUFFER *buffer);
2248 void shader_buffer_free(struct SHADER_BUFFER *buffer);
2249 void shader_cleanup(IWineD3DBaseShader *iface);
2250 HRESULT shader_get_registers_used(IWineD3DBaseShader *iface, struct shader_reg_maps *reg_maps,
2251         struct semantic *semantics_in, struct semantic *semantics_out, const DWORD *byte_code);
2252 void shader_init(struct IWineD3DBaseShaderClass *shader,
2253         IWineD3DDevice *device, const SHADER_OPCODE *instruction_table);
2254 void shader_trace_init(const DWORD *byte_code, const SHADER_OPCODE *opcode_table);
2255
2256 extern void shader_generate_main(IWineD3DBaseShader *iface, SHADER_BUFFER *buffer,
2257         const shader_reg_maps *reg_maps, const DWORD *pFunction);
2258
2259 static inline int shader_get_regtype(const DWORD param) {
2260     return (((param & WINED3DSP_REGTYPE_MASK) >> WINED3DSP_REGTYPE_SHIFT) |
2261             ((param & WINED3DSP_REGTYPE_MASK2) >> WINED3DSP_REGTYPE_SHIFT2));
2262 }
2263
2264 static inline int shader_get_writemask(const DWORD param) {
2265     return param & WINED3DSP_WRITEMASK_ALL;
2266 }
2267
2268 static inline BOOL shader_is_pshader_version(DWORD token) {
2269     return 0xFFFF0000 == (token & 0xFFFF0000);
2270 }
2271
2272 static inline BOOL shader_is_vshader_version(DWORD token) {
2273     return 0xFFFE0000 == (token & 0xFFFF0000);
2274 }
2275
2276 static inline BOOL shader_is_comment(DWORD token) {
2277     return WINED3DSIO_COMMENT == (token & WINED3DSI_OPCODE_MASK);
2278 }
2279
2280 static inline BOOL shader_is_scalar(DWORD param) {
2281     DWORD reg_type = shader_get_regtype(param);
2282     DWORD reg_num;
2283
2284     switch (reg_type) {
2285         case WINED3DSPR_RASTOUT:
2286             if ((param & WINED3DSP_REGNUM_MASK) != 0) {
2287                 /* oFog & oPts */
2288                 return TRUE;
2289             }
2290             /* oPos */
2291             return FALSE;
2292
2293         case WINED3DSPR_DEPTHOUT:   /* oDepth */
2294         case WINED3DSPR_CONSTBOOL:  /* b# */
2295         case WINED3DSPR_LOOP:       /* aL */
2296         case WINED3DSPR_PREDICATE:  /* p0 */
2297             return TRUE;
2298
2299         case WINED3DSPR_MISCTYPE:
2300             reg_num = param & WINED3DSP_REGNUM_MASK;
2301             switch(reg_num) {
2302                 case 0: /* vPos */
2303                     return FALSE;
2304                 case 1: /* vFace */
2305                     return TRUE;
2306                 default:
2307                     return FALSE;
2308             }
2309
2310         default:
2311             return FALSE;
2312     }
2313 }
2314
2315 static inline BOOL shader_constant_is_local(IWineD3DBaseShaderImpl* This, DWORD reg) {
2316     local_constant* lconst;
2317
2318     if(This->baseShader.load_local_constsF) return FALSE;
2319     LIST_FOR_EACH_ENTRY(lconst, &This->baseShader.constantsF, local_constant, entry) {
2320         if(lconst->idx == reg) return TRUE;
2321     }
2322     return FALSE;
2323
2324 }
2325
2326 /*****************************************************************************
2327  * IDirect3DVertexShader implementation structure
2328  */
2329 typedef struct IWineD3DVertexShaderImpl {
2330     /* IUnknown parts*/   
2331     const IWineD3DVertexShaderVtbl *lpVtbl;
2332
2333     /* IWineD3DBaseShader */
2334     IWineD3DBaseShaderClass     baseShader;
2335
2336     /* IWineD3DVertexShaderImpl */
2337     IUnknown                    *parent;
2338
2339     DWORD                       usage;
2340
2341     /* The GL shader */
2342     GLuint                          prgId;
2343
2344     /* Vertex shader input and output semantics */
2345     semantic semantics_in [MAX_ATTRIBS];
2346     semantic semantics_out [MAX_REG_OUTPUT];
2347
2348     WORD swizzle_map;   /* MAX_ATTRIBS, 16 */
2349
2350     UINT                       min_rel_offset, max_rel_offset;
2351     UINT                       rel_offset;
2352
2353     UINT                       recompile_count;
2354 } IWineD3DVertexShaderImpl;
2355 extern const SHADER_OPCODE IWineD3DVertexShaderImpl_shader_ins[];
2356 extern const IWineD3DVertexShaderVtbl IWineD3DVertexShader_Vtbl;
2357 HRESULT IWineD3DVertexShaderImpl_CompileShader(IWineD3DVertexShader *iface);
2358
2359 /*****************************************************************************
2360  * IDirect3DPixelShader implementation structure
2361  */
2362 struct ps_compiled_shader {
2363     struct ps_compile_args      args;
2364     GLuint                      prgId;
2365 };
2366
2367 typedef struct IWineD3DPixelShaderImpl {
2368     /* IUnknown parts */
2369     const IWineD3DPixelShaderVtbl *lpVtbl;
2370
2371     /* IWineD3DBaseShader */
2372     IWineD3DBaseShaderClass     baseShader;
2373
2374     /* IWineD3DPixelShaderImpl */
2375     IUnknown                   *parent;
2376
2377     /* Pixel shader input semantics */
2378     semantic semantics_in [MAX_REG_INPUT];
2379     DWORD                 input_reg_map[MAX_REG_INPUT];
2380     BOOL                  input_reg_used[MAX_REG_INPUT];
2381     int                         declared_in_count;
2382
2383     /* The GL shader */
2384     struct ps_compiled_shader   *gl_shaders;
2385     UINT                        num_gl_shaders, shader_array_size;
2386
2387     /* Some information about the shader behavior */
2388     struct stb_const_desc       bumpenvmatconst[MAX_TEXTURES];
2389     char                        numbumpenvmatconsts;
2390     struct stb_const_desc       luminanceconst[MAX_TEXTURES];
2391     char                        vpos_uniform;
2392 } IWineD3DPixelShaderImpl;
2393
2394 extern const SHADER_OPCODE IWineD3DPixelShaderImpl_shader_ins[];
2395 extern const IWineD3DPixelShaderVtbl IWineD3DPixelShader_Vtbl;
2396 GLuint find_gl_pshader(IWineD3DPixelShaderImpl *shader, const struct ps_compile_args *args);
2397 void find_ps_compile_args(IWineD3DPixelShaderImpl *shader, IWineD3DStateBlockImpl *stateblock, struct ps_compile_args *args);
2398
2399 /* sRGB correction constants */
2400 static const float srgb_cmp = 0.0031308;
2401 static const float srgb_mul_low = 12.92;
2402 static const float srgb_pow = 0.41666;
2403 static const float srgb_mul_high = 1.055;
2404 static const float srgb_sub_high = 0.055;
2405
2406 /*****************************************************************************
2407  * IWineD3DPalette implementation structure
2408  */
2409 struct IWineD3DPaletteImpl {
2410     /* IUnknown parts */
2411     const IWineD3DPaletteVtbl  *lpVtbl;
2412     LONG                       ref;
2413
2414     IUnknown                   *parent;
2415     IWineD3DDeviceImpl         *wineD3DDevice;
2416
2417     /* IWineD3DPalette */
2418     HPALETTE                   hpal;
2419     WORD                       palVersion;     /*|               */
2420     WORD                       palNumEntries;  /*|  LOGPALETTE   */
2421     PALETTEENTRY               palents[256];   /*|               */
2422     /* This is to store the palette in 'screen format' */
2423     int                        screen_palents[256];
2424     DWORD                      Flags;
2425 };
2426
2427 extern const IWineD3DPaletteVtbl IWineD3DPalette_Vtbl;
2428 DWORD IWineD3DPaletteImpl_Size(DWORD dwFlags);
2429
2430 /* DirectDraw utility functions */
2431 extern WINED3DFORMAT pixelformat_for_depth(DWORD depth);
2432
2433 /*****************************************************************************
2434  * Pixel format management
2435  */
2436
2437 struct GlPixelFormatDesc
2438 {
2439     GLint glInternal;
2440     GLint glGammaInternal;
2441     GLint rtInternal;
2442     GLint glFormat;
2443     GLint glType;
2444     unsigned int Flags;
2445     float heightscale;
2446     struct color_fixup_desc color_fixup;
2447 };
2448
2449 typedef struct {
2450     WINED3DFORMAT           format;
2451     DWORD                   alphaMask, redMask, greenMask, blueMask;
2452     UINT                    bpp;
2453     short                   depthSize, stencilSize;
2454     BOOL                    isFourcc;
2455 } StaticPixelFormatDesc;
2456
2457 const StaticPixelFormatDesc *getFormatDescEntry(WINED3DFORMAT fmt,
2458         const WineD3D_GL_Info *gl_info, const struct GlPixelFormatDesc **glDesc);
2459
2460 static inline BOOL use_vs(IWineD3DStateBlockImpl *stateblock)
2461 {
2462     return (stateblock->vertexShader
2463             && !stateblock->wineD3DDevice->strided_streams.position_transformed
2464             && stateblock->wineD3DDevice->vs_selected_mode != SHADER_NONE);
2465 }
2466
2467 static inline BOOL use_ps(IWineD3DStateBlockImpl *stateblock)
2468 {
2469     return (stateblock->pixelShader
2470             && stateblock->wineD3DDevice->ps_selected_mode != SHADER_NONE);
2471 }
2472
2473 void stretch_rect_fbo(IWineD3DDevice *iface, IWineD3DSurface *src_surface, WINED3DRECT *src_rect,
2474         IWineD3DSurface *dst_surface, WINED3DRECT *dst_rect, const WINED3DTEXTUREFILTERTYPE filter, BOOL flip);
2475 #endif