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