wined3d: Add empty texture stage states to the state table.
[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 "d3d9.h"
41 #include "d3d9types.h"
42 #include "wined3d_private_types.h"
43 #include "ddraw.h"
44 #include "wine/wined3d_interface.h"
45 #include "wine/wined3d_gl.h"
46 #include "wine/list.h"
47
48 /* Device caps */
49 #define MAX_PALETTES      256
50 #define MAX_STREAMS       16
51 #define MAX_TEXTURES      8
52 #define MAX_SAMPLERS      16
53 #define MAX_ACTIVE_LIGHTS 8
54 #define MAX_CLIPPLANES    WINED3DMAXUSERCLIPPLANES
55 #define MAX_LEVELS        256
56
57 #define MAX_CONST_I 16
58 #define MAX_CONST_B 16
59
60 /* Used for CreateStateBlock */
61 #define NUM_SAVEDPIXELSTATES_R     35
62 #define NUM_SAVEDPIXELSTATES_T     18
63 #define NUM_SAVEDPIXELSTATES_S     12
64 #define NUM_SAVEDVERTEXSTATES_R    31
65 #define NUM_SAVEDVERTEXSTATES_T    2
66 #define NUM_SAVEDVERTEXSTATES_S    1
67
68 extern const DWORD SavedPixelStates_R[NUM_SAVEDPIXELSTATES_R];
69 extern const DWORD SavedPixelStates_T[NUM_SAVEDPIXELSTATES_T];
70 extern const DWORD SavedPixelStates_S[NUM_SAVEDPIXELSTATES_S];
71 extern const DWORD SavedVertexStates_R[NUM_SAVEDVERTEXSTATES_R];
72 extern const DWORD SavedVertexStates_T[NUM_SAVEDVERTEXSTATES_T];
73 extern const DWORD SavedVertexStates_S[NUM_SAVEDVERTEXSTATES_S];
74
75 typedef enum _WINELOOKUP {
76     WINELOOKUP_WARPPARAM = 0,
77     WINELOOKUP_MAGFILTER = 1,
78     MAX_LOOKUPS          = 2
79 } WINELOOKUP;
80
81 extern int minLookup[MAX_LOOKUPS];
82 extern int maxLookup[MAX_LOOKUPS];
83 extern DWORD *stateLookup[MAX_LOOKUPS];
84
85 extern DWORD minMipLookup[WINED3DTEXF_ANISOTROPIC + 1][WINED3DTEXF_LINEAR + 1];
86
87 typedef struct _WINED3DGLTYPE {
88     int         d3dType;
89     GLint       size;
90     GLenum      glType;
91     GLboolean   normalized;
92     int         typesize;
93 } WINED3DGLTYPE;
94
95 /* NOTE: Make sure these are in the correct numerical order. (see /include/wined3d_types.h) */
96 static WINED3DGLTYPE const glTypeLookup[WINED3DDECLTYPE_UNUSED] = {
97                                   {WINED3DDECLTYPE_FLOAT1,    1, GL_FLOAT           , GL_FALSE ,sizeof(float)},
98                                   {WINED3DDECLTYPE_FLOAT2,    2, GL_FLOAT           , GL_FALSE ,sizeof(float)},
99                                   {WINED3DDECLTYPE_FLOAT3,    3, GL_FLOAT           , GL_FALSE ,sizeof(float)},
100                                   {WINED3DDECLTYPE_FLOAT4,    4, GL_FLOAT           , GL_FALSE ,sizeof(float)},
101                                   {WINED3DDECLTYPE_D3DCOLOR,  4, GL_UNSIGNED_BYTE   , GL_TRUE  ,sizeof(BYTE)},
102                                   {WINED3DDECLTYPE_UBYTE4,    4, GL_UNSIGNED_BYTE   , GL_FALSE ,sizeof(BYTE)},
103                                   {WINED3DDECLTYPE_SHORT2,    2, GL_SHORT           , GL_FALSE ,sizeof(short int)},
104                                   {WINED3DDECLTYPE_SHORT4,    4, GL_SHORT           , GL_FALSE ,sizeof(short int)},
105                                   {WINED3DDECLTYPE_UBYTE4N,   4, GL_UNSIGNED_BYTE   , GL_FALSE ,sizeof(BYTE)},
106                                   {WINED3DDECLTYPE_SHORT2N,   2, GL_SHORT           , GL_FALSE ,sizeof(short int)},
107                                   {WINED3DDECLTYPE_SHORT4N,   4, GL_SHORT           , GL_FALSE ,sizeof(short int)},
108                                   {WINED3DDECLTYPE_USHORT2N,  2, GL_UNSIGNED_SHORT  , GL_FALSE ,sizeof(short int)},
109                                   {WINED3DDECLTYPE_USHORT4N,  4, GL_UNSIGNED_SHORT  , GL_FALSE ,sizeof(short int)},
110                                   {WINED3DDECLTYPE_UDEC3,     3, GL_UNSIGNED_SHORT  , GL_FALSE ,sizeof(short int)},
111                                   {WINED3DDECLTYPE_DEC3N,     3, GL_SHORT           , GL_FALSE ,sizeof(short int)},
112                                   {WINED3DDECLTYPE_FLOAT16_2, 2, GL_FLOAT           , GL_FALSE ,sizeof(short int)},
113                                   {WINED3DDECLTYPE_FLOAT16_4, 4, GL_FLOAT           , GL_FALSE ,sizeof(short int)}};
114
115 #define WINED3D_ATR_TYPE(type)          glTypeLookup[type].d3dType
116 #define WINED3D_ATR_SIZE(type)          glTypeLookup[type].size
117 #define WINED3D_ATR_GLTYPE(type)        glTypeLookup[type].glType
118 #define WINED3D_ATR_NORMALIZED(type)    glTypeLookup[type].normalized
119 #define WINED3D_ATR_TYPESIZE(type)      glTypeLookup[type].typesize
120
121 /**
122  * Settings 
123  */
124 #define VS_NONE    0
125 #define VS_HW      1
126 #define VS_SW      2
127
128 #define PS_NONE    0
129 #define PS_HW      1
130
131 #define VBO_NONE   0
132 #define VBO_HW     1
133
134 #define NP2_NONE   0
135 #define NP2_REPACK 1
136 #define NP2_NATIVE 2
137
138 #define ORM_BACKBUFFER  0
139 #define ORM_PBUFFER     1
140 #define ORM_FBO         2
141
142 #define SHADER_SW   0
143 #define SHADER_ARB  1
144 #define SHADER_GLSL 2
145 #define SHADER_NONE 3
146
147 #define RTL_DISABLE   -1
148 #define RTL_AUTO       0
149 #define RTL_READDRAW   1
150 #define RTL_READTEX    2
151 #define RTL_TEXDRAW    3
152 #define RTL_TEXTEX     4
153
154 /* NOTE: When adding fields to this structure, make sure to update the default
155  * values in wined3d_main.c as well. */
156 typedef struct wined3d_settings_s {
157 /* vertex and pixel shader modes */
158   int vs_mode;
159   int ps_mode;
160   int vbo_mode;
161 /* Ideally, we don't want the user to have to request GLSL.  If the hardware supports GLSL,
162     we should use it.  However, until it's fully implemented, we'll leave it as a registry
163     setting for developers. */
164   BOOL glslRequested;
165 /* nonpower 2 function */
166   int nonpower2_mode;
167   int offscreen_rendering_mode;
168   int rendertargetlock_mode;
169 /* Memory tracking and object counting */
170   unsigned int emulated_textureram;
171 } wined3d_settings_t;
172
173 extern wined3d_settings_t wined3d_settings;
174
175 /* Shader backends */
176
177 typedef struct {
178     void (*shader_select)(IWineD3DDevice *iface, BOOL usePS, BOOL useVS);
179     void (*shader_select_depth_blt)(IWineD3DDevice *iface);
180     void (*shader_load_constants)(IWineD3DDevice *iface, char usePS, char useVS);
181     void (*shader_cleanup)(BOOL usePS, BOOL useVS);
182 } shader_backend_t;
183
184 extern const shader_backend_t glsl_shader_backend;
185 extern const shader_backend_t arb_program_shader_backend;
186 extern const shader_backend_t none_shader_backend;
187
188 /* X11 locking */
189
190 extern void (*wine_tsx11_lock_ptr)(void);
191 extern void (*wine_tsx11_unlock_ptr)(void);
192
193 /* As GLX relies on X, this is needed */
194 extern int num_lock;
195
196 #if 0
197 #define ENTER_GL() ++num_lock; if (num_lock > 1) FIXME("Recursive use of GL lock to: %d\n", num_lock); wine_tsx11_lock_ptr()
198 #define LEAVE_GL() if (num_lock != 1) FIXME("Recursive use of GL lock: %d\n", num_lock); --num_lock; wine_tsx11_unlock_ptr()
199 #else
200 #define ENTER_GL() wine_tsx11_lock_ptr()
201 #define LEAVE_GL() wine_tsx11_unlock_ptr()
202 #endif
203
204 /*****************************************************************************
205  * Defines
206  */
207
208 /* GL related defines */
209 /* ------------------ */
210 #define GL_SUPPORT(ExtName)           (GLINFO_LOCATION.supported[ExtName] != 0)
211 #define GL_LIMITS(ExtName)            (GLINFO_LOCATION.max_##ExtName)
212 #define GL_EXTCALL(FuncName)          (GLINFO_LOCATION.FuncName)
213 #define GL_VEND(_VendName)            (GLINFO_LOCATION.gl_vendor == VENDOR_##_VendName ? TRUE : FALSE)
214
215 #define D3DCOLOR_B_R(dw) (((dw) >> 16) & 0xFF)
216 #define D3DCOLOR_B_G(dw) (((dw) >>  8) & 0xFF)
217 #define D3DCOLOR_B_B(dw) (((dw) >>  0) & 0xFF)
218 #define D3DCOLOR_B_A(dw) (((dw) >> 24) & 0xFF)
219
220 #define D3DCOLOR_R(dw) (((float) (((dw) >> 16) & 0xFF)) / 255.0f)
221 #define D3DCOLOR_G(dw) (((float) (((dw) >>  8) & 0xFF)) / 255.0f)
222 #define D3DCOLOR_B(dw) (((float) (((dw) >>  0) & 0xFF)) / 255.0f)
223 #define D3DCOLOR_A(dw) (((float) (((dw) >> 24) & 0xFF)) / 255.0f)
224
225 #define D3DCOLORTOGLFLOAT4(dw, vec) \
226   (vec)[0] = D3DCOLOR_R(dw); \
227   (vec)[1] = D3DCOLOR_G(dw); \
228   (vec)[2] = D3DCOLOR_B(dw); \
229   (vec)[3] = D3DCOLOR_A(dw);
230
231 /* DirectX Device Limits */
232 /* --------------------- */
233 #define MAX_LEVELS  256  /* Maximum number of mipmap levels. Guessed at 256 */
234
235 #define MAX_STREAMS  16  /* Maximum possible streams - used for fixed size arrays
236                             See MaxStreams in MSDN under GetDeviceCaps */
237                          /* Maximum number of constants provided to the shaders */
238 #define HIGHEST_TRANSFORMSTATE 512 
239                          /* Highest value in WINED3DTRANSFORMSTATETYPE */
240 #define MAX_PALETTES      256
241
242 /* Checking of API calls */
243 /* --------------------- */
244 #define checkGLcall(A)                                          \
245 {                                                               \
246     GLint err = glGetError();                                   \
247     if (err == GL_NO_ERROR) {                                   \
248        TRACE("%s call ok %s / %d\n", A, __FILE__, __LINE__);    \
249                                                                 \
250     } else do {                                                 \
251        FIXME(">>>>>>>>>>>>>>>>> %x from %s @ %s / %d\n",        \
252                 err, A, __FILE__, __LINE__);                    \
253        err = glGetError();                                      \
254     } while (err != GL_NO_ERROR);                               \
255
256
257 /* Trace routines / diagnostics */
258 /* ---------------------------- */
259
260 /* Dump out a matrix and copy it */
261 #define conv_mat(mat,gl_mat)                                                                \
262 do {                                                                                        \
263     TRACE("%f %f %f %f\n", (mat)->u.s._11, (mat)->u.s._12, (mat)->u.s._13, (mat)->u.s._14); \
264     TRACE("%f %f %f %f\n", (mat)->u.s._21, (mat)->u.s._22, (mat)->u.s._23, (mat)->u.s._24); \
265     TRACE("%f %f %f %f\n", (mat)->u.s._31, (mat)->u.s._32, (mat)->u.s._33, (mat)->u.s._34); \
266     TRACE("%f %f %f %f\n", (mat)->u.s._41, (mat)->u.s._42, (mat)->u.s._43, (mat)->u.s._44); \
267     memcpy(gl_mat, (mat), 16 * sizeof(float));                                              \
268 } while (0)
269
270 /* Macro to dump out the current state of the light chain */
271 #define DUMP_LIGHT_CHAIN()                    \
272 {                                             \
273   PLIGHTINFOEL *el = This->stateBlock->lights;\
274   while (el) {                                \
275     TRACE("Light %p (glIndex %ld, d3dIndex %ld, enabled %d)\n", el, el->glIndex, el->OriginalIndex, el->lightEnabled);\
276     el = el->next;                            \
277   }                                           \
278 }
279
280 /* Trace vector and strided data information */
281 #define TRACE_VECTOR(name) TRACE( #name "=(%f, %f, %f, %f)\n", name.x, name.y, name.z, name.w);
282 #define TRACE_STRIDED(sd,name) TRACE( #name "=(data:%p, stride:%d, type:%d)\n", sd->u.s.name.lpData, sd->u.s.name.dwStride, sd->u.s.name.dwType);
283
284 /* Defines used for optimizations */
285
286 /*    Only reapply what is necessary */
287 #define REAPPLY_ALPHAOP  0x0001
288 #define REAPPLY_ALL      0xFFFF
289
290 /* Advance declaration of structures to satisfy compiler */
291 typedef struct IWineD3DStateBlockImpl IWineD3DStateBlockImpl;
292 typedef struct IWineD3DSurfaceImpl    IWineD3DSurfaceImpl;
293 typedef struct IWineD3DPaletteImpl    IWineD3DPaletteImpl;
294
295 /* Tracking */
296
297 /* TODO: Move some of this to the device */
298 long globalChangeGlRam(long glram);
299
300 /* Memory and object tracking */
301
302 /*Structure for holding information on all direct3d objects
303 useful for making sure tracking is ok and when release is called on a device!
304 and probably quite handy for debugging and dumping states out
305 */
306 typedef struct WineD3DGlobalStatistics {
307     int glsurfaceram; /* The aproximate amount of glTexture memory allocated for textures */
308 } WineD3DGlobalStatistics;
309
310 extern WineD3DGlobalStatistics* wineD3DGlobalStatistics;
311
312 /* Global variables */
313 extern const float identity[16];
314
315 /*****************************************************************************
316  * Compilable extra diagnostics
317  */
318
319 /* Trace information per-vertex: (extremely high amount of trace) */
320 #if 0 /* NOTE: Must be 0 in cvs */
321 # define VTRACE(A) TRACE A
322 #else 
323 # define VTRACE(A) 
324 #endif
325
326 /* Checking of per-vertex related GL calls */
327 /* --------------------- */
328 #define vcheckGLcall(A)                                         \
329 {                                                               \
330     GLint err = glGetError();                                   \
331     if (err == GL_NO_ERROR) {                                   \
332        VTRACE(("%s call ok %s / %d\n", A, __FILE__, __LINE__)); \
333                                                                 \
334     } else do {                                                 \
335        FIXME(">>>>>>>>>>>>>>>>> %x from %s @ %s / %d\n",        \
336                 err, A, __FILE__, __LINE__);                    \
337        err = glGetError();                                      \
338     } while (err != GL_NO_ERROR);                               \
339 }
340
341 /* TODO: Confirm each of these works when wined3d move completed */
342 #if 0 /* NOTE: Must be 0 in cvs */
343   /* To avoid having to get gigabytes of trace, the following can be compiled in, and at the start
344      of each frame, a check is made for the existence of C:\D3DTRACE, and if it exists d3d trace
345      is enabled, and if it doesn't exist it is disabled. */
346 # define FRAME_DEBUGGING
347   /*  Adding in the SINGLE_FRAME_DEBUGGING gives a trace of just what makes up a single frame, before
348       the file is deleted                                                                            */
349 # if 1 /* NOTE: Must be 1 in cvs, as this is mostly more useful than a trace from program start */
350 #  define SINGLE_FRAME_DEBUGGING
351 # endif  
352   /* The following, when enabled, lets you see the makeup of the frame, by drawprimitive calls.
353      It can only be enabled when FRAME_DEBUGGING is also enabled                               
354      The contents of the back buffer are written into /tmp/backbuffer_* after each primitive 
355      array is drawn.                                                                            */
356 # if 0 /* NOTE: Must be 0 in cvs, as this give a lot of ppm files when compiled in */                                                                                       
357 #  define SHOW_FRAME_MAKEUP 1
358 # endif  
359   /* The following, when enabled, lets you see the makeup of the all the textures used during each
360      of the drawprimitive calls. It can only be enabled when SHOW_FRAME_MAKEUP is also enabled.
361      The contents of the textures assigned to each stage are written into 
362      /tmp/texture_*_<Stage>.ppm after each primitive array is drawn.                            */
363 # if 0 /* NOTE: Must be 0 in cvs, as this give a lot of ppm files when compiled in */
364 #  define SHOW_TEXTURE_MAKEUP 0
365 # endif  
366 extern BOOL isOn;
367 extern BOOL isDumpingFrames;
368 extern LONG primCounter;
369 #endif
370
371 /*****************************************************************************
372  * Prototypes
373  */
374
375 /* Routine common to the draw primitive and draw indexed primitive routines */
376 void drawPrimitive(IWineD3DDevice *iface,
377                     int PrimitiveType,
378                     long NumPrimitives,
379                     /* for Indexed: */
380                     long  StartVertexIndex,
381                     UINT  numberOfVertices,
382                     long  StartIdx,
383                     short idxBytes,
384                     const void *idxData,
385                     int   minIndex,
386                     WineDirect3DVertexStridedData *DrawPrimStrideData);
387
388 void primitiveConvertToStridedData(IWineD3DDevice *iface, WineDirect3DVertexStridedData *strided, LONG BaseVertexIndex, BOOL *fixup);
389
390 void primitiveDeclarationConvertToStridedData(
391      IWineD3DDevice *iface,
392      BOOL useVertexShaderFunction,
393      WineDirect3DVertexStridedData *strided,
394      LONG BaseVertexIndex, 
395      BOOL *fixup);
396
397 void primitiveConvertFVFtoOffset(DWORD thisFVF,
398                                  DWORD stride,
399                                  BYTE *data,
400                                  WineDirect3DVertexStridedData *strided,
401                                  GLint streamVBO);
402
403 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
404
405 #define eps 1e-8
406
407 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
408     (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
409
410 /* Routines and structures related to state management */
411 typedef void (*APPLYSTATEFUNC)(DWORD state, IWineD3DStateBlockImpl *stateblock);
412
413 #define STATE_RENDER(a) (a)
414 #define STATE_IS_RENDER(a) ((a) >= STATE_RENDER(1) && (a) <= STATE_RENDER(WINEHIGHEST_RENDER_STATE))
415
416 #define STATE_TEXTURESTAGE(stage, num) (STATE_RENDER(WINEHIGHEST_RENDER_STATE) + (stage) * WINED3D_HIGHEST_TEXTURE_STATE + (num))
417 #define STATE_IS_TEXTURESTAGE(a) ((a) >= STATE_TEXTURESTAGE(0, 1) && (a) <= STATE_TEXTURESTAGE(MAX_TEXTURES - 1, WINED3D_HIGHEST_TEXTURE_STATE))
418
419 #define STATE_HIGHEST (STATE_TEXTURESTAGE(MAX_TEXTURES - 1, WINED3D_HIGHEST_TEXTURE_STATE))
420
421 struct StateEntry
422 {
423     DWORD           representative;
424     APPLYSTATEFUNC  apply;
425 };
426
427 /* Global state table */
428 extern const struct StateEntry StateTable[];
429
430 /* Routine to fill gl caps for swapchains and IWineD3D */
431 BOOL IWineD3DImpl_FillGLCaps(IWineD3D *iface, Display* display);
432
433 /* Macros for doing basic GPU detection based on opengl capabilities */
434 #define WINE_D3D6_CAPABLE(gl_info) (gl_info->supported[ARB_MULTITEXTURE])
435 #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])
436 #define WINE_D3D8_CAPABLE(gl_info) WINE_D3D7_CAPABLE(gl_info) && (gl_info->supported[ARB_MULTISAMPLE] && gl_info->supported[ARB_TEXTURE_BORDER_CLAMP])
437 #define WINE_D3D9_CAPABLE(gl_info) WINE_D3D8_CAPABLE(gl_info) && (gl_info->supported[ARB_FRAGMENT_PROGRAM] && gl_info->supported[ARB_VERTEX_SHADER])
438
439 /* Default callbacks for implicit object destruction */
440 extern ULONG WINAPI D3DCB_DefaultDestroySurface(IWineD3DSurface *pSurface);
441
442 extern ULONG WINAPI D3DCB_DefaultDestroyVolume(IWineD3DVolume *pSurface);
443
444 /*****************************************************************************
445  * Internal representation of a light
446  */
447 typedef struct PLIGHTINFOEL PLIGHTINFOEL;
448 struct PLIGHTINFOEL {
449     WINED3DLIGHT OriginalParms; /* Note D3D8LIGHT == D3D9LIGHT */
450     DWORD        OriginalIndex;
451     LONG         glIndex;
452     BOOL         lightEnabled;
453     BOOL         changed;
454     BOOL         enabledChanged;
455
456     /* Converted parms to speed up swapping lights */
457     float                         lightPosn[4];
458     float                         lightDirn[4];
459     float                         exponent;
460     float                         cutoff;
461
462     PLIGHTINFOEL *next;
463     PLIGHTINFOEL *prev;
464 };
465
466 /* The default light parameters */
467 extern const WINED3DLIGHT WINED3D_default_light;
468
469 /*****************************************************************************
470  * IWineD3D implementation structure
471  */
472 typedef struct IWineD3DImpl
473 {
474     /* IUnknown fields */
475     const IWineD3DVtbl     *lpVtbl;
476     LONG                    ref;     /* Note: Ref counting not required */
477
478     /* WineD3D Information */
479     IUnknown               *parent;
480     UINT                    dxVersion;
481
482     /* GL Information */
483     BOOL                    isGLInfoValid;
484     WineD3D_GL_Info         gl_info;
485 } IWineD3DImpl;
486
487 extern const IWineD3DVtbl IWineD3D_Vtbl;
488
489 /** Hacked out start of a context manager!! **/
490 typedef struct glContext {
491     int Width;
492     int Height;
493     int usedcount;
494     GLXContext context;
495
496     Drawable drawable;
497     IWineD3DSurface *pSurface;
498 #if 0 /* TODO: someway to represent the state of the context */
499     IWineD3DStateBlock *pStateBlock;
500 #endif
501 /* a few other things like format */
502 } glContext;
503
504 /* TODO: setup some flags in the regestry to enable, disable pbuffer support
505 (since it will break quite a few things until contexts are managed properly!) */
506 extern BOOL pbuffer_support;
507 /* allocate one pbuffer per surface */
508 extern BOOL pbuffer_per_surface;
509
510 /* Maximum number of contexts/pbuffers to keep in cache,
511 set to 100 because ATI's drivers don't support deleting pBuffers properly
512 this needs to be migrated to a list and some option availalbe for controle the cache size.
513 */
514 #define CONTEXT_CACHE 100
515
516 typedef struct ResourceList {
517     IWineD3DResource         *resource;
518     struct ResourceList      *next;
519 } ResourceList;
520
521 /* A helper function that dumps a resource list */
522 void dumpResources(ResourceList *resources);
523
524 /*****************************************************************************
525  * IWineD3DDevice implementation structure
526  */
527 typedef struct IWineD3DDeviceImpl
528 {
529     /* IUnknown fields      */
530     const IWineD3DDeviceVtbl *lpVtbl;
531     LONG                    ref;     /* Note: Ref counting not required */
532
533     /* WineD3D Information  */
534     IUnknown               *parent;
535     IWineD3D               *wineD3D;
536
537     /* X and GL Information */
538     GLint                   maxConcurrentLights;
539
540     /* Selected capabilities */
541     int vs_selected_mode;
542     int ps_selected_mode;
543     const shader_backend_t *shader_backend;
544
545     /* Optimization */
546     BOOL                    modelview_valid;
547     BOOL                    proj_valid;
548     BOOL                    view_ident;        /* true iff view matrix is identity                */
549     BOOL                    last_was_rhw;      /* true iff last draw_primitive was in xyzrhw mode */
550     BOOL                    viewport_changed;  /* Was the viewport changed since the last draw?   */
551     GLenum                  tracking_parm;     /* Which source is tracking current colour         */
552     LONG                    tracking_color;    /* used iff GL_COLOR_MATERIAL was enabled          */
553 #define                         DISABLED_TRACKING  0  /* Disabled                                 */
554 #define                         IS_TRACKING        1  /* tracking_parm is tracking diffuse color  */
555 #define                         NEEDS_TRACKING     2  /* Tracking needs to be enabled when needed */
556 #define                         NEEDS_DISABLE      3  /* Tracking needs to be disabled when needed*/
557     UINT                    srcBlend;
558     UINT                    dstBlend;
559     UINT                    alphafunc;
560     BOOL                    texture_shader_active;  /* TODO: Confirm use is correct */
561     BOOL                    last_was_notclipped;
562     BOOL                    untransformed;
563
564     /* State block related */
565     BOOL                    isRecordingState;
566     IWineD3DStateBlockImpl *stateBlock;
567     IWineD3DStateBlockImpl *updateStateBlock;
568
569     /* Internal use fields  */
570     WINED3DDEVICE_CREATION_PARAMETERS createParms;
571     UINT                            adapterNo;
572     WINED3DDEVTYPE                  devType;
573
574     IWineD3DSwapChain     **swapchains;
575     uint                    NumberOfSwapChains;
576
577     ResourceList           *resources; /* a linked list to track resources created by the device */
578
579     /* Render Target Support */
580     IWineD3DSurface       **render_targets;
581     IWineD3DSurface        *depthStencilBuffer;
582
583     IWineD3DSurface        *stencilBufferTarget;
584
585     /* palettes texture management */
586     PALETTEENTRY            palettes[MAX_PALETTES][256];
587     UINT                    currentPalette;
588
589     /* For rendering to a texture using glCopyTexImage */
590     BOOL                    render_offscreen;
591     WINED3D_DEPTHCOPYSTATE  depth_copy_state;
592     GLuint                  fbo;
593     GLenum                  *draw_buffers;
594
595     /* Cursor management */
596     BOOL                    bCursorVisible;
597     UINT                    xHotSpot;
598     UINT                    yHotSpot;
599     UINT                    xScreenSpace;
600     UINT                    yScreenSpace;
601     UINT                    cursorWidth, cursorHeight;
602     GLuint                  cursorTexture;
603
604     /* Textures for when no other textures are mapped */
605     UINT                          dummyTextureName[MAX_TEXTURES];
606
607     /* Debug stream management */
608     BOOL                     debug;
609
610     /* Device state management */
611     HRESULT                 state;
612     BOOL                    d3d_initialized;
613
614     /* Screen buffer resources */
615     glContext contextCache[CONTEXT_CACHE];
616
617     /* A flag to check if endscene has been called before changing the render tartet */
618     BOOL sceneEnded;
619
620     /* process vertex shaders using software or hardware */
621     BOOL softwareVertexProcessing;
622
623     /* DirectDraw stuff */
624     HWND ddraw_window;
625     IWineD3DSurface *ddraw_primary;
626     DWORD ddraw_width, ddraw_height;
627     WINED3DFORMAT ddraw_format;
628     BOOL ddraw_fullscreen;
629
630     /* List of GLSL shader programs and their associated vertex & pixel shaders */
631     struct list glsl_shader_progs;
632
633
634     /* Final position fixup constant */
635     float                       posFixup[4];
636
637     /* State dirtification
638      * dirtyArray is an array that contains markers for dirty states. numDirtyEntries states are dirty, their numbers are in indices
639      * 0...numDirtyEntries - 1. isStateDirty is a redundant copy of the dirtyArray. Technically only one of them would be needed,
640      * 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
641      * only numDirtyEntries array elements have to be checked, not STATE_HIGHEST states.
642      */
643     DWORD                   dirtyArray[STATE_HIGHEST + 1]; /* Won't get bigger than that, a state is never marked dirty 2 times */
644     DWORD                   numDirtyEntries;
645     DWORD                   isStateDirty[STATE_HIGHEST/32 + 1]; /* Bitmap to find out quickly if a state is dirty */
646
647 } IWineD3DDeviceImpl;
648
649 extern const IWineD3DDeviceVtbl IWineD3DDevice_Vtbl;
650
651 void IWineD3DDeviceImpl_MarkStateDirty(IWineD3DDeviceImpl *This, DWORD state);
652 static inline BOOL isStateDirty(IWineD3DDeviceImpl *This, DWORD state) {
653     DWORD idx = state >> 5;
654     BYTE shift = state & 0x1f;
655     return This->isStateDirty[idx] & (1 << shift);
656 }
657
658 /* Support for IWineD3DResource ::Set/Get/FreePrivateData. I don't think
659  * anybody uses it for much so a good implementation is optional. */
660 typedef struct PrivateData
661 {
662     struct PrivateData* next;
663
664     GUID tag;
665     DWORD flags; /* DDSPD_* */
666     DWORD uniqueness_value;
667
668     union
669     {
670         LPVOID data;
671         LPUNKNOWN object;
672     } ptr;
673
674     DWORD size;
675 } PrivateData;
676
677 void d3ddevice_set_ortho(IWineD3DDeviceImpl *This);
678
679 /*****************************************************************************
680  * IWineD3DResource implementation structure
681  */
682 typedef struct IWineD3DResourceClass
683 {
684     /* IUnknown fields */
685     LONG                    ref;     /* Note: Ref counting not required */
686
687     /* WineD3DResource Information */
688     IUnknown               *parent;
689     WINED3DRESOURCETYPE     resourceType;
690     IWineD3DDeviceImpl     *wineD3DDevice;
691     WINED3DPOOL             pool;
692     UINT                    size;
693     DWORD                   usage;
694     WINED3DFORMAT           format;
695     BYTE                   *allocatedMemory;
696     PrivateData            *privateData;
697
698 } IWineD3DResourceClass;
699
700 typedef struct IWineD3DResourceImpl
701 {
702     /* IUnknown & WineD3DResource Information     */
703     const IWineD3DResourceVtbl *lpVtbl;
704     IWineD3DResourceClass   resource;
705 } IWineD3DResourceImpl;
706
707
708 /*****************************************************************************
709  * IWineD3DVertexBuffer implementation structure (extends IWineD3DResourceImpl)
710  */
711 typedef struct IWineD3DVertexBufferImpl
712 {
713     /* IUnknown & WineD3DResource Information     */
714     const IWineD3DVertexBufferVtbl *lpVtbl;
715     IWineD3DResourceClass     resource;
716
717     /* WineD3DVertexBuffer specifics */
718     DWORD                     fvf;
719
720     /* Vertex buffer object support */
721     GLuint                    vbo;
722     BYTE                      Flags;
723     UINT                      stream;
724
725     UINT                      dirtystart, dirtyend;
726     LONG                      lockcount;
727
728     LONG                      declChanges, draws;
729     /* Last description of the buffer */
730     WineDirect3DVertexStridedData strided;
731 } IWineD3DVertexBufferImpl;
732
733 extern const IWineD3DVertexBufferVtbl IWineD3DVertexBuffer_Vtbl;
734
735 #define VBFLAG_LOAD           0x01    /* Data is written from allocatedMemory to the VBO */
736 #define VBFLAG_OPTIMIZED      0x02    /* Optimize has been called for the VB */
737 #define VBFLAG_DIRTY          0x04    /* Buffer data has been modified */
738 #define VBFLAG_STREAM         0x08    /* The vertex buffer is in a stream */
739 #define VBFLAG_HASDESC        0x10    /* A vertex description has been found */
740 #define VBFLAG_VBOCREATEFAIL  0x20    /* An attempt to create a vbo has failed */
741
742 /*****************************************************************************
743  * IWineD3DIndexBuffer implementation structure (extends IWineD3DResourceImpl)
744  */
745 typedef struct IWineD3DIndexBufferImpl
746 {
747     /* IUnknown & WineD3DResource Information     */
748     const IWineD3DIndexBufferVtbl *lpVtbl;
749     IWineD3DResourceClass     resource;
750
751     /* WineD3DVertexBuffer specifics */
752 } IWineD3DIndexBufferImpl;
753
754 extern const IWineD3DIndexBufferVtbl IWineD3DIndexBuffer_Vtbl;
755
756 /*****************************************************************************
757  * IWineD3DBaseTexture D3D- > openGL state map lookups
758  */
759 #define WINED3DFUNC_NOTSUPPORTED  -2
760 #define WINED3DFUNC_UNIMPLEMENTED -1
761
762 typedef enum winetexturestates {
763     WINED3DTEXSTA_ADDRESSU       = 0,
764     WINED3DTEXSTA_ADDRESSV       = 1,
765     WINED3DTEXSTA_ADDRESSW       = 2,
766     WINED3DTEXSTA_BORDERCOLOR    = 3,
767     WINED3DTEXSTA_MAGFILTER      = 4,
768     WINED3DTEXSTA_MINFILTER      = 5,
769     WINED3DTEXSTA_MIPFILTER      = 6,
770     WINED3DTEXSTA_MAXMIPLEVEL    = 7,
771     WINED3DTEXSTA_MAXANISOTROPY  = 8,
772     WINED3DTEXSTA_SRGBTEXTURE    = 9,
773     WINED3DTEXSTA_ELEMENTINDEX   = 10,
774     WINED3DTEXSTA_DMAPOFFSET     = 11,
775     WINED3DTEXSTA_TSSADDRESSW    = 12,
776     MAX_WINETEXTURESTATES        = 13,
777 } winetexturestates;
778
779 typedef struct Wined3dTextureStateMap {
780     CONST int state;
781     int function;
782 } Wined3dTextureStateMap;
783
784 /*****************************************************************************
785  * IWineD3DBaseTexture implementation structure (extends IWineD3DResourceImpl)
786  */
787 typedef struct IWineD3DBaseTextureClass
788 {
789     UINT                    levels;
790     BOOL                    dirty;
791     WINED3DFORMAT           format;
792     DWORD                   usage;
793     UINT                    textureName;
794     UINT                    LOD;
795     WINED3DTEXTUREFILTERTYPE filterType;
796     DWORD                   states[MAX_WINETEXTURESTATES];
797
798 } IWineD3DBaseTextureClass;
799
800 typedef struct IWineD3DBaseTextureImpl
801 {
802     /* IUnknown & WineD3DResource Information     */
803     const IWineD3DBaseTextureVtbl *lpVtbl;
804     IWineD3DResourceClass     resource;
805     IWineD3DBaseTextureClass  baseTexture;
806
807 } IWineD3DBaseTextureImpl;
808
809 /*****************************************************************************
810  * IWineD3DTexture implementation structure (extends IWineD3DBaseTextureImpl)
811  */
812 typedef struct IWineD3DTextureImpl
813 {
814     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
815     const IWineD3DTextureVtbl *lpVtbl;
816     IWineD3DResourceClass     resource;
817     IWineD3DBaseTextureClass  baseTexture;
818
819     /* IWineD3DTexture */
820     IWineD3DSurface          *surfaces[MAX_LEVELS];
821     
822     UINT                      width;
823     UINT                      height;
824     float                     pow2scalingFactorX;
825     float                     pow2scalingFactorY;
826
827 } IWineD3DTextureImpl;
828
829 extern const IWineD3DTextureVtbl IWineD3DTexture_Vtbl;
830
831 /*****************************************************************************
832  * IWineD3DCubeTexture implementation structure (extends IWineD3DBaseTextureImpl)
833  */
834 typedef struct IWineD3DCubeTextureImpl
835 {
836     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
837     const IWineD3DCubeTextureVtbl *lpVtbl;
838     IWineD3DResourceClass     resource;
839     IWineD3DBaseTextureClass  baseTexture;
840
841     /* IWineD3DCubeTexture */
842     IWineD3DSurface          *surfaces[6][MAX_LEVELS];
843
844     UINT                      edgeLength;
845     float                     pow2scalingFactor;
846
847 } IWineD3DCubeTextureImpl;
848
849 extern const IWineD3DCubeTextureVtbl IWineD3DCubeTexture_Vtbl;
850
851 typedef struct _WINED3DVOLUMET_DESC
852 {
853     UINT                    Width;
854     UINT                    Height;
855     UINT                    Depth;
856 } WINED3DVOLUMET_DESC;
857
858 /*****************************************************************************
859  * IWineD3DVolume implementation structure (extends IUnknown)
860  */
861 typedef struct IWineD3DVolumeImpl
862 {
863     /* IUnknown & WineD3DResource fields */
864     const IWineD3DVolumeVtbl  *lpVtbl;
865     IWineD3DResourceClass      resource;
866
867     /* WineD3DVolume Information */
868     WINED3DVOLUMET_DESC      currentDesc;
869     IWineD3DBase            *container;
870     UINT                    bytesPerPixel;
871
872     BOOL                    lockable;
873     BOOL                    locked;
874     WINED3DBOX              lockedBox;
875     WINED3DBOX              dirtyBox;
876     BOOL                    dirty;
877
878
879 } IWineD3DVolumeImpl;
880
881 extern const IWineD3DVolumeVtbl IWineD3DVolume_Vtbl;
882
883 /*****************************************************************************
884  * IWineD3DVolumeTexture implementation structure (extends IWineD3DBaseTextureImpl)
885  */
886 typedef struct IWineD3DVolumeTextureImpl
887 {
888     /* IUnknown & WineD3DResource/WineD3DBaseTexture Information     */
889     const IWineD3DVolumeTextureVtbl *lpVtbl;
890     IWineD3DResourceClass     resource;
891     IWineD3DBaseTextureClass  baseTexture;
892
893     /* IWineD3DVolumeTexture */
894     IWineD3DVolume           *volumes[MAX_LEVELS];
895
896     UINT                      width;
897     UINT                      height;
898     UINT                      depth;
899 } IWineD3DVolumeTextureImpl;
900
901 extern const IWineD3DVolumeTextureVtbl IWineD3DVolumeTexture_Vtbl;
902
903 typedef struct _WINED3DSURFACET_DESC
904 {
905     WINED3DMULTISAMPLE_TYPE MultiSampleType;
906     DWORD                   MultiSampleQuality;
907     UINT                    Width;
908     UINT                    Height;
909 } WINED3DSURFACET_DESC;
910
911 /*****************************************************************************
912  * Structure for DIB Surfaces (GetDC and GDI surfaces)
913  */
914 typedef struct wineD3DSurface_DIB {
915     HBITMAP DIBsection;
916     void* bitmap_data;
917     HGDIOBJ holdbitmap;
918     BOOL client_memory;
919 } wineD3DSurface_DIB;
920
921 /*****************************************************************************
922  * IWineD3DSurface implementation structure
923  */
924 struct IWineD3DSurfaceImpl
925 {
926     /* IUnknown & IWineD3DResource Information     */
927     const IWineD3DSurfaceVtbl *lpVtbl;
928     IWineD3DResourceClass     resource;
929
930     /* IWineD3DSurface fields */
931     IWineD3DBase              *container;
932     WINED3DSURFACET_DESC      currentDesc;
933     IWineD3DPaletteImpl      *palette;
934
935     UINT                      bytesPerPixel;
936
937     /* TODO: move this off into a management class(maybe!) */
938     DWORD                      Flags;
939
940     UINT                      pow2Width;
941     UINT                      pow2Height;
942     UINT                      pow2Size;
943
944     /* Oversized texture */
945     RECT                      glRect;
946
947 #if 0
948     /* precalculated x and y scalings for texture coords */
949     float                     pow2scalingFactorX; /* =  (Width  / pow2Width ) */
950     float                     pow2scalingFactorY; /* =  (Height / pow2Height) */
951 #endif
952
953     RECT                      lockedRect;
954     RECT                      dirtyRect;
955
956     glDescriptor              glDescription;
957
958     /* For GetDC */
959     wineD3DSurface_DIB        dib;
960     HDC                       hDC;
961
962     /* Color keys for DDraw */
963     DDCOLORKEY                DestBltCKey;
964     DDCOLORKEY                DestOverlayCKey;
965     DDCOLORKEY                SrcOverlayCKey;
966     DDCOLORKEY                SrcBltCKey;
967     DWORD                     CKeyFlags;
968
969     DDCOLORKEY                glCKey;
970 };
971
972 extern const IWineD3DSurfaceVtbl IWineD3DSurface_Vtbl;
973 extern const IWineD3DSurfaceVtbl IWineGDISurface_Vtbl;
974
975 /* Predeclare the shared Surface functions */
976 HRESULT WINAPI IWineD3DSurfaceImpl_QueryInterface(IWineD3DSurface *iface, REFIID riid, LPVOID *ppobj);
977 ULONG WINAPI IWineD3DSurfaceImpl_AddRef(IWineD3DSurface *iface);
978 ULONG WINAPI IWineD3DSurfaceImpl_Release(IWineD3DSurface *iface);
979 HRESULT WINAPI IWineD3DSurfaceImpl_GetParent(IWineD3DSurface *iface, IUnknown **pParent);
980 HRESULT WINAPI IWineD3DSurfaceImpl_GetDevice(IWineD3DSurface *iface, IWineD3DDevice** ppDevice);
981 HRESULT WINAPI IWineD3DSurfaceImpl_SetPrivateData(IWineD3DSurface *iface, REFGUID refguid, CONST void* pData, DWORD SizeOfData, DWORD Flags);
982 HRESULT WINAPI IWineD3DSurfaceImpl_GetPrivateData(IWineD3DSurface *iface, REFGUID refguid, void* pData, DWORD* pSizeOfData);
983 HRESULT WINAPI IWineD3DSurfaceImpl_FreePrivateData(IWineD3DSurface *iface, REFGUID refguid);
984 DWORD   WINAPI IWineD3DSurfaceImpl_SetPriority(IWineD3DSurface *iface, DWORD PriorityNew);
985 DWORD   WINAPI IWineD3DSurfaceImpl_GetPriority(IWineD3DSurface *iface);
986 void    WINAPI IWineD3DSurfaceImpl_PreLoad(IWineD3DSurface *iface);
987 WINED3DRESOURCETYPE WINAPI IWineD3DSurfaceImpl_GetType(IWineD3DSurface *iface);
988 HRESULT WINAPI IWineD3DSurfaceImpl_GetContainer(IWineD3DSurface* iface, REFIID riid, void** ppContainer);
989 HRESULT WINAPI IWineD3DSurfaceImpl_GetDesc(IWineD3DSurface *iface, WINED3DSURFACE_DESC *pDesc);
990 HRESULT WINAPI IWineD3DSurfaceImpl_GetBltStatus(IWineD3DSurface *iface, DWORD Flags);
991 HRESULT WINAPI IWineD3DSurfaceImpl_GetFlipStatus(IWineD3DSurface *iface, DWORD Flags);
992 HRESULT WINAPI IWineD3DSurfaceImpl_IsLost(IWineD3DSurface *iface);
993 HRESULT WINAPI IWineD3DSurfaceImpl_Restore(IWineD3DSurface *iface);
994 HRESULT WINAPI IWineD3DSurfaceImpl_SetPixelFormat(IWineD3DSurface *iface, WINED3DFORMAT Format, BYTE *Surface, DWORD Size);
995 HRESULT WINAPI IWineD3DSurfaceImpl_GetPalette(IWineD3DSurface *iface, IWineD3DPalette **Pal);
996 HRESULT WINAPI IWineD3DSurfaceImpl_SetPalette(IWineD3DSurface *iface, IWineD3DPalette *Pal);
997 HRESULT WINAPI IWineD3DSurfaceImpl_SetColorKey(IWineD3DSurface *iface, DWORD Flags, DDCOLORKEY *CKey);
998 HRESULT WINAPI IWineD3DSurfaceImpl_CleanDirtyRect(IWineD3DSurface *iface);
999 extern HRESULT WINAPI IWineD3DSurfaceImpl_AddDirtyRect(IWineD3DSurface *iface, CONST RECT* pDirtyRect);
1000 HRESULT WINAPI IWineD3DSurfaceImpl_SetContainer(IWineD3DSurface *iface, IWineD3DBase *container);
1001 HRESULT WINAPI IWineD3DSurfaceImpl_SetPBufferState(IWineD3DSurface *iface, BOOL inPBuffer, BOOL  inTexture);
1002 void WINAPI IWineD3DSurfaceImpl_SetGlTextureDesc(IWineD3DSurface *iface, UINT textureName, int target);
1003 void WINAPI IWineD3DSurfaceImpl_GetGlDesc(IWineD3DSurface *iface, glDescriptor **glDescription);
1004 const void *WINAPI IWineD3DSurfaceImpl_GetData(IWineD3DSurface *iface);
1005 HRESULT WINAPI IWineD3DSurfaceImpl_SetFormat(IWineD3DSurface *iface, WINED3DFORMAT format);
1006 HRESULT WINAPI IWineGDISurfaceImpl_Blt(IWineD3DSurface *iface, RECT *DestRect, IWineD3DSurface *SrcSurface, RECT *SrcRect, DWORD Flags, DDBLTFX *DDBltFx);
1007 HRESULT WINAPI IWineGDISurfaceImpl_BltFast(IWineD3DSurface *iface, DWORD dstx, DWORD dsty, IWineD3DSurface *Source, RECT *rsrc, DWORD trans);
1008 HRESULT WINAPI IWineD3DSurfaceImpl_SetPalette(IWineD3DSurface *iface, IWineD3DPalette *Pal);
1009 HRESULT WINAPI IWineD3DSurfaceImpl_GetDC(IWineD3DSurface *iface, HDC *pHDC);
1010 HRESULT WINAPI IWineD3DSurfaceImpl_ReleaseDC(IWineD3DSurface *iface, HDC hDC);
1011 DWORD WINAPI IWineD3DSurfaceImpl_GetPitch(IWineD3DSurface *iface);
1012 HRESULT WINAPI IWineD3DSurfaceImpl_RealizePalette(IWineD3DSurface *iface);
1013 HRESULT WINAPI IWineD3DSurfaceImpl_SetMem(IWineD3DSurface *iface, void *Mem);
1014 HRESULT WINAPI IWineD3DSurfaceImpl_SetOverlayPosition(IWineD3DSurface *iface, LONG X, LONG Y);
1015 HRESULT WINAPI IWineD3DSurfaceImpl_GetOverlayPosition(IWineD3DSurface *iface, LONG *X, LONG *Y);
1016 HRESULT WINAPI IWineD3DSurfaceImpl_UpdateOverlayZOrder(IWineD3DSurface *iface, DWORD Flags, IWineD3DSurface *Ref);
1017 HRESULT WINAPI IWineD3DSurfaceImpl_UpdateOverlay(IWineD3DSurface *iface, RECT *SrcRect, IWineD3DSurface *DstSurface, RECT *DstRect, DWORD Flags, WINEDDOVERLAYFX *FX);
1018
1019 /* Surface flags: */
1020 #define SFLAG_OVERSIZE    0x00000001 /* Surface is bigger than gl size, blts only */
1021 #define SFLAG_CONVERTED   0x00000002 /* Converted for color keying or Palettized */
1022 #define SFLAG_DIBSECTION  0x00000004 /* Has a DIB section attached for getdc */
1023 #define SFLAG_DIRTY       0x00000008 /* Surface was locked by the app */
1024 #define SFLAG_LOCKABLE    0x00000010 /* Surface can be locked */
1025 #define SFLAG_DISCARD     0x00000020 /* ??? */
1026 #define SFLAG_LOCKED      0x00000040 /* Surface is locked atm */
1027 #define SFLAG_ACTIVELOCK  0x00000080 /* Not locked, but surface memory is needed */
1028 #define SFLAG_INTEXTURE   0x00000100 /* ??? */
1029 #define SFLAG_INPBUFFER   0x00000200 /* ??? */
1030 #define SFLAG_NONPOW2     0x00000400 /* Surface sizes are not a power of 2 */
1031 #define SFLAG_DYNLOCK     0x00000800 /* Surface is often locked by the app */
1032 #define SFLAG_DYNCHANGE   0x00001800 /* Surface contents are changed very often, implies DYNLOCK */
1033 #define SFLAG_DCINUSE     0x00002000 /* Set between GetDC and ReleaseDC calls */
1034 #define SFLAG_GLDIRTY     0x00004000 /* The opengl texture is more up to date than the surface mem */
1035 #define SFLAG_LOST        0x00008000 /* Surface lost flag for DDraw */
1036 #define SFLAG_FORCELOAD   0x00010000 /* To force PreLoading of a scratch cursor */
1037 #define SFLAG_USERPTR     0x00020000 /* The application allocated the memory for this surface */
1038 #define SFLAG_GLCKEY      0x00040000 /* The gl texture was created with a color key */
1039
1040 /* In some conditions the surface memory must not be freed:
1041  * SFLAG_OVERSIZE: Not all data can be kept in GL
1042  * SFLAG_CONVERTED: Converting the data back would take too long
1043  * SFLAG_DIBSECTION: The dib code manages the memory
1044  * SFLAG_DIRTY: GL surface isn't up to date
1045  * SFLAG_LOCKED: The app requires access to the surface data
1046  * SFLAG_ACTIVELOCK: Some wined3d code needs the memory
1047  * SFLAG_DYNLOCK: Avoid freeing the data for performance
1048  * SFLAG_DYNCHANGE: Same reason as DYNLOCK
1049  */
1050 #define SFLAG_DONOTFREE  (SFLAG_OVERSIZE   | \
1051                           SFLAG_CONVERTED  | \
1052                           SFLAG_DIBSECTION | \
1053                           SFLAG_DIRTY      | \
1054                           SFLAG_LOCKED     | \
1055                           SFLAG_ACTIVELOCK | \
1056                           SFLAG_DYNLOCK    | \
1057                           SFLAG_DYNCHANGE  | \
1058                           SFLAG_USERPTR)
1059
1060 BOOL CalculateTexRect(IWineD3DSurfaceImpl *This, RECT *Rect, float glTexCoord[4]);
1061
1062 /* Alignment of the pitch */
1063 #define SURFACE_ALIGNMENT 4
1064
1065 /*****************************************************************************
1066  * IWineD3DVertexDeclaration implementation structure
1067  */
1068 typedef struct IWineD3DVertexDeclarationImpl {
1069  /* IUnknown  Information     */
1070   const IWineD3DVertexDeclarationVtbl *lpVtbl;
1071   LONG                    ref;     /* Note: Ref counting not required */
1072
1073   IUnknown               *parent;
1074   /** precomputed fvf if simple declaration */
1075   IWineD3DDeviceImpl     *wineD3DDevice;
1076   DWORD   fvf[MAX_STREAMS];
1077   DWORD   allFVF;
1078
1079   /** dx8 compatible Declaration fields */
1080   DWORD*  pDeclaration8;
1081   DWORD   declaration8Length;
1082
1083   /** dx9+ */
1084   D3DVERTEXELEMENT9 *pDeclaration9;
1085   UINT               declaration9NumElements;
1086
1087   WINED3DVERTEXELEMENT  *pDeclarationWine;
1088   UINT                   declarationWNumElements;
1089   
1090   float                 *constants;
1091   
1092 } IWineD3DVertexDeclarationImpl;
1093
1094 extern const IWineD3DVertexDeclarationVtbl IWineD3DVertexDeclaration_Vtbl;
1095
1096 /*****************************************************************************
1097  * IWineD3DStateBlock implementation structure
1098  */
1099
1100 /* Internal state Block for Begin/End/Capture/Create/Apply info  */
1101 /*   Note: Very long winded but gl Lists are not flexible enough */
1102 /*   to resolve everything we need, so doing it manually for now */
1103 typedef struct SAVEDSTATES {
1104         BOOL                      indices;
1105         BOOL                      material;
1106         BOOL                      fvf;
1107         BOOL                      streamSource[MAX_STREAMS];
1108         BOOL                      streamFreq[MAX_STREAMS];
1109         BOOL                      textures[MAX_SAMPLERS];
1110         BOOL                      transform[HIGHEST_TRANSFORMSTATE + 1];
1111         BOOL                      viewport;
1112         BOOL                      renderState[WINEHIGHEST_RENDER_STATE + 1];
1113         BOOL                      textureState[MAX_TEXTURES][WINED3D_HIGHEST_TEXTURE_STATE + 1];
1114         BOOL                      samplerState[MAX_SAMPLERS][WINED3D_HIGHEST_SAMPLER_STATE + 1];
1115         BOOL                      clipplane[MAX_CLIPPLANES];
1116         BOOL                      vertexDecl;
1117         BOOL                      pixelShader;
1118         BOOL                      pixelShaderConstantsB[MAX_CONST_B];
1119         BOOL                      pixelShaderConstantsI[MAX_CONST_I];
1120         BOOL                     *pixelShaderConstantsF;
1121         BOOL                      vertexShader;
1122         BOOL                      vertexShaderConstantsB[MAX_CONST_B];
1123         BOOL                      vertexShaderConstantsI[MAX_CONST_I];
1124         BOOL                     *vertexShaderConstantsF;
1125 } SAVEDSTATES;
1126
1127 typedef struct {
1128     struct list entry;
1129     int idx;
1130 } constant_entry;
1131
1132 struct IWineD3DStateBlockImpl
1133 {
1134     /* IUnknown fields */
1135     const IWineD3DStateBlockVtbl *lpVtbl;
1136     LONG                      ref;     /* Note: Ref counting not required */
1137
1138     /* IWineD3DStateBlock information */
1139     IUnknown                 *parent;
1140     IWineD3DDeviceImpl       *wineD3DDevice;
1141     WINED3DSTATEBLOCKTYPE     blockType;
1142
1143     /* Array indicating whether things have been set or changed */
1144     SAVEDSTATES               changed;
1145     SAVEDSTATES               set;
1146     struct list               set_vconstantsF;
1147     struct list               set_pconstantsF;
1148
1149     /* Drawing - Vertex Shader or FVF related */
1150     DWORD                     fvf;
1151     /* Vertex Shader Declaration */
1152     IWineD3DVertexDeclaration *vertexDecl;
1153
1154     IWineD3DVertexShader      *vertexShader;
1155
1156     /* Vertex Shader Constants */
1157     BOOL                       vertexShaderConstantB[MAX_CONST_B];
1158     INT                        vertexShaderConstantI[MAX_CONST_I * 4];
1159     float                     *vertexShaderConstantF;
1160
1161     /* Stream Source */
1162     BOOL                      streamIsUP;
1163     UINT                      streamStride[MAX_STREAMS];
1164     UINT                      streamOffset[MAX_STREAMS];
1165     IWineD3DVertexBuffer     *streamSource[MAX_STREAMS];
1166     UINT                      streamFreq[MAX_STREAMS];
1167     UINT                      streamFlags[MAX_STREAMS];     /*0 | WINED3DSTREAMSOURCE_INSTANCEDATA | WINED3DSTREAMSOURCE_INDEXEDDATA  */
1168
1169     /* Indices */
1170     IWineD3DIndexBuffer*      pIndexData;
1171     UINT                      baseVertexIndex; /* Note: only used for d3d8 */
1172
1173     /* Transform */
1174     WINED3DMATRIX             transforms[HIGHEST_TRANSFORMSTATE + 1];
1175
1176     /* Lights */
1177     PLIGHTINFOEL             *lights; /* NOTE: active GL lights must be front of the chain */
1178
1179     /* Clipping */
1180     double                    clipplane[MAX_CLIPPLANES][4];
1181     WINED3DCLIPSTATUS         clip_status;
1182
1183     /* ViewPort */
1184     WINED3DVIEWPORT           viewport;
1185
1186     /* Material */
1187     WINED3DMATERIAL           material;
1188
1189     /* Pixel Shader */
1190     IWineD3DPixelShader      *pixelShader;
1191
1192     /* Pixel Shader Constants */
1193     BOOL                       pixelShaderConstantB[MAX_CONST_B];
1194     INT                        pixelShaderConstantI[MAX_CONST_I * 4];
1195     float                     *pixelShaderConstantF;
1196
1197     /* RenderState */
1198     DWORD                     renderState[WINEHIGHEST_RENDER_STATE + 1];
1199
1200     /* Texture */
1201     IWineD3DBaseTexture      *textures[MAX_SAMPLERS];
1202     int                       textureDimensions[MAX_SAMPLERS];
1203
1204     /* Texture State Stage */
1205     DWORD                     textureState[MAX_TEXTURES][WINED3D_HIGHEST_TEXTURE_STATE + 1];
1206     /* Sampler States */
1207     DWORD                     samplerState[MAX_SAMPLERS][WINED3D_HIGHEST_SAMPLER_STATE + 1];
1208
1209     /* Current GLSL Shader Program */
1210     struct glsl_shader_prog_link *glsl_program;
1211 };
1212
1213 extern void stateblock_savedstates_set(
1214     IWineD3DStateBlock* iface,
1215     SAVEDSTATES* states,
1216     BOOL value);
1217
1218 extern void stateblock_savedstates_copy(
1219     IWineD3DStateBlock* iface,
1220     SAVEDSTATES* dest,
1221     SAVEDSTATES* source);
1222
1223 extern void stateblock_copy(
1224     IWineD3DStateBlock* destination,
1225     IWineD3DStateBlock* source);
1226
1227 extern const IWineD3DStateBlockVtbl IWineD3DStateBlock_Vtbl;
1228
1229 /*****************************************************************************
1230  * IWineD3DQueryImpl implementation structure (extends IUnknown)
1231  */
1232 typedef struct IWineD3DQueryImpl
1233 {
1234     const IWineD3DQueryVtbl  *lpVtbl;
1235     LONG                      ref;     /* Note: Ref counting not required */
1236     
1237     IUnknown                 *parent;
1238     /*TODO: replace with iface usage */
1239 #if 0
1240     IWineD3DDevice         *wineD3DDevice;
1241 #else
1242     IWineD3DDeviceImpl       *wineD3DDevice;
1243 #endif
1244
1245     /* IWineD3DQuery fields */
1246     WINED3DQUERYTYPE         type;
1247     /* TODO: Think about using a IUnknown instead of a void* */
1248     void                     *extendedData;
1249     
1250   
1251 } IWineD3DQueryImpl;
1252
1253 extern const IWineD3DQueryVtbl IWineD3DQuery_Vtbl;
1254
1255 /* Datastructures for IWineD3DQueryImpl.extendedData */
1256 typedef struct  WineQueryOcclusionData {
1257     GLuint  queryId;
1258 } WineQueryOcclusionData;
1259
1260
1261 /*****************************************************************************
1262  * IWineD3DSwapChainImpl implementation structure (extends IUnknown)
1263  */
1264
1265 typedef struct IWineD3DSwapChainImpl
1266 {
1267     /*IUnknown part*/
1268     const IWineD3DSwapChainVtbl *lpVtbl;
1269     LONG                      ref;     /* Note: Ref counting not required */
1270
1271     IUnknown                 *parent;
1272     IWineD3DDeviceImpl       *wineD3DDevice;
1273
1274     /* IWineD3DSwapChain fields */
1275     IWineD3DSurface         **backBuffer;
1276     IWineD3DSurface          *frontBuffer;
1277     BOOL                      wantsDepthStencilBuffer;
1278     D3DPRESENT_PARAMETERS     presentParms;
1279     DWORD                     orig_width, orig_height;
1280
1281     /* TODO: move everything up to drawable off into a context manager
1282       and store the 'data' in the contextManagerData interface.
1283     IUnknown                  *contextManagerData;
1284     */
1285
1286     HWND                    win_handle;
1287     Window                  win;
1288     Display                *display;
1289
1290     GLXContext              glCtx;
1291     XVisualInfo            *visInfo;
1292     GLXContext              render_ctx;
1293     /* This has been left in device for now, but needs moving off into a rendertarget management class and separated out from swapchains and devices. */
1294     Drawable                drawable;
1295 } IWineD3DSwapChainImpl;
1296
1297 extern const IWineD3DSwapChainVtbl IWineD3DSwapChain_Vtbl;
1298
1299 /*****************************************************************************
1300  * Utility function prototypes 
1301  */
1302
1303 /* Trace routines */
1304 const char* debug_d3dformat(WINED3DFORMAT fmt);
1305 const char* debug_d3ddevicetype(WINED3DDEVTYPE devtype);
1306 const char* debug_d3dresourcetype(WINED3DRESOURCETYPE res);
1307 const char* debug_d3dusage(DWORD usage);
1308 const char* debug_d3dusagequery(DWORD usagequery);
1309 const char* debug_d3ddeclmethod(WINED3DDECLMETHOD method);
1310 const char* debug_d3ddecltype(WINED3DDECLTYPE type);
1311 const char* debug_d3ddeclusage(BYTE usage);
1312 const char* debug_d3dprimitivetype(WINED3DPRIMITIVETYPE PrimitiveType);
1313 const char* debug_d3drenderstate(DWORD state);
1314 const char* debug_d3dsamplerstate(DWORD state);
1315 const char* debug_d3dtexturestate(DWORD state);
1316 const char* debug_d3dtstype(WINED3DTRANSFORMSTATETYPE tstype);
1317 const char* debug_d3dpool(WINED3DPOOL pool);
1318
1319 /* Routines for GL <-> D3D values */
1320 GLenum StencilOp(DWORD op);
1321 GLenum CompareFunc(DWORD func);
1322 void   set_tex_op(IWineD3DDevice *iface, BOOL isAlpha, int Stage, WINED3DTEXTUREOP op, DWORD arg1, DWORD arg2, DWORD arg3);
1323 void   set_tex_op_nvrc(IWineD3DDevice *iface, BOOL is_alpha, int stage, WINED3DTEXTUREOP op, DWORD arg1, DWORD arg2, DWORD arg3, INT texture_idx);
1324 void   set_texture_matrix(const float *smat, DWORD flags, BOOL calculatedCoords);
1325
1326 int D3DFmtMakeGlCfg(WINED3DFORMAT BackBufferFormat, WINED3DFORMAT StencilBufferFormat, int *attribs, int* nAttribs, BOOL alternate);
1327
1328 /* Math utils */
1329 void multiply_matrix(WINED3DMATRIX *dest, const WINED3DMATRIX *src1, const WINED3DMATRIX *src2);
1330
1331 /*****************************************************************************
1332  * To enable calling of inherited functions, requires prototypes 
1333  *
1334  * Note: Only require classes which are subclassed, ie resource, basetexture, 
1335  */
1336     /*** IUnknown methods ***/
1337     extern HRESULT WINAPI IWineD3DResourceImpl_QueryInterface(IWineD3DResource *iface, REFIID riid, void** ppvObject);
1338     extern ULONG WINAPI IWineD3DResourceImpl_AddRef(IWineD3DResource *iface);
1339     extern ULONG WINAPI IWineD3DResourceImpl_Release(IWineD3DResource *iface);
1340     /*** IWineD3DResource methods ***/
1341     extern HRESULT WINAPI IWineD3DResourceImpl_GetParent(IWineD3DResource *iface, IUnknown **pParent);
1342     extern HRESULT WINAPI IWineD3DResourceImpl_GetDevice(IWineD3DResource *iface, IWineD3DDevice ** ppDevice);
1343     extern HRESULT WINAPI IWineD3DResourceImpl_SetPrivateData(IWineD3DResource *iface, REFGUID  refguid, CONST void * pData, DWORD  SizeOfData, DWORD  Flags);
1344     extern HRESULT WINAPI IWineD3DResourceImpl_GetPrivateData(IWineD3DResource *iface, REFGUID  refguid, void * pData, DWORD * pSizeOfData);
1345     extern HRESULT WINAPI IWineD3DResourceImpl_FreePrivateData(IWineD3DResource *iface, REFGUID  refguid);
1346     extern DWORD WINAPI IWineD3DResourceImpl_SetPriority(IWineD3DResource *iface, DWORD  PriorityNew);
1347     extern DWORD WINAPI IWineD3DResourceImpl_GetPriority(IWineD3DResource *iface);
1348     extern void WINAPI IWineD3DResourceImpl_PreLoad(IWineD3DResource *iface);
1349     extern WINED3DRESOURCETYPE WINAPI IWineD3DResourceImpl_GetType(IWineD3DResource *iface);
1350     /*** class static members ***/
1351     void IWineD3DResourceImpl_CleanUp(IWineD3DResource *iface);
1352
1353     /*** IUnknown methods ***/
1354     extern HRESULT WINAPI IWineD3DBaseTextureImpl_QueryInterface(IWineD3DBaseTexture *iface, REFIID riid, void** ppvObject);
1355     extern ULONG WINAPI IWineD3DBaseTextureImpl_AddRef(IWineD3DBaseTexture *iface);
1356     extern ULONG WINAPI IWineD3DBaseTextureImpl_Release(IWineD3DBaseTexture *iface);
1357     /*** IWineD3DResource methods ***/
1358     extern HRESULT WINAPI IWineD3DBaseTextureImpl_GetParent(IWineD3DBaseTexture *iface, IUnknown **pParent);
1359     extern HRESULT WINAPI IWineD3DBaseTextureImpl_GetDevice(IWineD3DBaseTexture *iface, IWineD3DDevice ** ppDevice);
1360     extern HRESULT WINAPI IWineD3DBaseTextureImpl_SetPrivateData(IWineD3DBaseTexture *iface, REFGUID  refguid, CONST void * pData, DWORD  SizeOfData, DWORD  Flags);
1361     extern HRESULT WINAPI IWineD3DBaseTextureImpl_GetPrivateData(IWineD3DBaseTexture *iface, REFGUID  refguid, void * pData, DWORD * pSizeOfData);
1362     extern HRESULT WINAPI IWineD3DBaseTextureImpl_FreePrivateData(IWineD3DBaseTexture *iface, REFGUID  refguid);
1363     extern DWORD WINAPI IWineD3DBaseTextureImpl_SetPriority(IWineD3DBaseTexture *iface, DWORD  PriorityNew);
1364     extern DWORD WINAPI IWineD3DBaseTextureImpl_GetPriority(IWineD3DBaseTexture *iface);
1365     extern void WINAPI IWineD3DBaseTextureImpl_PreLoad(IWineD3DBaseTexture *iface);
1366     extern WINED3DRESOURCETYPE WINAPI IWineD3DBaseTextureImpl_GetType(IWineD3DBaseTexture *iface);
1367     /*** IWineD3DBaseTexture methods ***/
1368     extern DWORD WINAPI IWineD3DBaseTextureImpl_SetLOD(IWineD3DBaseTexture *iface, DWORD LODNew);
1369     extern DWORD WINAPI IWineD3DBaseTextureImpl_GetLOD(IWineD3DBaseTexture *iface);
1370     extern DWORD WINAPI IWineD3DBaseTextureImpl_GetLevelCount(IWineD3DBaseTexture *iface);
1371     extern HRESULT WINAPI IWineD3DBaseTextureImpl_SetAutoGenFilterType(IWineD3DBaseTexture *iface, WINED3DTEXTUREFILTERTYPE FilterType);
1372     extern WINED3DTEXTUREFILTERTYPE WINAPI IWineD3DBaseTextureImpl_GetAutoGenFilterType(IWineD3DBaseTexture *iface);
1373     extern void WINAPI IWineD3DBaseTextureImpl_GenerateMipSubLevels(IWineD3DBaseTexture *iface);
1374     extern BOOL WINAPI IWineD3DBaseTextureImpl_SetDirty(IWineD3DBaseTexture *iface, BOOL);
1375     extern BOOL WINAPI IWineD3DBaseTextureImpl_GetDirty(IWineD3DBaseTexture *iface);
1376
1377     extern BYTE* WINAPI IWineD3DVertexBufferImpl_GetMemory(IWineD3DVertexBuffer* iface, DWORD iOffset, GLint *vbo);
1378     extern HRESULT WINAPI IWineD3DVertexBufferImpl_ReleaseMemory(IWineD3DVertexBuffer* iface);
1379     extern HRESULT WINAPI IWineD3DBaseTextureImpl_BindTexture(IWineD3DBaseTexture *iface);
1380     extern HRESULT WINAPI IWineD3DBaseTextureImpl_UnBindTexture(IWineD3DBaseTexture *iface);
1381     extern void WINAPI IWineD3DBaseTextureImpl_ApplyStateChanges(IWineD3DBaseTexture *iface, const DWORD textureStates[WINED3D_HIGHEST_TEXTURE_STATE + 1], const DWORD samplerStates[WINED3D_HIGHEST_SAMPLER_STATE + 1]);
1382     /*** class static members ***/
1383     void IWineD3DBaseTextureImpl_CleanUp(IWineD3DBaseTexture *iface);
1384
1385 struct SHADER_OPCODE_ARG;
1386 typedef void (*shader_fct_t)();
1387 typedef void (*SHADER_HANDLER) (struct SHADER_OPCODE_ARG*);
1388
1389 /* Struct to maintain a list of GLSL shader programs and their associated pixel and
1390  * vertex shaders.  A list of this type is maintained on the DeviceImpl, and is only
1391  * used if the user is using GLSL shaders. */
1392 struct glsl_shader_prog_link {
1393     struct list             entry;
1394     GLhandleARB             programId;
1395     GLhandleARB             *vuniformF_locations;
1396     GLhandleARB             *puniformF_locations;
1397     IWineD3DVertexShader*   vertexShader;
1398     IWineD3DPixelShader*    pixelShader;
1399 };
1400
1401 /* TODO: Make this dynamic, based on shader limits ? */
1402 #define MAX_REG_ADDR 1
1403 #define MAX_REG_TEMP 32
1404 #define MAX_REG_TEXCRD 8
1405 #define MAX_REG_INPUT 12
1406 #define MAX_REG_OUTPUT 12
1407 #define MAX_ATTRIBS 16
1408 #define MAX_CONST_I 16
1409 #define MAX_CONST_B 16
1410
1411 /* FIXME: This needs to go up to 2048 for
1412  * Shader model 3 according to msdn (and for software shaders) */
1413 #define MAX_LABELS 16
1414
1415 typedef struct semantic {
1416     DWORD usage;
1417     DWORD reg;
1418 } semantic;
1419
1420 typedef struct local_constant {
1421     struct list entry;
1422     unsigned int idx;
1423     DWORD value[4];
1424 } local_constant;
1425
1426 typedef struct shader_reg_maps {
1427
1428     char texcoord[MAX_REG_TEXCRD];          /* pixel < 3.0 */
1429     char temporary[MAX_REG_TEMP];           /* pixel, vertex */
1430     char address[MAX_REG_ADDR];             /* vertex */
1431     char packed_input[MAX_REG_INPUT];       /* pshader >= 3.0 */
1432     char packed_output[MAX_REG_OUTPUT];     /* vertex >= 3.0 */
1433     char attributes[MAX_ATTRIBS];           /* vertex */
1434     char labels[MAX_LABELS];                /* pixel, vertex */
1435
1436     /* Sampler usage tokens 
1437      * Use 0 as default (bit 31 is always 1 on a valid token) */
1438     DWORD samplers[MAX_SAMPLERS];
1439
1440     /* Whether or not a loop is used in this shader */
1441     char loop;
1442
1443     /* Whether or not this shader uses fog */
1444     char fog;
1445
1446 } shader_reg_maps;
1447
1448 #define SHADER_PGMSIZE 65535
1449 typedef struct SHADER_BUFFER {
1450     char* buffer;
1451     unsigned int bsize;
1452     unsigned int lineNo;
1453 } SHADER_BUFFER;
1454
1455 /* Undocumented opcode controls */
1456 #define INST_CONTROLS_SHIFT 16
1457 #define INST_CONTROLS_MASK 0x00ff0000
1458
1459 typedef enum COMPARISON_TYPE {
1460     COMPARISON_GT = 1,
1461     COMPARISON_EQ = 2,
1462     COMPARISON_GE = 3,
1463     COMPARISON_LT = 4,
1464     COMPARISON_NE = 5,
1465     COMPARISON_LE = 6
1466 } COMPARISON_TYPE;
1467
1468 typedef struct SHADER_OPCODE {
1469     unsigned int  opcode;
1470     const char*   name;
1471     const char*   glname;
1472     char          dst_token;
1473     CONST UINT    num_params;
1474     shader_fct_t  soft_fct;
1475     SHADER_HANDLER hw_fct;
1476     SHADER_HANDLER hw_glsl_fct;
1477     DWORD         min_version;
1478     DWORD         max_version;
1479 } SHADER_OPCODE;
1480
1481 typedef struct SHADER_OPCODE_ARG {
1482     IWineD3DBaseShader* shader;
1483     shader_reg_maps* reg_maps;
1484     CONST SHADER_OPCODE* opcode;
1485     DWORD opcode_token;
1486     DWORD dst;
1487     DWORD dst_addr;
1488     DWORD predicate;
1489     DWORD src[4];
1490     DWORD src_addr[4];
1491     SHADER_BUFFER* buffer;
1492 } SHADER_OPCODE_ARG;
1493
1494 typedef struct SHADER_LIMITS {
1495     unsigned int temporary;
1496     unsigned int texcoord;
1497     unsigned int sampler;
1498     unsigned int constant_int;
1499     unsigned int constant_float;
1500     unsigned int constant_bool;
1501     unsigned int address;
1502     unsigned int packed_output;
1503     unsigned int packed_input;
1504     unsigned int attributes;
1505     unsigned int label;
1506 } SHADER_LIMITS;
1507
1508 /** Keeps track of details for TEX_M#x# shader opcodes which need to 
1509     maintain state information between multiple codes */
1510 typedef struct SHADER_PARSE_STATE {
1511     unsigned int current_row;
1512     DWORD texcoord_w[2];
1513 } SHADER_PARSE_STATE;
1514
1515 /* Base Shader utility functions. 
1516  * (may move callers into the same file in the future) */
1517 extern int shader_addline(
1518     SHADER_BUFFER* buffer,
1519     const char* fmt, ...);
1520
1521 extern const SHADER_OPCODE* shader_get_opcode(
1522     IWineD3DBaseShader *iface, 
1523     const DWORD code);
1524
1525 extern void shader_delete_constant_list(
1526     struct list* clist);
1527
1528 /* Vertex shader utility functions */
1529 extern BOOL vshader_get_input(
1530     IWineD3DVertexShader* iface,
1531     BYTE usage_req, BYTE usage_idx_req,
1532     unsigned int* regnum);
1533
1534 extern BOOL vshader_input_is_color(
1535     IWineD3DVertexShader* iface,
1536     unsigned int regnum);
1537
1538 extern HRESULT allocate_shader_constants(IWineD3DStateBlockImpl* object);
1539
1540 /* ARB_[vertex/fragment]_program helper functions */
1541 extern void shader_arb_load_constants(
1542     IWineD3DDevice* device,
1543     char usePixelShader,
1544     char useVertexShader);
1545
1546 /* ARB shader program Prototypes */
1547 extern void shader_hw_def(SHADER_OPCODE_ARG *arg);
1548
1549 /* ARB pixel shader prototypes */
1550 extern void pshader_hw_cnd(SHADER_OPCODE_ARG* arg);
1551 extern void pshader_hw_cmp(SHADER_OPCODE_ARG* arg);
1552 extern void pshader_hw_map2gl(SHADER_OPCODE_ARG* arg);
1553 extern void pshader_hw_tex(SHADER_OPCODE_ARG* arg);
1554 extern void pshader_hw_texcoord(SHADER_OPCODE_ARG* arg);
1555 extern void pshader_hw_texreg2ar(SHADER_OPCODE_ARG* arg);
1556 extern void pshader_hw_texreg2gb(SHADER_OPCODE_ARG* arg);
1557 extern void pshader_hw_texbem(SHADER_OPCODE_ARG* arg);
1558 extern void pshader_hw_texm3x2pad(SHADER_OPCODE_ARG* arg);
1559 extern void pshader_hw_texm3x2tex(SHADER_OPCODE_ARG* arg);
1560 extern void pshader_hw_texm3x3pad(SHADER_OPCODE_ARG* arg);
1561 extern void pshader_hw_texm3x3tex(SHADER_OPCODE_ARG* arg);
1562 extern void pshader_hw_texm3x3spec(SHADER_OPCODE_ARG* arg);
1563 extern void pshader_hw_texm3x3vspec(SHADER_OPCODE_ARG* arg);
1564
1565 /* ARB vertex shader prototypes */
1566 extern void vshader_hw_map2gl(SHADER_OPCODE_ARG* arg);
1567 extern void vshader_hw_mnxn(SHADER_OPCODE_ARG* arg);
1568
1569 /* GLSL helper functions */
1570 extern void set_glsl_shader_program(IWineD3DDevice *iface);
1571 extern void shader_glsl_add_instruction_modifiers(SHADER_OPCODE_ARG *arg);
1572 extern void shader_glsl_load_constants(
1573     IWineD3DDevice* device,
1574     char usePixelShader,
1575     char useVertexShader);
1576
1577 /** The following translate DirectX pixel/vertex shader opcodes to GLSL lines */
1578 extern void shader_glsl_map2gl(SHADER_OPCODE_ARG* arg);
1579 extern void shader_glsl_arith(SHADER_OPCODE_ARG* arg);
1580 extern void shader_glsl_mov(SHADER_OPCODE_ARG* arg);
1581 extern void shader_glsl_mad(SHADER_OPCODE_ARG* arg);
1582 extern void shader_glsl_mnxn(SHADER_OPCODE_ARG* arg);
1583 extern void shader_glsl_lrp(SHADER_OPCODE_ARG* arg);
1584 extern void shader_glsl_dot(SHADER_OPCODE_ARG* arg);
1585 extern void shader_glsl_rcp(SHADER_OPCODE_ARG* arg);
1586 extern void shader_glsl_cnd(SHADER_OPCODE_ARG* arg);
1587 extern void shader_glsl_compare(SHADER_OPCODE_ARG* arg);
1588 extern void shader_glsl_def(SHADER_OPCODE_ARG* arg);
1589 extern void shader_glsl_defi(SHADER_OPCODE_ARG* arg);
1590 extern void shader_glsl_defb(SHADER_OPCODE_ARG* arg);
1591 extern void shader_glsl_expp(SHADER_OPCODE_ARG* arg);
1592 extern void shader_glsl_cmp(SHADER_OPCODE_ARG* arg);
1593 extern void shader_glsl_lit(SHADER_OPCODE_ARG* arg);
1594 extern void shader_glsl_dst(SHADER_OPCODE_ARG* arg);
1595 extern void shader_glsl_sincos(SHADER_OPCODE_ARG* arg);
1596 extern void shader_glsl_loop(SHADER_OPCODE_ARG* arg);
1597 extern void shader_glsl_end(SHADER_OPCODE_ARG* arg);
1598 extern void shader_glsl_if(SHADER_OPCODE_ARG* arg);
1599 extern void shader_glsl_ifc(SHADER_OPCODE_ARG* arg);
1600 extern void shader_glsl_else(SHADER_OPCODE_ARG* arg);
1601 extern void shader_glsl_break(SHADER_OPCODE_ARG* arg);
1602 extern void shader_glsl_breakc(SHADER_OPCODE_ARG* arg);
1603 extern void shader_glsl_rep(SHADER_OPCODE_ARG* arg);
1604 extern void shader_glsl_call(SHADER_OPCODE_ARG* arg);
1605 extern void shader_glsl_callnz(SHADER_OPCODE_ARG* arg);
1606 extern void shader_glsl_label(SHADER_OPCODE_ARG* arg);
1607
1608 /** GLSL Pixel Shader Prototypes */
1609 extern void pshader_glsl_tex(SHADER_OPCODE_ARG* arg);
1610 extern void pshader_glsl_texcoord(SHADER_OPCODE_ARG* arg);
1611 extern void pshader_glsl_texdp3tex(SHADER_OPCODE_ARG* arg);
1612 extern void pshader_glsl_texdp3(SHADER_OPCODE_ARG* arg);
1613 extern void pshader_glsl_texdepth(SHADER_OPCODE_ARG* arg);
1614 extern void pshader_glsl_texm3x2depth(SHADER_OPCODE_ARG* arg);
1615 extern void pshader_glsl_texm3x2pad(SHADER_OPCODE_ARG* arg);
1616 extern void pshader_glsl_texm3x2tex(SHADER_OPCODE_ARG* arg);
1617 extern void pshader_glsl_texm3x3(SHADER_OPCODE_ARG* arg);
1618 extern void pshader_glsl_texm3x3pad(SHADER_OPCODE_ARG* arg);
1619 extern void pshader_glsl_texm3x3tex(SHADER_OPCODE_ARG* arg);
1620 extern void pshader_glsl_texm3x3spec(SHADER_OPCODE_ARG* arg);
1621 extern void pshader_glsl_texm3x3vspec(SHADER_OPCODE_ARG* arg);
1622 extern void pshader_glsl_texkill(SHADER_OPCODE_ARG* arg);
1623 extern void pshader_glsl_texbem(SHADER_OPCODE_ARG* arg);
1624 extern void pshader_glsl_texreg2ar(SHADER_OPCODE_ARG* arg);
1625 extern void pshader_glsl_texreg2gb(SHADER_OPCODE_ARG* arg);
1626 extern void pshader_glsl_texreg2rgb(SHADER_OPCODE_ARG* arg);
1627 extern void pshader_glsl_dp2add(SHADER_OPCODE_ARG* arg);
1628 extern void pshader_glsl_input_pack(
1629    SHADER_BUFFER* buffer,
1630    semantic* semantics_out);
1631
1632 /** GLSL Vertex Shader Prototypes */
1633 extern void vshader_glsl_output_unpack(
1634    SHADER_BUFFER* buffer,
1635    semantic* semantics_out);
1636
1637 /*****************************************************************************
1638  * IDirect3DBaseShader implementation structure
1639  */
1640 typedef struct IWineD3DBaseShaderClass
1641 {
1642     DWORD                           hex_version;
1643     SHADER_LIMITS                   limits;
1644     SHADER_PARSE_STATE              parse_state;
1645     CONST SHADER_OPCODE             *shader_ins;
1646     CONST DWORD                     *function;
1647     UINT                            functionLength;
1648     GLuint                          prgId;
1649     BOOL                            is_compiled;
1650
1651     /* Type of shader backend */
1652     int shader_mode;
1653
1654     /* Immediate constants (override global ones) */
1655     struct list constantsB;
1656     struct list constantsF;
1657     struct list constantsI;
1658     shader_reg_maps reg_maps;
1659
1660     /* Pointer to the parent device */
1661     IWineD3DDevice *device;
1662
1663 } IWineD3DBaseShaderClass;
1664
1665 typedef struct IWineD3DBaseShaderImpl {
1666     /* IUnknown */
1667     const IWineD3DBaseShaderVtbl    *lpVtbl;
1668     LONG                            ref;
1669
1670     /* IWineD3DBaseShader */
1671     IWineD3DBaseShaderClass         baseShader;
1672 } IWineD3DBaseShaderImpl;
1673
1674 extern HRESULT shader_get_registers_used(
1675     IWineD3DBaseShader *iface,
1676     shader_reg_maps* reg_maps,
1677     semantic* semantics_in,
1678     semantic* semantics_out,
1679     CONST DWORD* pToken,
1680     IWineD3DStateBlockImpl *stateBlock);
1681
1682 extern void shader_generate_glsl_declarations(
1683     IWineD3DBaseShader *iface,
1684     shader_reg_maps* reg_maps,
1685     SHADER_BUFFER* buffer,
1686     WineD3D_GL_Info* gl_info);
1687
1688 extern void shader_generate_arb_declarations(
1689     IWineD3DBaseShader *iface,
1690     shader_reg_maps* reg_maps,
1691     SHADER_BUFFER* buffer,
1692     WineD3D_GL_Info* gl_info);
1693
1694 extern void shader_generate_main(
1695     IWineD3DBaseShader *iface,
1696     SHADER_BUFFER* buffer,
1697     shader_reg_maps* reg_maps,
1698     CONST DWORD* pFunction);
1699
1700 extern void shader_dump_ins_modifiers(
1701     const DWORD output);
1702
1703 extern void shader_dump_param(
1704     IWineD3DBaseShader *iface,
1705     const DWORD param,
1706     const DWORD addr_token,
1707     int input);
1708
1709 extern void shader_trace_init(
1710     IWineD3DBaseShader *iface,
1711     const DWORD* pFunction);
1712
1713 extern int shader_get_param(
1714     IWineD3DBaseShader* iface,
1715     const DWORD* pToken,
1716     DWORD* param,
1717     DWORD* addr_token);
1718
1719 extern int shader_skip_unrecognized(
1720     IWineD3DBaseShader* iface,
1721     const DWORD* pToken);
1722
1723 extern void print_glsl_info_log(
1724     WineD3D_GL_Info *gl_info,
1725     GLhandleARB obj);
1726
1727 inline static int shader_get_regtype(const DWORD param) {
1728     return (((param & WINED3DSP_REGTYPE_MASK) >> WINED3DSP_REGTYPE_SHIFT) |
1729             ((param & WINED3DSP_REGTYPE_MASK2) >> WINED3DSP_REGTYPE_SHIFT2));
1730 }
1731
1732 extern unsigned int shader_get_float_offset(const DWORD reg);
1733
1734 inline static BOOL shader_is_pshader_version(DWORD token) {
1735     return 0xFFFF0000 == (token & 0xFFFF0000);
1736 }
1737
1738 inline static BOOL shader_is_vshader_version(DWORD token) {
1739     return 0xFFFE0000 == (token & 0xFFFF0000);
1740 }
1741
1742 inline static BOOL shader_is_comment(DWORD token) {
1743     return WINED3DSIO_COMMENT == (token & WINED3DSI_OPCODE_MASK);
1744 }
1745
1746 /* Internally used shader constants. Applications can use constants 0 to GL_LIMITS(vshader_constantsF) - 1,
1747  * so upload them above that
1748  */
1749 #define ARB_SHADER_PRIVCONST_BASE GL_LIMITS(vshader_constantsF)
1750 #define ARB_SHADER_PRIVCONST_POS ARB_SHADER_PRIVCONST_BASE + 0
1751
1752 /*****************************************************************************
1753  * IDirect3DVertexShader implementation structure
1754  */
1755 typedef struct IWineD3DVertexShaderImpl {
1756     /* IUnknown parts*/   
1757     const IWineD3DVertexShaderVtbl *lpVtbl;
1758     LONG                        ref;     /* Note: Ref counting not required */
1759
1760     /* IWineD3DBaseShader */
1761     IWineD3DBaseShaderClass     baseShader;
1762
1763     /* IWineD3DVertexShaderImpl */
1764     IUnknown                    *parent;
1765
1766     char                        usesFog;
1767     DWORD                       usage;
1768
1769     /* Vertex shader input and output semantics */
1770     semantic semantics_in [MAX_ATTRIBS];
1771     semantic semantics_out [MAX_REG_OUTPUT];
1772
1773     /* run time datas...  */
1774     VSHADERDATA                *data;
1775     IWineD3DVertexDeclaration  *vertexDeclaration;
1776 #if 0 /* needs reworking */
1777     /* run time datas */
1778     VSHADERINPUTDATA input;
1779     VSHADEROUTPUTDATA output;
1780 #endif
1781 } IWineD3DVertexShaderImpl;
1782 extern const SHADER_OPCODE IWineD3DVertexShaderImpl_shader_ins[];
1783 extern const IWineD3DVertexShaderVtbl IWineD3DVertexShader_Vtbl;
1784
1785 /*****************************************************************************
1786  * IDirect3DPixelShader implementation structure
1787  */
1788 typedef struct IWineD3DPixelShaderImpl {
1789     /* IUnknown parts */
1790     const IWineD3DPixelShaderVtbl *lpVtbl;
1791     LONG                        ref;     /* Note: Ref counting not required */
1792
1793     /* IWineD3DBaseShader */
1794     IWineD3DBaseShaderClass     baseShader;
1795
1796     /* IWineD3DPixelShaderImpl */
1797     IUnknown                   *parent;
1798
1799     /* Pixel shader input semantics */
1800     semantic semantics_in [MAX_REG_INPUT];
1801
1802     /* run time data */
1803     PSHADERDATA                *data;
1804
1805 #if 0 /* needs reworking */
1806     PSHADERINPUTDATA input;
1807     PSHADEROUTPUTDATA output;
1808 #endif
1809 } IWineD3DPixelShaderImpl;
1810
1811 extern const SHADER_OPCODE IWineD3DPixelShaderImpl_shader_ins[];
1812 extern const IWineD3DPixelShaderVtbl IWineD3DPixelShader_Vtbl;
1813
1814 /*****************************************************************************
1815  * IWineD3DPalette implementation structure
1816  */
1817 struct IWineD3DPaletteImpl {
1818     /* IUnknown parts */
1819     const IWineD3DPaletteVtbl  *lpVtbl;
1820     LONG                       ref;
1821
1822     IUnknown                   *parent;
1823     IWineD3DDeviceImpl         *wineD3DDevice;
1824
1825     /* IWineD3DPalette */
1826     HPALETTE                   hpal;
1827     WORD                       palVersion;     /*|               */
1828     WORD                       palNumEntries;  /*|  LOGPALETTE   */
1829     PALETTEENTRY               palents[256];   /*|               */
1830     /* This is to store the palette in 'screen format' */
1831     int                        screen_palents[256];
1832     DWORD                      Flags;
1833 };
1834
1835 extern const IWineD3DPaletteVtbl IWineD3DPalette_Vtbl;
1836 DWORD IWineD3DPaletteImpl_Size(DWORD dwFlags);
1837
1838 /* DirectDraw utility functions */
1839 extern WINED3DFORMAT pixelformat_for_depth(DWORD depth);
1840
1841 /*****************************************************************************
1842  * Pixel format management
1843  */
1844 typedef struct {
1845     WINED3DFORMAT           format;
1846     DWORD                   alphaMask, redMask, greenMask, blueMask;
1847     UINT                    bpp;
1848     BOOL                    isFourcc;
1849     GLint                   glInternal, glFormat, glType;
1850 } PixelFormatDesc;
1851
1852 const PixelFormatDesc *getFormatDescEntry(WINED3DFORMAT fmt);
1853 #endif