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