OSDN Git Service

mesa: Add support for the GL_KHR_context_flush_control extension
[android-x86/external-mesa.git] / src / mesa / main / mtypes.h
1 /*
2  * Mesa 3-D graphics library
3  *
4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
5  * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation
10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11  * and/or sell copies of the Software, and to permit persons to whom the
12  * Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included
15  * in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23  * OTHER DEALINGS IN THE SOFTWARE.
24  */
25
26 /**
27  * \file mtypes.h
28  * Main Mesa data structures.
29  *
30  * Please try to mark derived values with a leading underscore ('_').
31  */
32
33 #ifndef MTYPES_H
34 #define MTYPES_H
35
36
37 #include <stdint.h>             /* uint32_t */
38 #include <stdbool.h>
39
40 #include "main/glheader.h"
41 #include "main/config.h"
42 #include "glapi/glapi.h"
43 #include "math/m_matrix.h"      /* GLmatrix */
44 #include "main/simple_list.h"   /* struct simple_node */
45 #include "main/formats.h"       /* MESA_FORMAT_COUNT */
46
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52
53 /**
54  * \name 64-bit extension of GLbitfield.
55  */
56 /*@{*/
57 typedef GLuint64 GLbitfield64;
58
59 /** Set a single bit */
60 #define BITFIELD64_BIT(b)      ((GLbitfield64)1 << (b))
61 /** Set all bits up to excluding bit b */
62 #define BITFIELD64_MASK(b)      \
63    ((b) == 64 ? (~(GLbitfield64)0) : BITFIELD64_BIT(b) - 1)
64 /** Set count bits starting from bit b  */
65 #define BITFIELD64_RANGE(b, count) \
66    (BITFIELD64_MASK((b) + (count)) & ~BITFIELD64_MASK(b))
67
68
69 /**
70  * \name Some forward type declarations
71  */
72 /*@{*/
73 struct _mesa_HashTable;
74 struct gl_attrib_node;
75 struct gl_list_extensions;
76 struct gl_meta_state;
77 struct gl_program_cache;
78 struct gl_texture_object;
79 struct gl_debug_state;
80 struct gl_context;
81 struct st_context;
82 struct gl_uniform_storage;
83 struct prog_instruction;
84 struct gl_program_parameter_list;
85 struct set;
86 struct set_entry;
87 struct vbo_context;
88 /*@}*/
89
90
91 /** Extra draw modes beyond GL_POINTS, GL_TRIANGLE_FAN, etc */
92 #define PRIM_MAX                 GL_TRIANGLE_STRIP_ADJACENCY
93 #define PRIM_OUTSIDE_BEGIN_END   (PRIM_MAX + 1)
94 #define PRIM_UNKNOWN             (PRIM_MAX + 2)
95
96
97
98 /**
99  * Indexes for vertex program attributes.
100  * GL_NV_vertex_program aliases generic attributes over the conventional
101  * attributes.  In GL_ARB_vertex_program shader the aliasing is optional.
102  * In GL_ARB_vertex_shader / OpenGL 2.0 the aliasing is disallowed (the
103  * generic attributes are distinct/separate).
104  */
105 typedef enum
106 {
107    VERT_ATTRIB_POS = 0,
108    VERT_ATTRIB_WEIGHT = 1,
109    VERT_ATTRIB_NORMAL = 2,
110    VERT_ATTRIB_COLOR0 = 3,
111    VERT_ATTRIB_COLOR1 = 4,
112    VERT_ATTRIB_FOG = 5,
113    VERT_ATTRIB_COLOR_INDEX = 6,
114    VERT_ATTRIB_EDGEFLAG = 7,
115    VERT_ATTRIB_TEX0 = 8,
116    VERT_ATTRIB_TEX1 = 9,
117    VERT_ATTRIB_TEX2 = 10,
118    VERT_ATTRIB_TEX3 = 11,
119    VERT_ATTRIB_TEX4 = 12,
120    VERT_ATTRIB_TEX5 = 13,
121    VERT_ATTRIB_TEX6 = 14,
122    VERT_ATTRIB_TEX7 = 15,
123    VERT_ATTRIB_POINT_SIZE = 16,
124    VERT_ATTRIB_GENERIC0 = 17,
125    VERT_ATTRIB_GENERIC1 = 18,
126    VERT_ATTRIB_GENERIC2 = 19,
127    VERT_ATTRIB_GENERIC3 = 20,
128    VERT_ATTRIB_GENERIC4 = 21,
129    VERT_ATTRIB_GENERIC5 = 22,
130    VERT_ATTRIB_GENERIC6 = 23,
131    VERT_ATTRIB_GENERIC7 = 24,
132    VERT_ATTRIB_GENERIC8 = 25,
133    VERT_ATTRIB_GENERIC9 = 26,
134    VERT_ATTRIB_GENERIC10 = 27,
135    VERT_ATTRIB_GENERIC11 = 28,
136    VERT_ATTRIB_GENERIC12 = 29,
137    VERT_ATTRIB_GENERIC13 = 30,
138    VERT_ATTRIB_GENERIC14 = 31,
139    VERT_ATTRIB_GENERIC15 = 32,
140    VERT_ATTRIB_MAX = 33
141 } gl_vert_attrib;
142
143 /**
144  * Symbolic constats to help iterating over
145  * specific blocks of vertex attributes.
146  *
147  * VERT_ATTRIB_FF
148  *   includes all fixed function attributes as well as
149  *   the aliased GL_NV_vertex_program shader attributes.
150  * VERT_ATTRIB_TEX
151  *   include the classic texture coordinate attributes.
152  *   Is a subset of VERT_ATTRIB_FF.
153  * VERT_ATTRIB_GENERIC
154  *   include the OpenGL 2.0+ GLSL generic shader attributes.
155  *   These alias the generic GL_ARB_vertex_shader attributes.
156  */
157 #define VERT_ATTRIB_FF(i)           (VERT_ATTRIB_POS + (i))
158 #define VERT_ATTRIB_FF_MAX          VERT_ATTRIB_GENERIC0
159
160 #define VERT_ATTRIB_TEX(i)          (VERT_ATTRIB_TEX0 + (i))
161 #define VERT_ATTRIB_TEX_MAX         MAX_TEXTURE_COORD_UNITS
162
163 #define VERT_ATTRIB_GENERIC(i)      (VERT_ATTRIB_GENERIC0 + (i))
164 #define VERT_ATTRIB_GENERIC_MAX     MAX_VERTEX_GENERIC_ATTRIBS
165
166 /**
167  * Bitflags for vertex attributes.
168  * These are used in bitfields in many places.
169  */
170 /*@{*/
171 #define VERT_BIT_POS             BITFIELD64_BIT(VERT_ATTRIB_POS)
172 #define VERT_BIT_WEIGHT          BITFIELD64_BIT(VERT_ATTRIB_WEIGHT)
173 #define VERT_BIT_NORMAL          BITFIELD64_BIT(VERT_ATTRIB_NORMAL)
174 #define VERT_BIT_COLOR0          BITFIELD64_BIT(VERT_ATTRIB_COLOR0)
175 #define VERT_BIT_COLOR1          BITFIELD64_BIT(VERT_ATTRIB_COLOR1)
176 #define VERT_BIT_FOG             BITFIELD64_BIT(VERT_ATTRIB_FOG)
177 #define VERT_BIT_COLOR_INDEX     BITFIELD64_BIT(VERT_ATTRIB_COLOR_INDEX)
178 #define VERT_BIT_EDGEFLAG        BITFIELD64_BIT(VERT_ATTRIB_EDGEFLAG)
179 #define VERT_BIT_TEX0            BITFIELD64_BIT(VERT_ATTRIB_TEX0)
180 #define VERT_BIT_TEX1            BITFIELD64_BIT(VERT_ATTRIB_TEX1)
181 #define VERT_BIT_TEX2            BITFIELD64_BIT(VERT_ATTRIB_TEX2)
182 #define VERT_BIT_TEX3            BITFIELD64_BIT(VERT_ATTRIB_TEX3)
183 #define VERT_BIT_TEX4            BITFIELD64_BIT(VERT_ATTRIB_TEX4)
184 #define VERT_BIT_TEX5            BITFIELD64_BIT(VERT_ATTRIB_TEX5)
185 #define VERT_BIT_TEX6            BITFIELD64_BIT(VERT_ATTRIB_TEX6)
186 #define VERT_BIT_TEX7            BITFIELD64_BIT(VERT_ATTRIB_TEX7)
187 #define VERT_BIT_POINT_SIZE      BITFIELD64_BIT(VERT_ATTRIB_POINT_SIZE)
188 #define VERT_BIT_GENERIC0        BITFIELD64_BIT(VERT_ATTRIB_GENERIC0)
189
190 #define VERT_BIT(i)              BITFIELD64_BIT(i)
191 #define VERT_BIT_ALL             BITFIELD64_RANGE(0, VERT_ATTRIB_MAX)
192
193 #define VERT_BIT_FF(i)           VERT_BIT(i)
194 #define VERT_BIT_FF_ALL          BITFIELD64_RANGE(0, VERT_ATTRIB_FF_MAX)
195 #define VERT_BIT_TEX(i)          VERT_BIT(VERT_ATTRIB_TEX(i))
196 #define VERT_BIT_TEX_ALL         \
197    BITFIELD64_RANGE(VERT_ATTRIB_TEX(0), VERT_ATTRIB_TEX_MAX)
198
199 #define VERT_BIT_GENERIC(i)      VERT_BIT(VERT_ATTRIB_GENERIC(i))
200 #define VERT_BIT_GENERIC_ALL     \
201    BITFIELD64_RANGE(VERT_ATTRIB_GENERIC(0), VERT_ATTRIB_GENERIC_MAX)
202 /*@}*/
203
204
205 /**
206  * Indexes for vertex shader outputs, geometry shader inputs/outputs, and
207  * fragment shader inputs.
208  *
209  * Note that some of these values are not available to all pipeline stages.
210  *
211  * When this enum is updated, the following code must be updated too:
212  * - vertResults (in prog_print.c's arb_output_attrib_string())
213  * - fragAttribs (in prog_print.c's arb_input_attrib_string())
214  * - _mesa_varying_slot_in_fs()
215  */
216 typedef enum
217 {
218    VARYING_SLOT_POS,
219    VARYING_SLOT_COL0, /* COL0 and COL1 must be contiguous */
220    VARYING_SLOT_COL1,
221    VARYING_SLOT_FOGC,
222    VARYING_SLOT_TEX0, /* TEX0-TEX7 must be contiguous */
223    VARYING_SLOT_TEX1,
224    VARYING_SLOT_TEX2,
225    VARYING_SLOT_TEX3,
226    VARYING_SLOT_TEX4,
227    VARYING_SLOT_TEX5,
228    VARYING_SLOT_TEX6,
229    VARYING_SLOT_TEX7,
230    VARYING_SLOT_PSIZ, /* Does not appear in FS */
231    VARYING_SLOT_BFC0, /* Does not appear in FS */
232    VARYING_SLOT_BFC1, /* Does not appear in FS */
233    VARYING_SLOT_EDGE, /* Does not appear in FS */
234    VARYING_SLOT_CLIP_VERTEX, /* Does not appear in FS */
235    VARYING_SLOT_CLIP_DIST0,
236    VARYING_SLOT_CLIP_DIST1,
237    VARYING_SLOT_PRIMITIVE_ID, /* Does not appear in VS */
238    VARYING_SLOT_LAYER, /* Appears as VS or GS output */
239    VARYING_SLOT_VIEWPORT, /* Appears as VS or GS output */
240    VARYING_SLOT_FACE, /* FS only */
241    VARYING_SLOT_PNTC, /* FS only */
242    VARYING_SLOT_VAR0, /* First generic varying slot */
243    VARYING_SLOT_MAX = VARYING_SLOT_VAR0 + MAX_VARYING
244 } gl_varying_slot;
245
246
247 /**
248  * Bitflags for varying slots.
249  */
250 /*@{*/
251 #define VARYING_BIT_POS BITFIELD64_BIT(VARYING_SLOT_POS)
252 #define VARYING_BIT_COL0 BITFIELD64_BIT(VARYING_SLOT_COL0)
253 #define VARYING_BIT_COL1 BITFIELD64_BIT(VARYING_SLOT_COL1)
254 #define VARYING_BIT_FOGC BITFIELD64_BIT(VARYING_SLOT_FOGC)
255 #define VARYING_BIT_TEX0 BITFIELD64_BIT(VARYING_SLOT_TEX0)
256 #define VARYING_BIT_TEX1 BITFIELD64_BIT(VARYING_SLOT_TEX1)
257 #define VARYING_BIT_TEX2 BITFIELD64_BIT(VARYING_SLOT_TEX2)
258 #define VARYING_BIT_TEX3 BITFIELD64_BIT(VARYING_SLOT_TEX3)
259 #define VARYING_BIT_TEX4 BITFIELD64_BIT(VARYING_SLOT_TEX4)
260 #define VARYING_BIT_TEX5 BITFIELD64_BIT(VARYING_SLOT_TEX5)
261 #define VARYING_BIT_TEX6 BITFIELD64_BIT(VARYING_SLOT_TEX6)
262 #define VARYING_BIT_TEX7 BITFIELD64_BIT(VARYING_SLOT_TEX7)
263 #define VARYING_BIT_TEX(U) BITFIELD64_BIT(VARYING_SLOT_TEX0 + (U))
264 #define VARYING_BITS_TEX_ANY BITFIELD64_RANGE(VARYING_SLOT_TEX0, \
265                                               MAX_TEXTURE_COORD_UNITS)
266 #define VARYING_BIT_PSIZ BITFIELD64_BIT(VARYING_SLOT_PSIZ)
267 #define VARYING_BIT_BFC0 BITFIELD64_BIT(VARYING_SLOT_BFC0)
268 #define VARYING_BIT_BFC1 BITFIELD64_BIT(VARYING_SLOT_BFC1)
269 #define VARYING_BIT_EDGE BITFIELD64_BIT(VARYING_SLOT_EDGE)
270 #define VARYING_BIT_CLIP_VERTEX BITFIELD64_BIT(VARYING_SLOT_CLIP_VERTEX)
271 #define VARYING_BIT_CLIP_DIST0 BITFIELD64_BIT(VARYING_SLOT_CLIP_DIST0)
272 #define VARYING_BIT_CLIP_DIST1 BITFIELD64_BIT(VARYING_SLOT_CLIP_DIST1)
273 #define VARYING_BIT_PRIMITIVE_ID BITFIELD64_BIT(VARYING_SLOT_PRIMITIVE_ID)
274 #define VARYING_BIT_LAYER BITFIELD64_BIT(VARYING_SLOT_LAYER)
275 #define VARYING_BIT_VIEWPORT BITFIELD64_BIT(VARYING_SLOT_VIEWPORT)
276 #define VARYING_BIT_FACE BITFIELD64_BIT(VARYING_SLOT_FACE)
277 #define VARYING_BIT_PNTC BITFIELD64_BIT(VARYING_SLOT_PNTC)
278 #define VARYING_BIT_VAR(V) BITFIELD64_BIT(VARYING_SLOT_VAR0 + (V))
279 /*@}*/
280
281 /**
282  * Bitflags for system values.
283  */
284 #define SYSTEM_BIT_SAMPLE_ID BITFIELD64_BIT(SYSTEM_VALUE_SAMPLE_ID)
285 #define SYSTEM_BIT_SAMPLE_POS BITFIELD64_BIT(SYSTEM_VALUE_SAMPLE_POS)
286 #define SYSTEM_BIT_SAMPLE_MASK_IN BITFIELD64_BIT(SYSTEM_VALUE_SAMPLE_MASK_IN)
287
288 /**
289  * Determine if the given gl_varying_slot appears in the fragment shader.
290  */
291 static inline GLboolean
292 _mesa_varying_slot_in_fs(gl_varying_slot slot)
293 {
294    switch (slot) {
295    case VARYING_SLOT_PSIZ:
296    case VARYING_SLOT_BFC0:
297    case VARYING_SLOT_BFC1:
298    case VARYING_SLOT_EDGE:
299    case VARYING_SLOT_CLIP_VERTEX:
300    case VARYING_SLOT_LAYER:
301       return GL_FALSE;
302    default:
303       return GL_TRUE;
304    }
305 }
306
307
308 /**
309  * Fragment program results
310  */
311 typedef enum
312 {
313    FRAG_RESULT_DEPTH = 0,
314    FRAG_RESULT_STENCIL = 1,
315    /* If a single color should be written to all render targets, this
316     * register is written.  No FRAG_RESULT_DATAn will be written.
317     */
318    FRAG_RESULT_COLOR = 2,
319    FRAG_RESULT_SAMPLE_MASK = 3,
320
321    /* FRAG_RESULT_DATAn are the per-render-target (GLSL gl_FragData[n]
322     * or ARB_fragment_program fragment.color[n]) color results.  If
323     * any are written, FRAG_RESULT_COLOR will not be written.
324     */
325    FRAG_RESULT_DATA0 = 4,
326    FRAG_RESULT_MAX = (FRAG_RESULT_DATA0 + MAX_DRAW_BUFFERS)
327 } gl_frag_result;
328
329
330 /**
331  * Indexes for all renderbuffers
332  */
333 typedef enum
334 {
335    /* the four standard color buffers */
336    BUFFER_FRONT_LEFT,
337    BUFFER_BACK_LEFT,
338    BUFFER_FRONT_RIGHT,
339    BUFFER_BACK_RIGHT,
340    BUFFER_DEPTH,
341    BUFFER_STENCIL,
342    BUFFER_ACCUM,
343    /* optional aux buffer */
344    BUFFER_AUX0,
345    /* generic renderbuffers */
346    BUFFER_COLOR0,
347    BUFFER_COLOR1,
348    BUFFER_COLOR2,
349    BUFFER_COLOR3,
350    BUFFER_COLOR4,
351    BUFFER_COLOR5,
352    BUFFER_COLOR6,
353    BUFFER_COLOR7,
354    BUFFER_COUNT
355 } gl_buffer_index;
356
357 /**
358  * Bit flags for all renderbuffers
359  */
360 #define BUFFER_BIT_FRONT_LEFT   (1 << BUFFER_FRONT_LEFT)
361 #define BUFFER_BIT_BACK_LEFT    (1 << BUFFER_BACK_LEFT)
362 #define BUFFER_BIT_FRONT_RIGHT  (1 << BUFFER_FRONT_RIGHT)
363 #define BUFFER_BIT_BACK_RIGHT   (1 << BUFFER_BACK_RIGHT)
364 #define BUFFER_BIT_AUX0         (1 << BUFFER_AUX0)
365 #define BUFFER_BIT_AUX1         (1 << BUFFER_AUX1)
366 #define BUFFER_BIT_AUX2         (1 << BUFFER_AUX2)
367 #define BUFFER_BIT_AUX3         (1 << BUFFER_AUX3)
368 #define BUFFER_BIT_DEPTH        (1 << BUFFER_DEPTH)
369 #define BUFFER_BIT_STENCIL      (1 << BUFFER_STENCIL)
370 #define BUFFER_BIT_ACCUM        (1 << BUFFER_ACCUM)
371 #define BUFFER_BIT_COLOR0       (1 << BUFFER_COLOR0)
372 #define BUFFER_BIT_COLOR1       (1 << BUFFER_COLOR1)
373 #define BUFFER_BIT_COLOR2       (1 << BUFFER_COLOR2)
374 #define BUFFER_BIT_COLOR3       (1 << BUFFER_COLOR3)
375 #define BUFFER_BIT_COLOR4       (1 << BUFFER_COLOR4)
376 #define BUFFER_BIT_COLOR5       (1 << BUFFER_COLOR5)
377 #define BUFFER_BIT_COLOR6       (1 << BUFFER_COLOR6)
378 #define BUFFER_BIT_COLOR7       (1 << BUFFER_COLOR7)
379
380 /**
381  * Mask of all the color buffer bits (but not accum).
382  */
383 #define BUFFER_BITS_COLOR  (BUFFER_BIT_FRONT_LEFT | \
384                             BUFFER_BIT_BACK_LEFT | \
385                             BUFFER_BIT_FRONT_RIGHT | \
386                             BUFFER_BIT_BACK_RIGHT | \
387                             BUFFER_BIT_AUX0 | \
388                             BUFFER_BIT_COLOR0 | \
389                             BUFFER_BIT_COLOR1 | \
390                             BUFFER_BIT_COLOR2 | \
391                             BUFFER_BIT_COLOR3 | \
392                             BUFFER_BIT_COLOR4 | \
393                             BUFFER_BIT_COLOR5 | \
394                             BUFFER_BIT_COLOR6 | \
395                             BUFFER_BIT_COLOR7)
396
397
398 /**
399  * Shader stages. Note that these will become 5 with tessellation.
400  *
401  * The order must match how shaders are ordered in the pipeline.
402  * The GLSL linker assumes that if i<j, then the j-th shader is
403  * executed later than the i-th shader.
404  */
405 typedef enum
406 {
407    MESA_SHADER_VERTEX = 0,
408    MESA_SHADER_GEOMETRY = 1,
409    MESA_SHADER_FRAGMENT = 2,
410    MESA_SHADER_COMPUTE = 3,
411 } gl_shader_stage;
412
413 #define MESA_SHADER_STAGES (MESA_SHADER_COMPUTE + 1)
414
415
416 /**
417  * Framebuffer configuration (aka visual / pixelformat)
418  * Note: some of these fields should be boolean, but it appears that
419  * code in drivers/dri/common/util.c requires int-sized fields.
420  */
421 struct gl_config
422 {
423    GLboolean rgbMode;
424    GLboolean floatMode;
425    GLboolean colorIndexMode;  /* XXX is this used anywhere? */
426    GLuint doubleBufferMode;
427    GLuint stereoMode;
428
429    GLboolean haveAccumBuffer;
430    GLboolean haveDepthBuffer;
431    GLboolean haveStencilBuffer;
432
433    GLint redBits, greenBits, blueBits, alphaBits;       /* bits per comp */
434    GLuint redMask, greenMask, blueMask, alphaMask;
435    GLint rgbBits;               /* total bits for rgb */
436    GLint indexBits;             /* total bits for colorindex */
437
438    GLint accumRedBits, accumGreenBits, accumBlueBits, accumAlphaBits;
439    GLint depthBits;
440    GLint stencilBits;
441
442    GLint numAuxBuffers;
443
444    GLint level;
445
446    /* EXT_visual_rating / GLX 1.2 */
447    GLint visualRating;
448
449    /* EXT_visual_info / GLX 1.2 */
450    GLint transparentPixel;
451    /*    colors are floats scaled to ints */
452    GLint transparentRed, transparentGreen, transparentBlue, transparentAlpha;
453    GLint transparentIndex;
454
455    /* ARB_multisample / SGIS_multisample */
456    GLint sampleBuffers;
457    GLint samples;
458
459    /* SGIX_pbuffer / GLX 1.3 */
460    GLint maxPbufferWidth;
461    GLint maxPbufferHeight;
462    GLint maxPbufferPixels;
463    GLint optimalPbufferWidth;   /* Only for SGIX_pbuffer. */
464    GLint optimalPbufferHeight;  /* Only for SGIX_pbuffer. */
465
466    /* OML_swap_method */
467    GLint swapMethod;
468
469    /* EXT_texture_from_pixmap */
470    GLint bindToTextureRgb;
471    GLint bindToTextureRgba;
472    GLint bindToMipmapTexture;
473    GLint bindToTextureTargets;
474    GLint yInverted;
475
476    /* EXT_framebuffer_sRGB */
477    GLint sRGBCapable;
478 };
479
480
481 /**
482  * \name Bit flags used for updating material values.
483  */
484 /*@{*/
485 #define MAT_ATTRIB_FRONT_AMBIENT           0 
486 #define MAT_ATTRIB_BACK_AMBIENT            1
487 #define MAT_ATTRIB_FRONT_DIFFUSE           2 
488 #define MAT_ATTRIB_BACK_DIFFUSE            3
489 #define MAT_ATTRIB_FRONT_SPECULAR          4 
490 #define MAT_ATTRIB_BACK_SPECULAR           5
491 #define MAT_ATTRIB_FRONT_EMISSION          6
492 #define MAT_ATTRIB_BACK_EMISSION           7
493 #define MAT_ATTRIB_FRONT_SHININESS         8
494 #define MAT_ATTRIB_BACK_SHININESS          9
495 #define MAT_ATTRIB_FRONT_INDEXES           10
496 #define MAT_ATTRIB_BACK_INDEXES            11
497 #define MAT_ATTRIB_MAX                     12
498
499 #define MAT_ATTRIB_AMBIENT(f)  (MAT_ATTRIB_FRONT_AMBIENT+(f))  
500 #define MAT_ATTRIB_DIFFUSE(f)  (MAT_ATTRIB_FRONT_DIFFUSE+(f))  
501 #define MAT_ATTRIB_SPECULAR(f) (MAT_ATTRIB_FRONT_SPECULAR+(f)) 
502 #define MAT_ATTRIB_EMISSION(f) (MAT_ATTRIB_FRONT_EMISSION+(f)) 
503 #define MAT_ATTRIB_SHININESS(f)(MAT_ATTRIB_FRONT_SHININESS+(f))
504 #define MAT_ATTRIB_INDEXES(f)  (MAT_ATTRIB_FRONT_INDEXES+(f))  
505
506 #define MAT_INDEX_AMBIENT  0
507 #define MAT_INDEX_DIFFUSE  1
508 #define MAT_INDEX_SPECULAR 2
509
510 #define MAT_BIT_FRONT_AMBIENT         (1<<MAT_ATTRIB_FRONT_AMBIENT)
511 #define MAT_BIT_BACK_AMBIENT          (1<<MAT_ATTRIB_BACK_AMBIENT)
512 #define MAT_BIT_FRONT_DIFFUSE         (1<<MAT_ATTRIB_FRONT_DIFFUSE)
513 #define MAT_BIT_BACK_DIFFUSE          (1<<MAT_ATTRIB_BACK_DIFFUSE)
514 #define MAT_BIT_FRONT_SPECULAR        (1<<MAT_ATTRIB_FRONT_SPECULAR)
515 #define MAT_BIT_BACK_SPECULAR         (1<<MAT_ATTRIB_BACK_SPECULAR)
516 #define MAT_BIT_FRONT_EMISSION        (1<<MAT_ATTRIB_FRONT_EMISSION)
517 #define MAT_BIT_BACK_EMISSION         (1<<MAT_ATTRIB_BACK_EMISSION)
518 #define MAT_BIT_FRONT_SHININESS       (1<<MAT_ATTRIB_FRONT_SHININESS)
519 #define MAT_BIT_BACK_SHININESS        (1<<MAT_ATTRIB_BACK_SHININESS)
520 #define MAT_BIT_FRONT_INDEXES         (1<<MAT_ATTRIB_FRONT_INDEXES)
521 #define MAT_BIT_BACK_INDEXES          (1<<MAT_ATTRIB_BACK_INDEXES)
522
523
524 #define FRONT_MATERIAL_BITS     (MAT_BIT_FRONT_EMISSION |       \
525                                  MAT_BIT_FRONT_AMBIENT |        \
526                                  MAT_BIT_FRONT_DIFFUSE |        \
527                                  MAT_BIT_FRONT_SPECULAR |       \
528                                  MAT_BIT_FRONT_SHININESS |      \
529                                  MAT_BIT_FRONT_INDEXES)
530
531 #define BACK_MATERIAL_BITS      (MAT_BIT_BACK_EMISSION |        \
532                                  MAT_BIT_BACK_AMBIENT |         \
533                                  MAT_BIT_BACK_DIFFUSE |         \
534                                  MAT_BIT_BACK_SPECULAR |        \
535                                  MAT_BIT_BACK_SHININESS |       \
536                                  MAT_BIT_BACK_INDEXES)
537
538 #define ALL_MATERIAL_BITS       (FRONT_MATERIAL_BITS | BACK_MATERIAL_BITS)
539 /*@}*/
540
541
542 /**
543  * Material state.
544  */
545 struct gl_material
546 {
547    GLfloat Attrib[MAT_ATTRIB_MAX][4];
548 };
549
550
551 /**
552  * Light state flags.
553  */
554 /*@{*/
555 #define LIGHT_SPOT         0x1
556 #define LIGHT_LOCAL_VIEWER 0x2
557 #define LIGHT_POSITIONAL   0x4
558 #define LIGHT_NEED_VERTICES (LIGHT_POSITIONAL|LIGHT_LOCAL_VIEWER)
559 /*@}*/
560
561
562 /**
563  * Light source state.
564  */
565 struct gl_light
566 {
567    struct gl_light *next;       /**< double linked list with sentinel */
568    struct gl_light *prev;
569
570    GLfloat Ambient[4];          /**< ambient color */
571    GLfloat Diffuse[4];          /**< diffuse color */
572    GLfloat Specular[4];         /**< specular color */
573    GLfloat EyePosition[4];      /**< position in eye coordinates */
574    GLfloat SpotDirection[4];    /**< spotlight direction in eye coordinates */
575    GLfloat SpotExponent;
576    GLfloat SpotCutoff;          /**< in degrees */
577    GLfloat _CosCutoff;          /**< = MAX(0, cos(SpotCutoff)) */
578    GLfloat ConstantAttenuation;
579    GLfloat LinearAttenuation;
580    GLfloat QuadraticAttenuation;
581    GLboolean Enabled;           /**< On/off flag */
582
583    /** 
584     * \name Derived fields
585     */
586    /*@{*/
587    GLbitfield _Flags;           /**< Mask of LIGHT_x bits defined above */
588
589    GLfloat _Position[4];        /**< position in eye/obj coordinates */
590    GLfloat _VP_inf_norm[3];     /**< Norm direction to infinite light */
591    GLfloat _h_inf_norm[3];      /**< Norm( _VP_inf_norm + <0,0,1> ) */
592    GLfloat _NormSpotDirection[4]; /**< normalized spotlight direction */
593    GLfloat _VP_inf_spot_attenuation;
594
595    GLfloat _MatAmbient[2][3];   /**< material ambient * light ambient */
596    GLfloat _MatDiffuse[2][3];   /**< material diffuse * light diffuse */
597    GLfloat _MatSpecular[2][3];  /**< material spec * light specular */
598    /*@}*/
599 };
600
601
602 /**
603  * Light model state.
604  */
605 struct gl_lightmodel
606 {
607    GLfloat Ambient[4];          /**< ambient color */
608    GLboolean LocalViewer;       /**< Local (or infinite) view point? */
609    GLboolean TwoSide;           /**< Two (or one) sided lighting? */
610    GLenum ColorControl;         /**< either GL_SINGLE_COLOR
611                                  *    or GL_SEPARATE_SPECULAR_COLOR */
612 };
613
614
615 /**
616  * Accumulation buffer attribute group (GL_ACCUM_BUFFER_BIT)
617  */
618 struct gl_accum_attrib
619 {
620    GLfloat ClearColor[4];       /**< Accumulation buffer clear color */
621 };
622
623
624 /**
625  * Used for storing clear color, texture border color, etc.
626  * The float values are typically unclamped.
627  */
628 union gl_color_union
629 {
630    GLfloat f[4];
631    GLint i[4];
632    GLuint ui[4];
633 };
634
635
636 /**
637  * Color buffer attribute group (GL_COLOR_BUFFER_BIT).
638  */
639 struct gl_colorbuffer_attrib
640 {
641    GLuint ClearIndex;                      /**< Index for glClear */
642    union gl_color_union ClearColor;        /**< Color for glClear, unclamped */
643    GLuint IndexMask;                       /**< Color index write mask */
644    GLubyte ColorMask[MAX_DRAW_BUFFERS][4]; /**< Each flag is 0xff or 0x0 */
645
646    GLenum DrawBuffer[MAX_DRAW_BUFFERS]; /**< Which buffer to draw into */
647
648    /** 
649     * \name alpha testing
650     */
651    /*@{*/
652    GLboolean AlphaEnabled;              /**< Alpha test enabled flag */
653    GLenum AlphaFunc;                    /**< Alpha test function */
654    GLfloat AlphaRefUnclamped;
655    GLclampf AlphaRef;                   /**< Alpha reference value */
656    /*@}*/
657
658    /** 
659     * \name Blending
660     */
661    /*@{*/
662    GLbitfield BlendEnabled;             /**< Per-buffer blend enable flags */
663
664    /* NOTE: this does _not_ depend on fragment clamping or any other clamping
665     * control, only on the fixed-pointness of the render target.
666     * The query does however depend on fragment color clamping.
667     */
668    GLfloat BlendColorUnclamped[4];               /**< Blending color */
669    GLfloat BlendColor[4];               /**< Blending color */
670
671    struct
672    {
673       GLenum SrcRGB;             /**< RGB blend source term */
674       GLenum DstRGB;             /**< RGB blend dest term */
675       GLenum SrcA;               /**< Alpha blend source term */
676       GLenum DstA;               /**< Alpha blend dest term */
677       GLenum EquationRGB;        /**< GL_ADD, GL_SUBTRACT, etc. */
678       GLenum EquationA;          /**< GL_ADD, GL_SUBTRACT, etc. */
679       /**
680        * Set if any blend factor uses SRC1.  Computed at the time blend factors
681        * get set.
682        */
683       GLboolean _UsesDualSrc;
684    } Blend[MAX_DRAW_BUFFERS];
685    /** Are the blend func terms currently different for each buffer/target? */
686    GLboolean _BlendFuncPerBuffer;
687    /** Are the blend equations currently different for each buffer/target? */
688    GLboolean _BlendEquationPerBuffer;
689    /*@}*/
690
691    /** 
692     * \name Logic op
693     */
694    /*@{*/
695    GLenum LogicOp;                      /**< Logic operator */
696    GLboolean IndexLogicOpEnabled;       /**< Color index logic op enabled flag */
697    GLboolean ColorLogicOpEnabled;       /**< RGBA logic op enabled flag */
698    /*@}*/
699
700    GLboolean DitherFlag;                /**< Dither enable flag */
701
702    GLenum ClampFragmentColor; /**< GL_TRUE, GL_FALSE or GL_FIXED_ONLY_ARB */
703    GLboolean _ClampFragmentColor; /** < with GL_FIXED_ONLY_ARB resolved */
704    GLenum ClampReadColor;     /**< GL_TRUE, GL_FALSE or GL_FIXED_ONLY_ARB */
705
706    GLboolean sRGBEnabled;    /**< Framebuffer sRGB blending/updating requested */
707 };
708
709
710 /**
711  * Current attribute group (GL_CURRENT_BIT).
712  */
713 struct gl_current_attrib
714 {
715    /**
716     * \name Current vertex attributes.
717     * \note Values are valid only after FLUSH_VERTICES has been called.
718     * \note Index and Edgeflag current values are stored as floats in the 
719     * SIX and SEVEN attribute slots.
720     */
721    GLfloat Attrib[VERT_ATTRIB_MAX][4];  /**< Position, color, texcoords, etc */
722
723    /**
724     * \name Current raster position attributes (always valid).
725     * \note This set of attributes is very similar to the SWvertex struct.
726     */
727    /*@{*/
728    GLfloat RasterPos[4];
729    GLfloat RasterDistance;
730    GLfloat RasterColor[4];
731    GLfloat RasterSecondaryColor[4];
732    GLfloat RasterTexCoords[MAX_TEXTURE_COORD_UNITS][4];
733    GLboolean RasterPosValid;
734    /*@}*/
735 };
736
737
738 /**
739  * Depth buffer attribute group (GL_DEPTH_BUFFER_BIT).
740  */
741 struct gl_depthbuffer_attrib
742 {
743    GLenum Func;                 /**< Function for depth buffer compare */
744    GLclampd Clear;              /**< Value to clear depth buffer to */
745    GLboolean Test;              /**< Depth buffering enabled flag */
746    GLboolean Mask;              /**< Depth buffer writable? */
747    GLboolean BoundsTest;        /**< GL_EXT_depth_bounds_test */
748    GLfloat BoundsMin, BoundsMax;/**< GL_EXT_depth_bounds_test */
749 };
750
751
752 /**
753  * Evaluator attribute group (GL_EVAL_BIT).
754  */
755 struct gl_eval_attrib
756 {
757    /**
758     * \name Enable bits 
759     */
760    /*@{*/
761    GLboolean Map1Color4;
762    GLboolean Map1Index;
763    GLboolean Map1Normal;
764    GLboolean Map1TextureCoord1;
765    GLboolean Map1TextureCoord2;
766    GLboolean Map1TextureCoord3;
767    GLboolean Map1TextureCoord4;
768    GLboolean Map1Vertex3;
769    GLboolean Map1Vertex4;
770    GLboolean Map2Color4;
771    GLboolean Map2Index;
772    GLboolean Map2Normal;
773    GLboolean Map2TextureCoord1;
774    GLboolean Map2TextureCoord2;
775    GLboolean Map2TextureCoord3;
776    GLboolean Map2TextureCoord4;
777    GLboolean Map2Vertex3;
778    GLboolean Map2Vertex4;
779    GLboolean AutoNormal;
780    /*@}*/
781    
782    /**
783     * \name Map Grid endpoints and divisions and calculated du values
784     */
785    /*@{*/
786    GLint MapGrid1un;
787    GLfloat MapGrid1u1, MapGrid1u2, MapGrid1du;
788    GLint MapGrid2un, MapGrid2vn;
789    GLfloat MapGrid2u1, MapGrid2u2, MapGrid2du;
790    GLfloat MapGrid2v1, MapGrid2v2, MapGrid2dv;
791    /*@}*/
792 };
793
794
795 /**
796  * Fog attribute group (GL_FOG_BIT).
797  */
798 struct gl_fog_attrib
799 {
800    GLboolean Enabled;           /**< Fog enabled flag */
801    GLfloat ColorUnclamped[4];            /**< Fog color */
802    GLfloat Color[4];            /**< Fog color */
803    GLfloat Density;             /**< Density >= 0.0 */
804    GLfloat Start;               /**< Start distance in eye coords */
805    GLfloat End;                 /**< End distance in eye coords */
806    GLfloat Index;               /**< Fog index */
807    GLenum Mode;                 /**< Fog mode */
808    GLboolean ColorSumEnabled;
809    GLenum FogCoordinateSource;  /**< GL_EXT_fog_coord */
810    GLfloat _Scale;              /**< (End == Start) ? 1.0 : 1.0 / (End - Start) */
811    GLenum FogDistanceMode;     /**< GL_NV_fog_distance */
812 };
813
814
815 /** 
816  * Hint attribute group (GL_HINT_BIT).
817  * 
818  * Values are always one of GL_FASTEST, GL_NICEST, or GL_DONT_CARE.
819  */
820 struct gl_hint_attrib
821 {
822    GLenum PerspectiveCorrection;
823    GLenum PointSmooth;
824    GLenum LineSmooth;
825    GLenum PolygonSmooth;
826    GLenum Fog;
827    GLenum TextureCompression;   /**< GL_ARB_texture_compression */
828    GLenum GenerateMipmap;       /**< GL_SGIS_generate_mipmap */
829    GLenum FragmentShaderDerivative; /**< GL_ARB_fragment_shader */
830 };
831
832
833 /**
834  * Lighting attribute group (GL_LIGHT_BIT).
835  */
836 struct gl_light_attrib
837 {
838    struct gl_light Light[MAX_LIGHTS];   /**< Array of light sources */
839    struct gl_lightmodel Model;          /**< Lighting model */
840
841    /**
842     * Front and back material values.
843     * Note: must call FLUSH_VERTICES() before using.
844     */
845    struct gl_material Material;
846
847    GLboolean Enabled;                   /**< Lighting enabled flag */
848    GLenum ShadeModel;                   /**< GL_FLAT or GL_SMOOTH */
849    GLenum ProvokingVertex;              /**< GL_EXT_provoking_vertex */
850    GLenum ColorMaterialFace;            /**< GL_FRONT, BACK or FRONT_AND_BACK */
851    GLenum ColorMaterialMode;            /**< GL_AMBIENT, GL_DIFFUSE, etc */
852    GLbitfield _ColorMaterialBitmask;    /**< bitmask formed from Face and Mode */
853    GLboolean ColorMaterialEnabled;
854    GLenum ClampVertexColor;             /**< GL_TRUE, GL_FALSE, GL_FIXED_ONLY */
855    GLboolean _ClampVertexColor;
856
857    struct gl_light EnabledList;         /**< List sentinel */
858
859    /** 
860     * Derived state for optimizations: 
861     */
862    /*@{*/
863    GLboolean _NeedEyeCoords;            
864    GLboolean _NeedVertices;             /**< Use fast shader? */
865    GLfloat _BaseColor[2][3];
866    /*@}*/
867 };
868
869
870 /**
871  * Line attribute group (GL_LINE_BIT).
872  */
873 struct gl_line_attrib
874 {
875    GLboolean SmoothFlag;        /**< GL_LINE_SMOOTH enabled? */
876    GLboolean StippleFlag;       /**< GL_LINE_STIPPLE enabled? */
877    GLushort StipplePattern;     /**< Stipple pattern */
878    GLint StippleFactor;         /**< Stipple repeat factor */
879    GLfloat Width;               /**< Line width */
880 };
881
882
883 /**
884  * Display list attribute group (GL_LIST_BIT).
885  */
886 struct gl_list_attrib
887 {
888    GLuint ListBase;
889 };
890
891
892 /**
893  * Multisample attribute group (GL_MULTISAMPLE_BIT).
894  */
895 struct gl_multisample_attrib
896 {
897    GLboolean Enabled;
898    GLboolean _Enabled;   /**< true if Enabled and multisample buffer */
899    GLboolean SampleAlphaToCoverage;
900    GLboolean SampleAlphaToOne;
901    GLboolean SampleCoverage;
902    GLfloat SampleCoverageValue;
903    GLboolean SampleCoverageInvert;
904    GLboolean SampleShading;
905    GLfloat MinSampleShadingValue;
906
907    /* ARB_texture_multisample / GL3.2 additions */
908    GLboolean SampleMask;
909    /** The GL spec defines this as an array but >32x MSAA is madness */
910    GLbitfield SampleMaskValue;
911 };
912
913
914 /**
915  * A pixelmap (see glPixelMap)
916  */
917 struct gl_pixelmap
918 {
919    GLint Size;
920    GLfloat Map[MAX_PIXEL_MAP_TABLE];
921 };
922
923
924 /**
925  * Collection of all pixelmaps
926  */
927 struct gl_pixelmaps
928 {
929    struct gl_pixelmap RtoR;  /**< i.e. GL_PIXEL_MAP_R_TO_R */
930    struct gl_pixelmap GtoG;
931    struct gl_pixelmap BtoB;
932    struct gl_pixelmap AtoA;
933    struct gl_pixelmap ItoR;
934    struct gl_pixelmap ItoG;
935    struct gl_pixelmap ItoB;
936    struct gl_pixelmap ItoA;
937    struct gl_pixelmap ItoI;
938    struct gl_pixelmap StoS;
939 };
940
941
942 /**
943  * Pixel attribute group (GL_PIXEL_MODE_BIT).
944  */
945 struct gl_pixel_attrib
946 {
947    GLenum ReadBuffer;           /**< source buffer for glRead/CopyPixels() */
948
949    /*--- Begin Pixel Transfer State ---*/
950    /* Fields are in the order in which they're applied... */
951
952    /** Scale & Bias (index shift, offset) */
953    /*@{*/
954    GLfloat RedBias, RedScale;
955    GLfloat GreenBias, GreenScale;
956    GLfloat BlueBias, BlueScale;
957    GLfloat AlphaBias, AlphaScale;
958    GLfloat DepthBias, DepthScale;
959    GLint IndexShift, IndexOffset;
960    /*@}*/
961
962    /* Pixel Maps */
963    /* Note: actual pixel maps are not part of this attrib group */
964    GLboolean MapColorFlag;
965    GLboolean MapStencilFlag;
966
967    /*--- End Pixel Transfer State ---*/
968
969    /** glPixelZoom */
970    GLfloat ZoomX, ZoomY;
971 };
972
973
974 /**
975  * Point attribute group (GL_POINT_BIT).
976  */
977 struct gl_point_attrib
978 {
979    GLboolean SmoothFlag;        /**< True if GL_POINT_SMOOTH is enabled */
980    GLfloat Size;                /**< User-specified point size */
981    GLfloat Params[3];           /**< GL_EXT_point_parameters */
982    GLfloat MinSize, MaxSize;    /**< GL_EXT_point_parameters */
983    GLfloat Threshold;           /**< GL_EXT_point_parameters */
984    GLboolean _Attenuated;       /**< True if Params != [1, 0, 0] */
985    GLboolean PointSprite;       /**< GL_NV/ARB_point_sprite */
986    GLboolean CoordReplace[MAX_TEXTURE_COORD_UNITS]; /**< GL_ARB_point_sprite*/
987    GLenum SpriteRMode;          /**< GL_NV_point_sprite (only!) */
988    GLenum SpriteOrigin;         /**< GL_ARB_point_sprite */
989 };
990
991
992 /**
993  * Polygon attribute group (GL_POLYGON_BIT).
994  */
995 struct gl_polygon_attrib
996 {
997    GLenum FrontFace;            /**< Either GL_CW or GL_CCW */
998    GLenum FrontMode;            /**< Either GL_POINT, GL_LINE or GL_FILL */
999    GLenum BackMode;             /**< Either GL_POINT, GL_LINE or GL_FILL */
1000    GLboolean _FrontBit;         /**< 0=GL_CCW, 1=GL_CW */
1001    GLboolean CullFlag;          /**< Culling on/off flag */
1002    GLboolean SmoothFlag;        /**< True if GL_POLYGON_SMOOTH is enabled */
1003    GLboolean StippleFlag;       /**< True if GL_POLYGON_STIPPLE is enabled */
1004    GLenum CullFaceMode;         /**< Culling mode GL_FRONT or GL_BACK */
1005    GLfloat OffsetFactor;        /**< Polygon offset factor, from user */
1006    GLfloat OffsetUnits;         /**< Polygon offset units, from user */
1007    GLboolean OffsetPoint;       /**< Offset in GL_POINT mode */
1008    GLboolean OffsetLine;        /**< Offset in GL_LINE mode */
1009    GLboolean OffsetFill;        /**< Offset in GL_FILL mode */
1010 };
1011
1012
1013 /**
1014  * Scissor attributes (GL_SCISSOR_BIT).
1015  */
1016 struct gl_scissor_rect
1017 {
1018    GLint X, Y;                  /**< Lower left corner of box */
1019    GLsizei Width, Height;       /**< Size of box */
1020 };
1021 struct gl_scissor_attrib
1022 {
1023    GLbitfield EnableFlags;      /**< Scissor test enabled? */
1024    struct gl_scissor_rect ScissorArray[MAX_VIEWPORTS];
1025 };
1026
1027
1028 /**
1029  * Stencil attribute group (GL_STENCIL_BUFFER_BIT).
1030  *
1031  * Three sets of stencil data are tracked so that OpenGL 2.0,
1032  * GL_EXT_stencil_two_side, and GL_ATI_separate_stencil can all be supported
1033  * simultaneously.  In each of the stencil state arrays, element 0 corresponds
1034  * to GL_FRONT.  Element 1 corresponds to the OpenGL 2.0 /
1035  * GL_ATI_separate_stencil GL_BACK state.  Element 2 corresponds to the
1036  * GL_EXT_stencil_two_side GL_BACK state.
1037  *
1038  * The derived value \c _BackFace is either 1 or 2 depending on whether or
1039  * not GL_STENCIL_TEST_TWO_SIDE_EXT is enabled.
1040  *
1041  * The derived value \c _TestTwoSide is set when the front-face and back-face
1042  * stencil state are different.
1043  */
1044 struct gl_stencil_attrib
1045 {
1046    GLboolean Enabled;           /**< Enabled flag */
1047    GLboolean TestTwoSide;       /**< GL_EXT_stencil_two_side */
1048    GLubyte ActiveFace;          /**< GL_EXT_stencil_two_side (0 or 2) */
1049    GLboolean _Enabled;          /**< Enabled and stencil buffer present */
1050    GLboolean _WriteEnabled;     /**< _Enabled and non-zero writemasks */
1051    GLboolean _TestTwoSide;
1052    GLubyte _BackFace;           /**< Current back stencil state (1 or 2) */
1053    GLenum Function[3];          /**< Stencil function */
1054    GLenum FailFunc[3];          /**< Fail function */
1055    GLenum ZPassFunc[3];         /**< Depth buffer pass function */
1056    GLenum ZFailFunc[3];         /**< Depth buffer fail function */
1057    GLint Ref[3];                /**< Reference value */
1058    GLuint ValueMask[3];         /**< Value mask */
1059    GLuint WriteMask[3];         /**< Write mask */
1060    GLuint Clear;                /**< Clear value */
1061 };
1062
1063
1064 /**
1065  * An index for each type of texture object.  These correspond to the GL
1066  * texture target enums, such as GL_TEXTURE_2D, GL_TEXTURE_CUBE_MAP, etc.
1067  * Note: the order is from highest priority to lowest priority.
1068  */
1069 typedef enum
1070 {
1071    TEXTURE_2D_MULTISAMPLE_INDEX,
1072    TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX,
1073    TEXTURE_CUBE_ARRAY_INDEX,
1074    TEXTURE_BUFFER_INDEX,
1075    TEXTURE_2D_ARRAY_INDEX,
1076    TEXTURE_1D_ARRAY_INDEX,
1077    TEXTURE_EXTERNAL_INDEX,
1078    TEXTURE_CUBE_INDEX,
1079    TEXTURE_3D_INDEX,
1080    TEXTURE_RECT_INDEX,
1081    TEXTURE_2D_INDEX,
1082    TEXTURE_1D_INDEX,
1083    NUM_TEXTURE_TARGETS
1084 } gl_texture_index;
1085
1086
1087 /**
1088  * Bit flags for each type of texture object
1089  */
1090 /*@{*/
1091 #define TEXTURE_2D_MULTISAMPLE_BIT (1 << TEXTURE_2D_MULTISAMPLE_INDEX)
1092 #define TEXTURE_2D_MULTISAMPLE_ARRAY_BIT (1 << TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX)
1093 #define TEXTURE_CUBE_ARRAY_BIT (1 << TEXTURE_CUBE_ARRAY_INDEX)
1094 #define TEXTURE_BUFFER_BIT   (1 << TEXTURE_BUFFER_INDEX)
1095 #define TEXTURE_2D_ARRAY_BIT (1 << TEXTURE_2D_ARRAY_INDEX)
1096 #define TEXTURE_1D_ARRAY_BIT (1 << TEXTURE_1D_ARRAY_INDEX)
1097 #define TEXTURE_EXTERNAL_BIT (1 << TEXTURE_EXTERNAL_INDEX)
1098 #define TEXTURE_CUBE_BIT     (1 << TEXTURE_CUBE_INDEX)
1099 #define TEXTURE_3D_BIT       (1 << TEXTURE_3D_INDEX)
1100 #define TEXTURE_RECT_BIT     (1 << TEXTURE_RECT_INDEX)
1101 #define TEXTURE_2D_BIT       (1 << TEXTURE_2D_INDEX)
1102 #define TEXTURE_1D_BIT       (1 << TEXTURE_1D_INDEX)
1103 /*@}*/
1104
1105
1106 /**
1107  * Texture image state.  Drivers will typically create a subclass of this
1108  * with extra fields for memory buffers, etc.
1109  */
1110 struct gl_texture_image
1111 {
1112    GLint InternalFormat;        /**< Internal format as given by the user */
1113    GLenum _BaseFormat;          /**< Either GL_RGB, GL_RGBA, GL_ALPHA,
1114                                  *   GL_LUMINANCE, GL_LUMINANCE_ALPHA,
1115                                  *   GL_INTENSITY, GL_DEPTH_COMPONENT or
1116                                  *   GL_DEPTH_STENCIL_EXT only. Used for
1117                                  *   choosing TexEnv arithmetic.
1118                                  */
1119    mesa_format TexFormat;         /**< The actual texture memory format */
1120
1121    GLuint Border;               /**< 0 or 1 */
1122    GLuint Width;                /**< = 2^WidthLog2 + 2*Border */
1123    GLuint Height;               /**< = 2^HeightLog2 + 2*Border */
1124    GLuint Depth;                /**< = 2^DepthLog2 + 2*Border */
1125    GLuint Width2;               /**< = Width - 2*Border */
1126    GLuint Height2;              /**< = Height - 2*Border */
1127    GLuint Depth2;               /**< = Depth - 2*Border */
1128    GLuint WidthLog2;            /**< = log2(Width2) */
1129    GLuint HeightLog2;           /**< = log2(Height2) */
1130    GLuint DepthLog2;            /**< = log2(Depth2) */
1131    GLuint MaxNumLevels;         /**< = maximum possible number of mipmap
1132                                        levels, computed from the dimensions */
1133
1134    struct gl_texture_object *TexObject;  /**< Pointer back to parent object */
1135    GLuint Level;                /**< Which mipmap level am I? */
1136    /** Cube map face: index into gl_texture_object::Image[] array */
1137    GLuint Face;
1138
1139    /** GL_ARB_texture_multisample */
1140    GLuint NumSamples;            /**< Sample count, or 0 for non-multisample */
1141    GLboolean FixedSampleLocations; /**< Same sample locations for all pixels? */
1142 };
1143
1144
1145 /**
1146  * Indexes for cube map faces.
1147  */
1148 typedef enum
1149 {
1150    FACE_POS_X = 0,
1151    FACE_NEG_X = 1,
1152    FACE_POS_Y = 2,
1153    FACE_NEG_Y = 3,
1154    FACE_POS_Z = 4,
1155    FACE_NEG_Z = 5,
1156    MAX_FACES = 6
1157 } gl_face_index;
1158
1159
1160 /**
1161  * Sampler object state.  These objects are new with GL_ARB_sampler_objects
1162  * and OpenGL 3.3.  Legacy texture objects also contain a sampler object.
1163  */
1164 struct gl_sampler_object
1165 {
1166    GLuint Name;
1167    GLint RefCount;
1168    GLchar *Label;               /**< GL_KHR_debug */
1169
1170    GLenum WrapS;                /**< S-axis texture image wrap mode */
1171    GLenum WrapT;                /**< T-axis texture image wrap mode */
1172    GLenum WrapR;                /**< R-axis texture image wrap mode */
1173    GLenum MinFilter;            /**< minification filter */
1174    GLenum MagFilter;            /**< magnification filter */
1175    union gl_color_union BorderColor;  /**< Interpreted according to texture format */
1176    GLfloat MinLod;              /**< min lambda, OpenGL 1.2 */
1177    GLfloat MaxLod;              /**< max lambda, OpenGL 1.2 */
1178    GLfloat LodBias;             /**< OpenGL 1.4 */
1179    GLfloat MaxAnisotropy;       /**< GL_EXT_texture_filter_anisotropic */
1180    GLenum CompareMode;          /**< GL_ARB_shadow */
1181    GLenum CompareFunc;          /**< GL_ARB_shadow */
1182    GLenum sRGBDecode;           /**< GL_DECODE_EXT or GL_SKIP_DECODE_EXT */
1183    GLboolean CubeMapSeamless;   /**< GL_AMD_seamless_cubemap_per_texture */
1184 };
1185
1186
1187 /**
1188  * Texture object state.  Contains the array of mipmap images, border color,
1189  * wrap modes, filter modes, and shadow/texcompare state.
1190  */
1191 struct gl_texture_object
1192 {
1193    mtx_t Mutex;      /**< for thread safety */
1194    GLint RefCount;             /**< reference count */
1195    GLuint Name;                /**< the user-visible texture object ID */
1196    GLchar *Label;               /**< GL_KHR_debug */
1197    GLenum Target;              /**< GL_TEXTURE_1D, GL_TEXTURE_2D, etc. */
1198    gl_texture_index TargetIndex; /**< The gl_texture_unit::CurrentTex index.
1199                                       Only valid when Target is valid. */
1200
1201    struct gl_sampler_object Sampler;
1202
1203    GLenum DepthMode;           /**< GL_ARB_depth_texture */
1204    bool StencilSampling;       /**< Should we sample stencil instead of depth? */
1205
1206    GLfloat Priority;           /**< in [0,1] */
1207    GLint BaseLevel;            /**< min mipmap level, OpenGL 1.2 */
1208    GLint MaxLevel;             /**< max mipmap level, OpenGL 1.2 */
1209    GLint ImmutableLevels;      /**< ES 3.0 / ARB_texture_view */
1210    GLint _MaxLevel;            /**< actual max mipmap level (q in the spec) */
1211    GLfloat _MaxLambda;         /**< = _MaxLevel - BaseLevel (q - p in spec) */
1212    GLint CropRect[4];          /**< GL_OES_draw_texture */
1213    GLenum Swizzle[4];          /**< GL_EXT_texture_swizzle */
1214    GLuint _Swizzle;            /**< same as Swizzle, but SWIZZLE_* format */
1215    GLboolean GenerateMipmap;   /**< GL_SGIS_generate_mipmap */
1216    GLboolean _BaseComplete;    /**< Is the base texture level valid? */
1217    GLboolean _MipmapComplete;  /**< Is the whole mipmap valid? */
1218    GLboolean _IsIntegerFormat; /**< Does the texture store integer values? */
1219    GLboolean _RenderToTexture; /**< Any rendering to this texture? */
1220    GLboolean Purgeable;        /**< Is the buffer purgeable under memory
1221                                     pressure? */
1222    GLboolean Immutable;        /**< GL_ARB_texture_storage */
1223
1224    GLuint MinLevel;            /**< GL_ARB_texture_view */
1225    GLuint MinLayer;            /**< GL_ARB_texture_view */
1226    GLuint NumLevels;           /**< GL_ARB_texture_view */
1227    GLuint NumLayers;           /**< GL_ARB_texture_view */
1228
1229    /** Actual texture images, indexed by [cube face] and [mipmap level] */
1230    struct gl_texture_image *Image[MAX_FACES][MAX_TEXTURE_LEVELS];
1231
1232    /** GL_ARB_texture_buffer_object */
1233    struct gl_buffer_object *BufferObject;
1234    GLenum BufferObjectFormat;
1235    /** Equivalent Mesa format for BufferObjectFormat. */
1236    mesa_format _BufferObjectFormat;
1237    /** GL_ARB_texture_buffer_range */
1238    GLintptr BufferOffset;
1239    GLsizeiptr BufferSize; /**< if this is -1, use BufferObject->Size instead */
1240
1241    /** GL_OES_EGL_image_external */
1242    GLint RequiredTextureImageUnits;
1243
1244    /** GL_ARB_shader_image_load_store */
1245    GLenum ImageFormatCompatibilityType;
1246 };
1247
1248
1249 /** Up to four combiner sources are possible with GL_NV_texture_env_combine4 */
1250 #define MAX_COMBINER_TERMS 4
1251
1252
1253 /**
1254  * Texture combine environment state.
1255  */
1256 struct gl_tex_env_combine_state
1257 {
1258    GLenum ModeRGB;       /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1259    GLenum ModeA;         /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1260    /** Source terms: GL_PRIMARY_COLOR, GL_TEXTURE, etc */
1261    GLenum SourceRGB[MAX_COMBINER_TERMS];
1262    GLenum SourceA[MAX_COMBINER_TERMS];
1263    /** Source operands: GL_SRC_COLOR, GL_ONE_MINUS_SRC_COLOR, etc */
1264    GLenum OperandRGB[MAX_COMBINER_TERMS];
1265    GLenum OperandA[MAX_COMBINER_TERMS];
1266    GLuint ScaleShiftRGB; /**< 0, 1 or 2 */
1267    GLuint ScaleShiftA;   /**< 0, 1 or 2 */
1268    GLuint _NumArgsRGB;   /**< Number of inputs used for the RGB combiner */
1269    GLuint _NumArgsA;     /**< Number of inputs used for the A combiner */
1270 };
1271
1272
1273 /**
1274  * TexGenEnabled flags.
1275  */
1276 /*@{*/
1277 #define S_BIT 1
1278 #define T_BIT 2
1279 #define R_BIT 4
1280 #define Q_BIT 8
1281 #define STR_BITS (S_BIT | T_BIT | R_BIT)
1282 /*@}*/
1283
1284
1285 /**
1286  * Bit flag versions of the corresponding GL_ constants.
1287  */
1288 /*@{*/
1289 #define TEXGEN_SPHERE_MAP        0x1
1290 #define TEXGEN_OBJ_LINEAR        0x2
1291 #define TEXGEN_EYE_LINEAR        0x4
1292 #define TEXGEN_REFLECTION_MAP_NV 0x8
1293 #define TEXGEN_NORMAL_MAP_NV     0x10
1294
1295 #define TEXGEN_NEED_NORMALS      (TEXGEN_SPHERE_MAP        | \
1296                                   TEXGEN_REFLECTION_MAP_NV | \
1297                                   TEXGEN_NORMAL_MAP_NV)
1298 #define TEXGEN_NEED_EYE_COORD    (TEXGEN_SPHERE_MAP        | \
1299                                   TEXGEN_REFLECTION_MAP_NV | \
1300                                   TEXGEN_NORMAL_MAP_NV     | \
1301                                   TEXGEN_EYE_LINEAR)
1302 /*@}*/
1303
1304
1305
1306 /** Tex-gen enabled for texture unit? */
1307 #define ENABLE_TEXGEN(unit) (1 << (unit))
1308
1309 /** Non-identity texture matrix for texture unit? */
1310 #define ENABLE_TEXMAT(unit) (1 << (unit))
1311
1312
1313 /**
1314  * Texture coord generation state.
1315  */
1316 struct gl_texgen
1317 {
1318    GLenum Mode;         /**< GL_EYE_LINEAR, GL_SPHERE_MAP, etc */
1319    GLbitfield _ModeBit; /**< TEXGEN_x bit corresponding to Mode */
1320    GLfloat ObjectPlane[4];
1321    GLfloat EyePlane[4];
1322 };
1323
1324
1325 /**
1326  * Texture unit state.  Contains enable flags, texture environment/function/
1327  * combiners, texgen state, and pointers to current texture objects.
1328  */
1329 struct gl_texture_unit
1330 {
1331    GLbitfield Enabled;          /**< bitmask of TEXTURE_*_BIT flags */
1332
1333    GLenum EnvMode;              /**< GL_MODULATE, GL_DECAL, GL_BLEND, etc. */
1334    GLclampf EnvColor[4];
1335    GLfloat EnvColorUnclamped[4];
1336
1337    struct gl_texgen GenS;
1338    struct gl_texgen GenT;
1339    struct gl_texgen GenR;
1340    struct gl_texgen GenQ;
1341    GLbitfield TexGenEnabled;    /**< Bitwise-OR of [STRQ]_BIT values */
1342    GLbitfield _GenFlags;        /**< Bitwise-OR of Gen[STRQ]._ModeBit */
1343
1344    GLfloat LodBias;             /**< for biasing mipmap levels */
1345
1346    /** Current sampler object (GL_ARB_sampler_objects) */
1347    struct gl_sampler_object *Sampler;
1348
1349    /** 
1350     * \name GL_EXT_texture_env_combine 
1351     */
1352    struct gl_tex_env_combine_state Combine;
1353
1354    /**
1355     * Derived state based on \c EnvMode and the \c BaseFormat of the
1356     * currently enabled texture.
1357     */
1358    struct gl_tex_env_combine_state _EnvMode;
1359
1360    /**
1361     * Currently enabled combiner state.  This will point to either
1362     * \c Combine or \c _EnvMode.
1363     */
1364    struct gl_tex_env_combine_state *_CurrentCombine;
1365
1366    /** Current texture object pointers */
1367    struct gl_texture_object *CurrentTex[NUM_TEXTURE_TARGETS];
1368
1369    /** Points to highest priority, complete and enabled texture object */
1370    struct gl_texture_object *_Current;
1371
1372    /** Texture targets that have a non-default texture bound */
1373    GLbitfield _BoundTextures;
1374 };
1375
1376
1377 /**
1378  * Texture attribute group (GL_TEXTURE_BIT).
1379  */
1380 struct gl_texture_attrib
1381 {
1382    GLuint CurrentUnit;   /**< GL_ACTIVE_TEXTURE */
1383    struct gl_texture_unit Unit[MAX_COMBINED_TEXTURE_IMAGE_UNITS];
1384
1385    struct gl_texture_object *ProxyTex[NUM_TEXTURE_TARGETS];
1386
1387    /** GL_ARB_texture_buffer_object */
1388    struct gl_buffer_object *BufferObject;
1389
1390    /** GL_ARB_seamless_cubemap */
1391    GLboolean CubeMapSeamless;
1392
1393    /** Texture coord units/sets used for fragment texturing */
1394    GLbitfield _EnabledCoordUnits;
1395
1396    /** Texture coord units that have texgen enabled */
1397    GLbitfield _TexGenEnabled;
1398
1399    /** Texture coord units that have non-identity matrices */
1400    GLbitfield _TexMatEnabled;
1401
1402    /** Bitwise-OR of all Texture.Unit[i]._GenFlags */
1403    GLbitfield _GenFlags;
1404
1405    /** Largest index of a texture unit with _Current != NULL. */
1406    GLint _MaxEnabledTexImageUnit;
1407
1408    /** Largest index + 1 of texture units that have had any CurrentTex set. */
1409    GLint NumCurrentTexUsed;
1410 };
1411
1412
1413 /**
1414  * Data structure representing a single clip plane (e.g. one of the elements
1415  * of the ctx->Transform.EyeUserPlane or ctx->Transform._ClipUserPlane array).
1416  */
1417 typedef GLfloat gl_clip_plane[4];
1418
1419
1420 /**
1421  * Transformation attribute group (GL_TRANSFORM_BIT).
1422  */
1423 struct gl_transform_attrib
1424 {
1425    GLenum MatrixMode;                           /**< Matrix mode */
1426    gl_clip_plane EyeUserPlane[MAX_CLIP_PLANES]; /**< User clip planes */
1427    gl_clip_plane _ClipUserPlane[MAX_CLIP_PLANES]; /**< derived */
1428    GLbitfield ClipPlanesEnabled;                /**< on/off bitmask */
1429    GLboolean Normalize;                         /**< Normalize all normals? */
1430    GLboolean RescaleNormals;                    /**< GL_EXT_rescale_normal */
1431    GLboolean RasterPositionUnclipped;           /**< GL_IBM_rasterpos_clip */
1432    GLboolean DepthClamp;                        /**< GL_ARB_depth_clamp */
1433    /** GL_ARB_clip_control */
1434    GLenum ClipOrigin;     /**< GL_LOWER_LEFT or GL_UPPER_LEFT */
1435    GLenum ClipDepthMode;  /**< GL_NEGATIVE_ONE_TO_ONE or GL_ZERO_TO_ONE */
1436 };
1437
1438
1439 /**
1440  * Viewport attribute group (GL_VIEWPORT_BIT).
1441  */
1442 struct gl_viewport_attrib
1443 {
1444    GLfloat X, Y;                /**< position */
1445    GLfloat Width, Height;       /**< size */
1446    GLdouble Near, Far;          /**< Depth buffer range */
1447    GLmatrix _WindowMap;         /**< Mapping transformation as a matrix. */
1448 };
1449
1450
1451 typedef enum {
1452    MAP_USER,
1453    MAP_INTERNAL,
1454
1455    MAP_COUNT
1456 } gl_map_buffer_index;
1457
1458
1459 /**
1460  * Fields describing a mapped buffer range.
1461  */
1462 struct gl_buffer_mapping {
1463    GLbitfield AccessFlags; /**< Mask of GL_MAP_x_BIT flags */
1464    GLvoid *Pointer;     /**< User-space address of mapping */
1465    GLintptr Offset;     /**< Mapped offset */
1466    GLsizeiptr Length;   /**< Mapped length */
1467 };
1468
1469
1470 /**
1471  * Usages we've seen for a buffer object.
1472  */
1473 typedef enum {
1474    USAGE_UNIFORM_BUFFER = 0x1,
1475    USAGE_TEXTURE_BUFFER = 0x2,
1476    USAGE_ATOMIC_COUNTER_BUFFER = 0x4,
1477 } gl_buffer_usage;
1478
1479
1480 /**
1481  * GL_ARB_vertex/pixel_buffer_object buffer object
1482  */
1483 struct gl_buffer_object
1484 {
1485    mtx_t Mutex;
1486    GLint RefCount;
1487    GLuint Name;
1488    GLchar *Label;       /**< GL_KHR_debug */
1489    GLenum Usage;        /**< GL_STREAM_DRAW_ARB, GL_STREAM_READ_ARB, etc. */
1490    GLbitfield StorageFlags; /**< GL_MAP_PERSISTENT_BIT, etc. */
1491    GLsizeiptrARB Size;  /**< Size of buffer storage in bytes */
1492    GLubyte *Data;       /**< Location of storage either in RAM or VRAM. */
1493    GLboolean DeletePending;   /**< true if buffer object is removed from the hash */
1494    GLboolean Written;   /**< Ever written to? (for debugging) */
1495    GLboolean Purgeable; /**< Is the buffer purgeable under memory pressure? */
1496    GLboolean Immutable; /**< GL_ARB_buffer_storage */
1497    gl_buffer_usage UsageHistory; /**< How has this buffer been used so far? */
1498
1499    struct gl_buffer_mapping Mappings[MAP_COUNT];
1500 };
1501
1502
1503 /**
1504  * Client pixel packing/unpacking attributes
1505  */
1506 struct gl_pixelstore_attrib
1507 {
1508    GLint Alignment;
1509    GLint RowLength;
1510    GLint SkipPixels;
1511    GLint SkipRows;
1512    GLint ImageHeight;
1513    GLint SkipImages;
1514    GLboolean SwapBytes;
1515    GLboolean LsbFirst;
1516    GLboolean Invert;        /**< GL_MESA_pack_invert */
1517    GLint CompressedBlockWidth;   /**< GL_ARB_compressed_texture_pixel_storage */
1518    GLint CompressedBlockHeight;
1519    GLint CompressedBlockDepth;
1520    GLint CompressedBlockSize;
1521    struct gl_buffer_object *BufferObj; /**< GL_ARB_pixel_buffer_object */
1522 };
1523
1524
1525 /**
1526  * Client vertex array attributes
1527  */
1528 struct gl_client_array
1529 {
1530    GLint Size;                  /**< components per element (1,2,3,4) */
1531    GLenum Type;                 /**< datatype: GL_FLOAT, GL_INT, etc */
1532    GLenum Format;               /**< default: GL_RGBA, but may be GL_BGRA */
1533    GLsizei Stride;              /**< user-specified stride */
1534    GLsizei StrideB;             /**< actual stride in bytes */
1535    const GLubyte *Ptr;          /**< Points to array data */
1536    GLboolean Enabled;           /**< Enabled flag is a boolean */
1537    GLboolean Normalized;        /**< GL_ARB_vertex_program */
1538    GLboolean Integer;           /**< Integer-valued? */
1539    GLuint InstanceDivisor;      /**< GL_ARB_instanced_arrays */
1540    GLuint _ElementSize;         /**< size of each element in bytes */
1541
1542    struct gl_buffer_object *BufferObj;/**< GL_ARB_vertex_buffer_object */
1543 };
1544
1545
1546 /**
1547  * Vertex attribute array as seen by the client.
1548  *
1549  * Contains the size, type, format and normalization flag,
1550  * along with the index of a vertex buffer binding point.
1551  *
1552  * Note that the Stride field corresponds to VERTEX_ATTRIB_ARRAY_STRIDE
1553  * and is only present for backwards compatibility reasons.
1554  * Rendering always uses VERTEX_BINDING_STRIDE.
1555  * The gl*Pointer() functions will set VERTEX_ATTRIB_ARRAY_STRIDE
1556  * and VERTEX_BINDING_STRIDE to the same value, while
1557  * glBindVertexBuffer() will only set VERTEX_BINDING_STRIDE.
1558  */
1559 struct gl_vertex_attrib_array
1560 {
1561    GLint Size;              /**< Components per element (1,2,3,4) */
1562    GLenum Type;             /**< Datatype: GL_FLOAT, GL_INT, etc */
1563    GLenum Format;           /**< Default: GL_RGBA, but may be GL_BGRA */
1564    GLsizei Stride;          /**< Stride as specified with gl*Pointer() */
1565    const GLubyte *Ptr;      /**< Points to client array data. Not used when a VBO is bound */
1566    GLintptr RelativeOffset; /**< Offset of the first element relative to the binding offset */
1567    GLboolean Enabled;       /**< Whether the array is enabled */
1568    GLboolean Normalized;    /**< Fixed-point values are normalized when converted to floats */
1569    GLboolean Integer;       /**< Fixed-point values are not converted to floats */
1570    GLuint _ElementSize;     /**< Size of each element in bytes */
1571    GLuint VertexBinding;    /**< Vertex buffer binding */
1572 };
1573
1574
1575 /**
1576  * This describes the buffer object used for a vertex array (or
1577  * multiple vertex arrays).  If BufferObj points to the default/null
1578  * buffer object, then the vertex array lives in user memory and not a VBO.
1579  */
1580 struct gl_vertex_buffer_binding
1581 {
1582    GLintptr Offset;                    /**< User-specified offset */
1583    GLsizei Stride;                     /**< User-specified stride */
1584    GLuint InstanceDivisor;             /**< GL_ARB_instanced_arrays */
1585    struct gl_buffer_object *BufferObj; /**< GL_ARB_vertex_buffer_object */
1586    GLbitfield64 _BoundArrays;          /**< Arrays bound to this binding point */
1587 };
1588
1589
1590 /**
1591  * A representation of "Vertex Array Objects" (VAOs) from OpenGL 3.1+,
1592  * GL_ARB_vertex_array_object, or the original GL_APPLE_vertex_array_object
1593  * extension.
1594  */
1595 struct gl_vertex_array_object
1596 {
1597    /** Name of the VAO as received from glGenVertexArray. */
1598    GLuint Name;
1599    GLchar *Label;       /**< GL_KHR_debug */
1600
1601    GLint RefCount;
1602    mtx_t Mutex;
1603
1604    /**
1605     * Does the VAO use ARB semantics or Apple semantics?
1606     *
1607     * There are several ways in which ARB_vertex_array_object and
1608     * APPLE_vertex_array_object VAOs have differing semantics.  At the very
1609     * least,
1610     *
1611     *     - ARB VAOs require that all array data be sourced from vertex buffer
1612     *       objects, but Apple VAOs do not.
1613     *
1614     *     - ARB VAOs require that names come from GenVertexArrays.
1615     *
1616     * This flag notes which behavior governs this VAO.
1617     */
1618    GLboolean ARBsemantics;
1619
1620    /**
1621     * Has this array object been bound?
1622     */
1623    GLboolean EverBound;
1624
1625    /**
1626     * Derived vertex attribute arrays
1627     *
1628     * This is a legacy data structure created from gl_vertex_attrib_array and
1629     * gl_vertex_buffer_binding, for compatibility with existing driver code.
1630     */
1631    struct gl_client_array _VertexAttrib[VERT_ATTRIB_MAX];
1632
1633    /** Vertex attribute arrays */
1634    struct gl_vertex_attrib_array VertexAttrib[VERT_ATTRIB_MAX];
1635
1636    /** Vertex buffer bindings */
1637    struct gl_vertex_buffer_binding VertexBinding[VERT_ATTRIB_MAX];
1638
1639    /** Mask of VERT_BIT_* values indicating which arrays are enabled */
1640    GLbitfield64 _Enabled;
1641
1642    /** Mask of VERT_BIT_* values indicating changed/dirty arrays */
1643    GLbitfield64 NewArrays;
1644
1645    /** The index buffer (also known as the element array buffer in OpenGL). */
1646    struct gl_buffer_object *IndexBufferObj;
1647 };
1648
1649
1650 /** Used to signal when transitioning from one kind of drawing method
1651  * to another.
1652  */
1653 typedef enum {
1654    DRAW_NONE,          /**< Initial value only */
1655    DRAW_BEGIN_END,
1656    DRAW_DISPLAY_LIST,
1657    DRAW_ARRAYS
1658 } gl_draw_method;
1659
1660
1661 /**
1662  * Vertex array state
1663  */
1664 struct gl_array_attrib
1665 {
1666    /** Currently bound array object. See _mesa_BindVertexArrayAPPLE() */
1667    struct gl_vertex_array_object *VAO;
1668
1669    /** The default vertex array object */
1670    struct gl_vertex_array_object *DefaultVAO;
1671
1672    /** Array objects (GL_ARB/APPLE_vertex_array_object) */
1673    struct _mesa_HashTable *Objects;
1674
1675    GLint ActiveTexture;         /**< Client Active Texture */
1676    GLuint LockFirst;            /**< GL_EXT_compiled_vertex_array */
1677    GLuint LockCount;            /**< GL_EXT_compiled_vertex_array */
1678
1679    /**
1680     * \name Primitive restart controls
1681     *
1682     * Primitive restart is enabled if either \c PrimitiveRestart or
1683     * \c PrimitiveRestartFixedIndex is set.
1684     */
1685    /*@{*/
1686    GLboolean PrimitiveRestart;
1687    GLboolean PrimitiveRestartFixedIndex;
1688    GLboolean _PrimitiveRestart;
1689    GLuint RestartIndex;
1690    /*@}*/
1691
1692    /* GL_ARB_vertex_buffer_object */
1693    struct gl_buffer_object *ArrayBufferObj;
1694
1695    /**
1696     * Vertex arrays as consumed by a driver.
1697     * The array pointer is set up only by the VBO module.
1698     */
1699    const struct gl_client_array **_DrawArrays; /**< 0..VERT_ATTRIB_MAX-1 */
1700
1701    /** One of the DRAW_xxx flags, not consumed by drivers */
1702    gl_draw_method DrawMethod;
1703
1704    /** Legal array datatypes */
1705    GLbitfield LegalTypesMask;
1706 };
1707
1708
1709 /**
1710  * Feedback buffer state
1711  */
1712 struct gl_feedback
1713 {
1714    GLenum Type;
1715    GLbitfield _Mask;    /**< FB_* bits */
1716    GLfloat *Buffer;
1717    GLuint BufferSize;
1718    GLuint Count;
1719 };
1720
1721
1722 /**
1723  * Selection buffer state
1724  */
1725 struct gl_selection
1726 {
1727    GLuint *Buffer;      /**< selection buffer */
1728    GLuint BufferSize;   /**< size of the selection buffer */
1729    GLuint BufferCount;  /**< number of values in the selection buffer */
1730    GLuint Hits;         /**< number of records in the selection buffer */
1731    GLuint NameStackDepth; /**< name stack depth */
1732    GLuint NameStack[MAX_NAME_STACK_DEPTH]; /**< name stack */
1733    GLboolean HitFlag;   /**< hit flag */
1734    GLfloat HitMinZ;     /**< minimum hit depth */
1735    GLfloat HitMaxZ;     /**< maximum hit depth */
1736 };
1737
1738
1739 /**
1740  * 1-D Evaluator control points
1741  */
1742 struct gl_1d_map
1743 {
1744    GLuint Order;        /**< Number of control points */
1745    GLfloat u1, u2, du;  /**< u1, u2, 1.0/(u2-u1) */
1746    GLfloat *Points;     /**< Points to contiguous control points */
1747 };
1748
1749
1750 /**
1751  * 2-D Evaluator control points
1752  */
1753 struct gl_2d_map
1754 {
1755    GLuint Uorder;               /**< Number of control points in U dimension */
1756    GLuint Vorder;               /**< Number of control points in V dimension */
1757    GLfloat u1, u2, du;
1758    GLfloat v1, v2, dv;
1759    GLfloat *Points;             /**< Points to contiguous control points */
1760 };
1761
1762
1763 /**
1764  * All evaluator control point state
1765  */
1766 struct gl_evaluators
1767 {
1768    /** 
1769     * \name 1-D maps
1770     */
1771    /*@{*/
1772    struct gl_1d_map Map1Vertex3;
1773    struct gl_1d_map Map1Vertex4;
1774    struct gl_1d_map Map1Index;
1775    struct gl_1d_map Map1Color4;
1776    struct gl_1d_map Map1Normal;
1777    struct gl_1d_map Map1Texture1;
1778    struct gl_1d_map Map1Texture2;
1779    struct gl_1d_map Map1Texture3;
1780    struct gl_1d_map Map1Texture4;
1781    /*@}*/
1782
1783    /** 
1784     * \name 2-D maps 
1785     */
1786    /*@{*/
1787    struct gl_2d_map Map2Vertex3;
1788    struct gl_2d_map Map2Vertex4;
1789    struct gl_2d_map Map2Index;
1790    struct gl_2d_map Map2Color4;
1791    struct gl_2d_map Map2Normal;
1792    struct gl_2d_map Map2Texture1;
1793    struct gl_2d_map Map2Texture2;
1794    struct gl_2d_map Map2Texture3;
1795    struct gl_2d_map Map2Texture4;
1796    /*@}*/
1797 };
1798
1799
1800 struct gl_transform_feedback_varying_info
1801 {
1802    char *Name;
1803    GLenum Type;
1804    GLint Size;
1805 };
1806
1807
1808 /**
1809  * Per-output info vertex shaders for transform feedback.
1810  */
1811 struct gl_transform_feedback_output
1812 {
1813    unsigned OutputRegister;
1814    unsigned OutputBuffer;
1815    unsigned NumComponents;
1816    unsigned StreamId;
1817
1818    /** offset (in DWORDs) of this output within the interleaved structure */
1819    unsigned DstOffset;
1820
1821    /**
1822     * Offset into the output register of the data to output.  For example,
1823     * if NumComponents is 2 and ComponentOffset is 1, then the data to
1824     * offset is in the y and z components of the output register.
1825     */
1826    unsigned ComponentOffset;
1827 };
1828
1829
1830 /** Post-link transform feedback info. */
1831 struct gl_transform_feedback_info
1832 {
1833    unsigned NumOutputs;
1834
1835    /**
1836     * Number of transform feedback buffers in use by this program.
1837     */
1838    unsigned NumBuffers;
1839
1840    struct gl_transform_feedback_output *Outputs;
1841
1842    /** Transform feedback varyings used for the linking of this shader program.
1843     *
1844     * Use for glGetTransformFeedbackVarying().
1845     */
1846    struct gl_transform_feedback_varying_info *Varyings;
1847    GLint NumVarying;
1848
1849    /**
1850     * Total number of components stored in each buffer.  This may be used by
1851     * hardware back-ends to determine the correct stride when interleaving
1852     * multiple transform feedback outputs in the same buffer.
1853     */
1854    unsigned BufferStride[MAX_FEEDBACK_BUFFERS];
1855 };
1856
1857
1858 /**
1859  * Transform feedback object state
1860  */
1861 struct gl_transform_feedback_object
1862 {
1863    GLuint Name;  /**< AKA the object ID */
1864    GLchar *Label;     /**< GL_KHR_debug */
1865    GLint RefCount;
1866    GLboolean Active;  /**< Is transform feedback enabled? */
1867    GLboolean Paused;  /**< Is transform feedback paused? */
1868    GLboolean EndedAnytime; /**< Has EndTransformFeedback been called
1869                                 at least once? */
1870    GLboolean EverBound; /**< Has this object been bound? */
1871
1872    /**
1873     * The shader program active when BeginTransformFeedback() was called.
1874     * When active and unpaused, this equals ctx->Shader.CurrentProgram[stage],
1875     * where stage is the pipeline stage that is the source of data for
1876     * transform feedback.
1877     */
1878    struct gl_shader_program *shader_program;
1879
1880    /**
1881     * GLES: if Active is true, remaining number of primitives which can be
1882     * rendered without overflow.  This is necessary to track because GLES
1883     * requires us to generate INVALID_OPERATION if a call to glDrawArrays or
1884     * glDrawArraysInstanced would overflow transform feedback buffers.
1885     * Undefined if Active is false.
1886     *
1887     * Not tracked for desktop GL since it's unnecessary.
1888     */
1889    unsigned GlesRemainingPrims;
1890
1891    /** The feedback buffers */
1892    GLuint BufferNames[MAX_FEEDBACK_BUFFERS];
1893    struct gl_buffer_object *Buffers[MAX_FEEDBACK_BUFFERS];
1894
1895    /** Start of feedback data in dest buffer */
1896    GLintptr Offset[MAX_FEEDBACK_BUFFERS];
1897
1898    /**
1899     * Max data to put into dest buffer (in bytes).  Computed based on
1900     * RequestedSize and the actual size of the buffer.
1901     */
1902    GLsizeiptr Size[MAX_FEEDBACK_BUFFERS];
1903
1904    /**
1905     * Size that was specified when the buffer was bound.  If the buffer was
1906     * bound with glBindBufferBase() or glBindBufferOffsetEXT(), this value is
1907     * zero.
1908     */
1909    GLsizeiptr RequestedSize[MAX_FEEDBACK_BUFFERS];
1910 };
1911
1912
1913 /**
1914  * Context state for transform feedback.
1915  */
1916 struct gl_transform_feedback_state
1917 {
1918    GLenum Mode;       /**< GL_POINTS, GL_LINES or GL_TRIANGLES */
1919
1920    /** The general binding point (GL_TRANSFORM_FEEDBACK_BUFFER) */
1921    struct gl_buffer_object *CurrentBuffer;
1922
1923    /** The table of all transform feedback objects */
1924    struct _mesa_HashTable *Objects;
1925
1926    /** The current xform-fb object (GL_TRANSFORM_FEEDBACK_BINDING) */
1927    struct gl_transform_feedback_object *CurrentObject;
1928
1929    /** The default xform-fb object (Name==0) */
1930    struct gl_transform_feedback_object *DefaultObject;
1931 };
1932
1933
1934 /**
1935  * A "performance monitor" as described in AMD_performance_monitor.
1936  */
1937 struct gl_perf_monitor_object
1938 {
1939    GLuint Name;
1940
1941    /** True if the monitor is currently active (Begin called but not End). */
1942    GLboolean Active;
1943
1944    /**
1945     * True if the monitor has ended.
1946     *
1947     * This is distinct from !Active because it may never have began.
1948     */
1949    GLboolean Ended;
1950
1951    /**
1952     * A list of groups with currently active counters.
1953     *
1954     * ActiveGroups[g] == n if there are n counters active from group 'g'.
1955     */
1956    unsigned *ActiveGroups;
1957
1958    /**
1959     * An array of bitsets, subscripted by group ID, then indexed by counter ID.
1960     *
1961     * Checking whether counter 'c' in group 'g' is active can be done via:
1962     *
1963     *    BITSET_TEST(ActiveCounters[g], c)
1964     */
1965    GLuint **ActiveCounters;
1966 };
1967
1968
1969 union gl_perf_monitor_counter_value
1970 {
1971    float f;
1972    uint64_t u64;
1973    uint32_t u32;
1974 };
1975
1976
1977 struct gl_perf_monitor_counter
1978 {
1979    /** Human readable name for the counter. */
1980    const char *Name;
1981
1982    /**
1983     * Data type of the counter.  Valid values are FLOAT, UNSIGNED_INT,
1984     * UNSIGNED_INT64_AMD, and PERCENTAGE_AMD.
1985     */
1986    GLenum Type;
1987
1988    /** Minimum counter value. */
1989    union gl_perf_monitor_counter_value Minimum;
1990
1991    /** Maximum counter value. */
1992    union gl_perf_monitor_counter_value Maximum;
1993 };
1994
1995
1996 struct gl_perf_monitor_group
1997 {
1998    /** Human readable name for the group. */
1999    const char *Name;
2000
2001    /**
2002     * Maximum number of counters in this group which can be active at the
2003     * same time.
2004     */
2005    GLuint MaxActiveCounters;
2006
2007    /** Array of counters within this group. */
2008    const struct gl_perf_monitor_counter *Counters;
2009    GLuint NumCounters;
2010 };
2011
2012
2013 /**
2014  * Context state for AMD_performance_monitor.
2015  */
2016 struct gl_perf_monitor_state
2017 {
2018    /** Array of performance monitor groups (indexed by group ID) */
2019    const struct gl_perf_monitor_group *Groups;
2020    GLuint NumGroups;
2021
2022    /** The table of all performance monitors. */
2023    struct _mesa_HashTable *Monitors;
2024 };
2025
2026
2027 /**
2028  * Names of the various vertex/fragment program register files, etc.
2029  *
2030  * NOTE: first four tokens must fit into 2 bits (see t_vb_arbprogram.c)
2031  * All values should fit in a 4-bit field.
2032  *
2033  * NOTE: PROGRAM_STATE_VAR, PROGRAM_CONSTANT, and PROGRAM_UNIFORM can all be
2034  * considered to be "uniform" variables since they can only be set outside
2035  * glBegin/End.  They're also all stored in the same Parameters array.
2036  */
2037 typedef enum
2038 {
2039    PROGRAM_TEMPORARY,   /**< machine->Temporary[] */
2040    PROGRAM_ARRAY,       /**< Arrays & Matrixes */
2041    PROGRAM_INPUT,       /**< machine->Inputs[] */
2042    PROGRAM_OUTPUT,      /**< machine->Outputs[] */
2043    PROGRAM_STATE_VAR,   /**< gl_program->Parameters[] */
2044    PROGRAM_CONSTANT,    /**< gl_program->Parameters[] */
2045    PROGRAM_UNIFORM,     /**< gl_program->Parameters[] */
2046    PROGRAM_WRITE_ONLY,  /**< A dummy, write-only register */
2047    PROGRAM_ADDRESS,     /**< machine->AddressReg */
2048    PROGRAM_SAMPLER,     /**< for shader samplers, compile-time only */
2049    PROGRAM_SYSTEM_VALUE,/**< InstanceId, PrimitiveID, etc. */
2050    PROGRAM_UNDEFINED,   /**< Invalid/TBD value */
2051    PROGRAM_FILE_MAX
2052 } gl_register_file;
2053
2054
2055 /**
2056  * If the register file is PROGRAM_SYSTEM_VALUE, the register index will be
2057  * one of these values.
2058  */
2059 typedef enum
2060 {
2061    /**
2062     * \name Vertex shader system values
2063     */
2064    /*@{*/
2065    /**
2066     * OpenGL-style vertex ID.
2067     *
2068     * Section 2.11.7 (Shader Execution), subsection Shader Inputs, of the
2069     * OpenGL 3.3 core profile spec says:
2070     *
2071     *     "gl_VertexID holds the integer index i implicitly passed by
2072     *     DrawArrays or one of the other drawing commands defined in section
2073     *     2.8.3."
2074     *
2075     * Section 2.8.3 (Drawing Commands) of the same spec says:
2076     *
2077     *     "The commands....are equivalent to the commands with the same base
2078     *     name (without the BaseVertex suffix), except that the ith element
2079     *     transferred by the corresponding draw call will be taken from
2080     *     element indices[i] + basevertex of each enabled array."
2081     *
2082     * Additionally, the overview in the GL_ARB_shader_draw_parameters spec
2083     * says:
2084     *
2085     *     "In unextended GL, vertex shaders have inputs named gl_VertexID and
2086     *     gl_InstanceID, which contain, respectively the index of the vertex
2087     *     and instance. The value of gl_VertexID is the implicitly passed
2088     *     index of the vertex being processed, which includes the value of
2089     *     baseVertex, for those commands that accept it."
2090     *
2091     * gl_VertexID gets basevertex added in.  This differs from DirectX where
2092     * SV_VertexID does \b not get basevertex added in.
2093     *
2094     * \note
2095     * If all system values are available, \c SYSTEM_VALUE_VERTEX_ID will be
2096     * equal to \c SYSTEM_VALUE_VERTEX_ID_ZERO_BASE plus
2097     * \c SYSTEM_VALUE_BASE_VERTEX.
2098     *
2099     * \sa SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, SYSTEM_VALUE_BASE_VERTEX
2100     */
2101    SYSTEM_VALUE_VERTEX_ID,
2102
2103    /**
2104     * Instanced ID as supplied to gl_InstanceID
2105     *
2106     * Values assigned to gl_InstanceID always begin with zero, regardless of
2107     * the value of baseinstance.
2108     *
2109     * Section 11.1.3.9 (Shader Inputs) of the OpenGL 4.4 core profile spec
2110     * says:
2111     *
2112     *     "gl_InstanceID holds the integer instance number of the current
2113     *     primitive in an instanced draw call (see section 10.5)."
2114     *
2115     * Through a big chain of pseudocode, section 10.5 describes that
2116     * baseinstance is not counted by gl_InstanceID.  In that section, notice
2117     *
2118     *     "If an enabled vertex attribute array is instanced (it has a
2119     *     non-zero divisor as specified by VertexAttribDivisor), the element
2120     *     index that is transferred to the GL, for all vertices, is given by
2121     *
2122     *         floor(instance/divisor) + baseinstance
2123     *
2124     *     If an array corresponding to an attribute required by a vertex
2125     *     shader is not enabled, then the corresponding element is taken from
2126     *     the current attribute state (see section 10.2)."
2127     *
2128     * Note that baseinstance is \b not included in the value of instance.
2129     */
2130    SYSTEM_VALUE_INSTANCE_ID,
2131
2132    /**
2133     * DirectX-style vertex ID.
2134     *
2135     * Unlike \c SYSTEM_VALUE_VERTEX_ID, this system value does \b not include
2136     * the value of basevertex.
2137     *
2138     * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_BASE_VERTEX
2139     */
2140    SYSTEM_VALUE_VERTEX_ID_ZERO_BASE,
2141
2142    /**
2143     * Value of \c basevertex passed to \c glDrawElementsBaseVertex and similar
2144     * functions.
2145     *
2146     * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_VERTEX_ID_ZERO_BASE
2147     */
2148    SYSTEM_VALUE_BASE_VERTEX,
2149    /*@}*/
2150
2151    /**
2152     * \name Geometry shader system values
2153     */
2154    /*@{*/
2155    SYSTEM_VALUE_INVOCATION_ID,
2156    /*@}*/
2157
2158    /**
2159     * \name Fragment shader system values
2160     */
2161    /*@{*/
2162    SYSTEM_VALUE_FRONT_FACE,     /**< (not done yet) */
2163    SYSTEM_VALUE_SAMPLE_ID,
2164    SYSTEM_VALUE_SAMPLE_POS,
2165    SYSTEM_VALUE_SAMPLE_MASK_IN,
2166    /*@}*/
2167
2168    SYSTEM_VALUE_MAX             /**< Number of values */
2169 } gl_system_value;
2170
2171
2172 /**
2173  * The possible interpolation qualifiers that can be applied to a fragment
2174  * shader input in GLSL.
2175  *
2176  * Note: INTERP_QUALIFIER_NONE must be 0 so that memsetting the
2177  * gl_fragment_program data structure to 0 causes the default behavior.
2178  */
2179 enum glsl_interp_qualifier
2180 {
2181    INTERP_QUALIFIER_NONE = 0,
2182    INTERP_QUALIFIER_SMOOTH,
2183    INTERP_QUALIFIER_FLAT,
2184    INTERP_QUALIFIER_NOPERSPECTIVE,
2185    INTERP_QUALIFIER_COUNT /**< Number of interpolation qualifiers */
2186 };
2187
2188
2189 /**
2190  * \brief Layout qualifiers for gl_FragDepth.
2191  *
2192  * Extension AMD_conservative_depth allows gl_FragDepth to be redeclared with
2193  * a layout qualifier.
2194  *
2195  * \see enum ir_depth_layout
2196  */
2197 enum gl_frag_depth_layout
2198 {
2199    FRAG_DEPTH_LAYOUT_NONE, /**< No layout is specified. */
2200    FRAG_DEPTH_LAYOUT_ANY,
2201    FRAG_DEPTH_LAYOUT_GREATER,
2202    FRAG_DEPTH_LAYOUT_LESS,
2203    FRAG_DEPTH_LAYOUT_UNCHANGED
2204 };
2205
2206
2207 /**
2208  * Base class for any kind of program object
2209  */
2210 struct gl_program
2211 {
2212    GLuint Id;
2213    GLubyte *String;  /**< Null-terminated program text */
2214    GLint RefCount;
2215    GLenum Target;    /**< GL_VERTEX/FRAGMENT_PROGRAM_ARB, GL_GEOMETRY_PROGRAM_NV */
2216    GLenum Format;    /**< String encoding format */
2217
2218    struct prog_instruction *Instructions;
2219
2220    GLbitfield64 InputsRead;     /**< Bitmask of which input regs are read */
2221    GLbitfield64 OutputsWritten; /**< Bitmask of which output regs are written */
2222    GLbitfield SystemValuesRead;   /**< Bitmask of SYSTEM_VALUE_x inputs used */
2223    GLbitfield InputFlags[MAX_PROGRAM_INPUTS];   /**< PROG_PARAM_BIT_x flags */
2224    GLbitfield OutputFlags[MAX_PROGRAM_OUTPUTS]; /**< PROG_PARAM_BIT_x flags */
2225    GLbitfield TexturesUsed[MAX_COMBINED_TEXTURE_IMAGE_UNITS];  /**< TEXTURE_x_BIT bitmask */
2226    GLbitfield SamplersUsed;   /**< Bitfield of which samplers are used */
2227    GLbitfield ShadowSamplers; /**< Texture units used for shadow sampling. */
2228
2229    GLboolean UsesGather; /**< Does this program use gather4 at all? */
2230
2231    /**
2232     * For vertex and geometry shaders, true if the program uses the
2233     * gl_ClipDistance output.  Ignored for fragment shaders.
2234     */
2235    GLboolean UsesClipDistanceOut;
2236
2237
2238    /** Named parameters, constants, etc. from program text */
2239    struct gl_program_parameter_list *Parameters;
2240
2241    /**
2242     * Local parameters used by the program.
2243     *
2244     * It's dynamically allocated because it is rarely used (just
2245     * assembly-style programs), and MAX_PROGRAM_LOCAL_PARAMS entries once it's
2246     * allocated.
2247     */
2248    GLfloat (*LocalParams)[4];
2249
2250    /** Map from sampler unit to texture unit (set by glUniform1i()) */
2251    GLubyte SamplerUnits[MAX_SAMPLERS];
2252
2253    /** Bitmask of which register files are read/written with indirect
2254     * addressing.  Mask of (1 << PROGRAM_x) bits.
2255     */
2256    GLbitfield IndirectRegisterFiles;
2257
2258    /** Logical counts */
2259    /*@{*/
2260    GLuint NumInstructions;
2261    GLuint NumTemporaries;
2262    GLuint NumParameters;
2263    GLuint NumAttributes;
2264    GLuint NumAddressRegs;
2265    GLuint NumAluInstructions;
2266    GLuint NumTexInstructions;
2267    GLuint NumTexIndirections;
2268    /*@}*/
2269    /** Native, actual h/w counts */
2270    /*@{*/
2271    GLuint NumNativeInstructions;
2272    GLuint NumNativeTemporaries;
2273    GLuint NumNativeParameters;
2274    GLuint NumNativeAttributes;
2275    GLuint NumNativeAddressRegs;
2276    GLuint NumNativeAluInstructions;
2277    GLuint NumNativeTexInstructions;
2278    GLuint NumNativeTexIndirections;
2279    /*@}*/
2280 };
2281
2282
2283 /** Vertex program object */
2284 struct gl_vertex_program
2285 {
2286    struct gl_program Base;   /**< base class */
2287    GLboolean IsPositionInvariant;
2288 };
2289
2290
2291 /** Geometry program object */
2292 struct gl_geometry_program
2293 {
2294    struct gl_program Base;   /**< base class */
2295
2296    GLint VerticesIn;
2297    GLint VerticesOut;
2298    GLint Invocations;
2299    GLenum InputType;  /**< GL_POINTS, GL_LINES, GL_LINES_ADJACENCY_ARB,
2300                            GL_TRIANGLES, or GL_TRIANGLES_ADJACENCY_ARB */
2301    GLenum OutputType; /**< GL_POINTS, GL_LINE_STRIP or GL_TRIANGLE_STRIP */
2302    bool UsesEndPrimitive;
2303    bool UsesStreams;
2304 };
2305
2306
2307 /** Fragment program object */
2308 struct gl_fragment_program
2309 {
2310    struct gl_program Base;   /**< base class */
2311    GLboolean UsesKill;          /**< shader uses KIL instruction */
2312    GLboolean UsesDFdy;          /**< shader uses DDY instruction */
2313    GLboolean OriginUpperLeft;
2314    GLboolean PixelCenterInteger;
2315    enum gl_frag_depth_layout FragDepthLayout;
2316
2317    /**
2318     * GLSL interpolation qualifier associated with each fragment shader input.
2319     * For inputs that do not have an interpolation qualifier specified in
2320     * GLSL, the value is INTERP_QUALIFIER_NONE.
2321     */
2322    enum glsl_interp_qualifier InterpQualifier[VARYING_SLOT_MAX];
2323
2324    /**
2325     * Bitfield indicating, for each fragment shader input, 1 if that input
2326     * uses centroid interpolation, 0 otherwise.  Unused inputs are 0.
2327     */
2328    GLbitfield64 IsCentroid;
2329
2330    /**
2331     * Bitfield indicating, for each fragment shader input, 1 if that input
2332     * uses sample interpolation, 0 otherwise.  Unused inputs are 0.
2333     */
2334    GLbitfield64 IsSample;
2335 };
2336
2337
2338 /** Compute program object */
2339 struct gl_compute_program
2340 {
2341    struct gl_program Base;   /**< base class */
2342
2343    /**
2344     * Size specified using local_size_{x,y,z}.
2345     */
2346    unsigned LocalSize[3];
2347 };
2348
2349
2350 /**
2351  * State common to vertex and fragment programs.
2352  */
2353 struct gl_program_state
2354 {
2355    GLint ErrorPos;                       /* GL_PROGRAM_ERROR_POSITION_ARB/NV */
2356    const char *ErrorString;              /* GL_PROGRAM_ERROR_STRING_ARB/NV */
2357 };
2358
2359
2360 /**
2361  * Context state for vertex programs.
2362  */
2363 struct gl_vertex_program_state
2364 {
2365    GLboolean Enabled;            /**< User-set GL_VERTEX_PROGRAM_ARB/NV flag */
2366    GLboolean _Enabled;           /**< Enabled and _valid_ user program? */
2367    GLboolean PointSizeEnabled;   /**< GL_VERTEX_PROGRAM_POINT_SIZE_ARB/NV */
2368    GLboolean TwoSideEnabled;     /**< GL_VERTEX_PROGRAM_TWO_SIDE_ARB/NV */
2369    /** Computed two sided lighting for fixed function/programs. */
2370    GLboolean _TwoSideEnabled;
2371    struct gl_vertex_program *Current;  /**< User-bound vertex program */
2372
2373    /** Currently enabled and valid vertex program (including internal
2374     * programs, user-defined vertex programs and GLSL vertex shaders).
2375     * This is the program we must use when rendering.
2376     */
2377    struct gl_vertex_program *_Current;
2378
2379    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
2380
2381    /** Should fixed-function T&L be implemented with a vertex prog? */
2382    GLboolean _MaintainTnlProgram;
2383
2384    /** Program to emulate fixed-function T&L (see above) */
2385    struct gl_vertex_program *_TnlProgram;
2386
2387    /** Cache of fixed-function programs */
2388    struct gl_program_cache *Cache;
2389
2390    GLboolean _Overriden;
2391 };
2392
2393
2394 /**
2395  * Context state for geometry programs.
2396  */
2397 struct gl_geometry_program_state
2398 {
2399    GLboolean Enabled;               /**< GL_ARB_GEOMETRY_SHADER4 */
2400    GLboolean _Enabled;              /**< Enabled and valid program? */
2401    struct gl_geometry_program *Current;  /**< user-bound geometry program */
2402
2403    /** Currently enabled and valid program (including internal programs
2404     * and compiled shader programs).
2405     */
2406    struct gl_geometry_program *_Current;
2407
2408    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
2409 };
2410
2411 /**
2412  * Context state for fragment programs.
2413  */
2414 struct gl_fragment_program_state
2415 {
2416    GLboolean Enabled;     /**< User-set fragment program enable flag */
2417    GLboolean _Enabled;    /**< Enabled and _valid_ user program? */
2418    struct gl_fragment_program *Current;  /**< User-bound fragment program */
2419
2420    /** Currently enabled and valid fragment program (including internal
2421     * programs, user-defined fragment programs and GLSL fragment shaders).
2422     * This is the program we must use when rendering.
2423     */
2424    struct gl_fragment_program *_Current;
2425
2426    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
2427
2428    /** Should fixed-function texturing be implemented with a fragment prog? */
2429    GLboolean _MaintainTexEnvProgram;
2430
2431    /** Program to emulate fixed-function texture env/combine (see above) */
2432    struct gl_fragment_program *_TexEnvProgram;
2433
2434    /** Cache of fixed-function programs */
2435    struct gl_program_cache *Cache;
2436 };
2437
2438
2439 /**
2440  * Context state for compute programs.
2441  */
2442 struct gl_compute_program_state
2443 {
2444    struct gl_compute_program *Current;  /**< user-bound compute program */
2445
2446    /** Currently enabled and valid program (including internal programs
2447     * and compiled shader programs).
2448     */
2449    struct gl_compute_program *_Current;
2450 };
2451
2452
2453 /**
2454  * ATI_fragment_shader runtime state
2455  */
2456 #define ATI_FS_INPUT_PRIMARY 0
2457 #define ATI_FS_INPUT_SECONDARY 1
2458
2459 struct atifs_instruction;
2460 struct atifs_setupinst;
2461
2462 /**
2463  * ATI fragment shader
2464  */
2465 struct ati_fragment_shader
2466 {
2467    GLuint Id;
2468    GLint RefCount;
2469    struct atifs_instruction *Instructions[2];
2470    struct atifs_setupinst *SetupInst[2];
2471    GLfloat Constants[8][4];
2472    GLbitfield LocalConstDef;  /**< Indicates which constants have been set */
2473    GLubyte numArithInstr[2];
2474    GLubyte regsAssigned[2];
2475    GLubyte NumPasses;         /**< 1 or 2 */
2476    GLubyte cur_pass;
2477    GLubyte last_optype;
2478    GLboolean interpinp1;
2479    GLboolean isValid;
2480    GLuint swizzlerq;
2481 };
2482
2483 /**
2484  * Context state for GL_ATI_fragment_shader
2485  */
2486 struct gl_ati_fragment_shader_state
2487 {
2488    GLboolean Enabled;
2489    GLboolean _Enabled;                  /**< enabled and valid shader? */
2490    GLboolean Compiling;
2491    GLfloat GlobalConstants[8][4];
2492    struct ati_fragment_shader *Current;
2493 };
2494
2495
2496 /** Set by #pragma directives */
2497 struct gl_sl_pragmas
2498 {
2499    GLboolean IgnoreOptimize;  /**< ignore #pragma optimize(on/off) ? */
2500    GLboolean IgnoreDebug;     /**< ignore #pragma debug(on/off) ? */
2501    GLboolean Optimize;  /**< defaults on */
2502    GLboolean Debug;     /**< defaults off */
2503 };
2504
2505
2506 /**
2507  * A GLSL vertex or fragment shader object.
2508  */
2509 struct gl_shader
2510 {
2511    /** GL_FRAGMENT_SHADER || GL_VERTEX_SHADER || GL_GEOMETRY_SHADER_ARB.
2512     * Must be the first field.
2513     */
2514    GLenum Type;
2515    gl_shader_stage Stage;
2516    GLuint Name;  /**< AKA the handle */
2517    GLchar *Label;   /**< GL_KHR_debug */
2518    GLint RefCount;  /**< Reference count */
2519    GLboolean DeletePending;
2520    GLboolean CompileStatus;
2521    const GLchar *Source;  /**< Source code string */
2522    GLuint SourceChecksum;       /**< for debug/logging purposes */
2523    struct gl_program *Program;  /**< Post-compile assembly code */
2524    GLchar *InfoLog;
2525    struct gl_sl_pragmas Pragmas;
2526
2527    unsigned Version;       /**< GLSL version used for linking */
2528    GLboolean IsES;         /**< True if this shader uses GLSL ES */
2529
2530    /**
2531     * \name Sampler tracking
2532     *
2533     * \note Each of these fields is only set post-linking.
2534     */
2535    /*@{*/
2536    unsigned num_samplers;       /**< Number of samplers used by this shader. */
2537    GLbitfield active_samplers;  /**< Bitfield of which samplers are used */
2538    GLbitfield shadow_samplers;  /**< Samplers used for shadow sampling. */
2539    /*@}*/
2540
2541    /**
2542     * Map from sampler unit to texture unit (set by glUniform1i())
2543     *
2544     * A sampler unit is associated with each sampler uniform by the linker.
2545     * The sampler unit associated with each uniform is stored in the
2546     * \c gl_uniform_storage::sampler field.
2547     */
2548    GLubyte SamplerUnits[MAX_SAMPLERS];
2549    /** Which texture target is being sampled (TEXTURE_1D/2D/3D/etc_INDEX) */
2550    gl_texture_index SamplerTargets[MAX_SAMPLERS];
2551
2552    /**
2553     * Number of default uniform block components used by this shader.
2554     *
2555     * This field is only set post-linking.
2556     */
2557    unsigned num_uniform_components;
2558
2559    /**
2560     * Number of combined uniform components used by this shader.
2561     *
2562     * This field is only set post-linking.  It is the sum of the uniform block
2563     * sizes divided by sizeof(float), and num_uniform_compoennts.
2564     */
2565    unsigned num_combined_uniform_components;
2566
2567    /**
2568     * This shader's uniform block information.
2569     *
2570     * These fields are only set post-linking.
2571     */
2572    struct gl_uniform_block *UniformBlocks;
2573    unsigned NumUniformBlocks;
2574
2575    struct exec_list *ir;
2576    struct glsl_symbol_table *symbols;
2577
2578    bool uses_builtin_functions;
2579    bool uses_gl_fragcoord;
2580    bool redeclares_gl_fragcoord;
2581    bool ARB_fragment_coord_conventions_enable;
2582
2583    /**
2584     * Fragment shader state from GLSL 1.50 layout qualifiers.
2585     */
2586    bool origin_upper_left;
2587    bool pixel_center_integer;
2588
2589    /**
2590     * Geometry shader state from GLSL 1.50 layout qualifiers.
2591     */
2592    struct {
2593       GLint VerticesOut;
2594       /**
2595        * 0 - Invocations count not declared in shader, or
2596        * 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS
2597        */
2598       GLint Invocations;
2599       /**
2600        * GL_POINTS, GL_LINES, GL_LINES_ADJACENCY, GL_TRIANGLES, or
2601        * GL_TRIANGLES_ADJACENCY, or PRIM_UNKNOWN if it's not set in this
2602        * shader.
2603        */
2604       GLenum InputType;
2605        /**
2606         * GL_POINTS, GL_LINE_STRIP or GL_TRIANGLE_STRIP, or PRIM_UNKNOWN if
2607         * it's not set in this shader.
2608         */
2609       GLenum OutputType;
2610    } Geom;
2611
2612    /**
2613     * Map from image uniform index to image unit (set by glUniform1i())
2614     *
2615     * An image uniform index is associated with each image uniform by
2616     * the linker.  The image index associated with each uniform is
2617     * stored in the \c gl_uniform_storage::image field.
2618     */
2619    GLubyte ImageUnits[MAX_IMAGE_UNIFORMS];
2620
2621    /**
2622     * Access qualifier specified in the shader for each image uniform
2623     * index.  Either \c GL_READ_ONLY, \c GL_WRITE_ONLY or \c
2624     * GL_READ_WRITE.
2625     *
2626     * It may be different, though only more strict than the value of
2627     * \c gl_image_unit::Access for the corresponding image unit.
2628     */
2629    GLenum ImageAccess[MAX_IMAGE_UNIFORMS];
2630
2631    /**
2632     * Number of image uniforms defined in the shader.  It specifies
2633     * the number of valid elements in the \c ImageUnits and \c
2634     * ImageAccess arrays above.
2635     */
2636    GLuint NumImages;
2637
2638    /**
2639     * Compute shader state from ARB_compute_shader layout qualifiers.
2640     */
2641    struct {
2642       /**
2643        * Size specified using local_size_{x,y,z}, or all 0's to indicate that
2644        * it's not set in this shader.
2645        */
2646       unsigned LocalSize[3];
2647    } Comp;
2648 };
2649
2650
2651 struct gl_uniform_buffer_variable
2652 {
2653    char *Name;
2654
2655    /**
2656     * Name of the uniform as seen by glGetUniformIndices.
2657     *
2658     * glGetUniformIndices requires that the block instance index \b not be
2659     * present in the name of queried uniforms.
2660     *
2661     * \note
2662     * \c gl_uniform_buffer_variable::IndexName and
2663     * \c gl_uniform_buffer_variable::Name may point to identical storage.
2664     */
2665    char *IndexName;
2666
2667    const struct glsl_type *Type;
2668    unsigned int Offset;
2669    GLboolean RowMajor;
2670 };
2671
2672
2673 enum gl_uniform_block_packing
2674 {
2675    ubo_packing_std140,
2676    ubo_packing_shared,
2677    ubo_packing_packed
2678 };
2679
2680
2681 struct gl_uniform_block
2682 {
2683    /** Declared name of the uniform block */
2684    char *Name;
2685
2686    /** Array of supplemental information about UBO ir_variables. */
2687    struct gl_uniform_buffer_variable *Uniforms;
2688    GLuint NumUniforms;
2689
2690    /**
2691     * Index (GL_UNIFORM_BLOCK_BINDING) into ctx->UniformBufferBindings[] to use
2692     * with glBindBufferBase to bind a buffer object to this uniform block.  When
2693     * updated in the program, _NEW_BUFFER_OBJECT will be set.
2694     */
2695    GLuint Binding;
2696
2697    /**
2698     * Minimum size (in bytes) of a buffer object to back this uniform buffer
2699     * (GL_UNIFORM_BLOCK_DATA_SIZE).
2700     */
2701    GLuint UniformBufferSize;
2702
2703    /**
2704     * Layout specified in the shader
2705     *
2706     * This isn't accessible through the API, but it is used while
2707     * cross-validating uniform blocks.
2708     */
2709    enum gl_uniform_block_packing _Packing;
2710 };
2711
2712 /**
2713  * Structure that represents a reference to an atomic buffer from some
2714  * shader program.
2715  */
2716 struct gl_active_atomic_buffer
2717 {
2718    /** Uniform indices of the atomic counters declared within it. */
2719    GLuint *Uniforms;
2720    GLuint NumUniforms;
2721
2722    /** Binding point index associated with it. */
2723    GLuint Binding;
2724
2725    /** Minimum reasonable size it is expected to have. */
2726    GLuint MinimumSize;
2727
2728    /** Shader stages making use of it. */
2729    GLboolean StageReferences[MESA_SHADER_STAGES];
2730 };
2731
2732 /**
2733  * A GLSL program object.
2734  * Basically a linked collection of vertex and fragment shaders.
2735  */
2736 struct gl_shader_program
2737 {
2738    GLenum Type;  /**< Always GL_SHADER_PROGRAM (internal token) */
2739    GLuint Name;  /**< aka handle or ID */
2740    GLchar *Label;   /**< GL_KHR_debug */
2741    GLint RefCount;  /**< Reference count */
2742    GLboolean DeletePending;
2743
2744    /**
2745     * Is the application intending to glGetProgramBinary this program?
2746     */
2747    GLboolean BinaryRetreivableHint;
2748
2749    /**
2750     * Indicates whether program can be bound for individual pipeline stages
2751     * using UseProgramStages after it is next linked.
2752     */
2753    GLboolean SeparateShader;
2754
2755    GLuint NumShaders;          /**< number of attached shaders */
2756    struct gl_shader **Shaders; /**< List of attached the shaders */
2757
2758    /**
2759     * User-defined attribute bindings
2760     *
2761     * These are set via \c glBindAttribLocation and are used to direct the
2762     * GLSL linker.  These are \b not the values used in the compiled shader,
2763     * and they are \b not the values returned by \c glGetAttribLocation.
2764     */
2765    struct string_to_uint_map *AttributeBindings;
2766
2767    /**
2768     * User-defined fragment data bindings
2769     *
2770     * These are set via \c glBindFragDataLocation and are used to direct the
2771     * GLSL linker.  These are \b not the values used in the compiled shader,
2772     * and they are \b not the values returned by \c glGetFragDataLocation.
2773     */
2774    struct string_to_uint_map *FragDataBindings;
2775    struct string_to_uint_map *FragDataIndexBindings;
2776
2777    /**
2778     * Transform feedback varyings last specified by
2779     * glTransformFeedbackVaryings().
2780     *
2781     * For the current set of transform feedback varyings used for transform
2782     * feedback output, see LinkedTransformFeedback.
2783     */
2784    struct {
2785       GLenum BufferMode;
2786       GLuint NumVarying;
2787       GLchar **VaryingNames;  /**< Array [NumVarying] of char * */
2788    } TransformFeedback;
2789
2790    /** Post-link transform feedback info. */
2791    struct gl_transform_feedback_info LinkedTransformFeedback;
2792
2793    /** Post-link gl_FragDepth layout for ARB_conservative_depth. */
2794    enum gl_frag_depth_layout FragDepthLayout;
2795
2796    /**
2797     * Geometry shader state - copied into gl_geometry_program by
2798     * _mesa_copy_linked_program_data().
2799     */
2800    struct {
2801       GLint VerticesIn;
2802       GLint VerticesOut;
2803       /**
2804        * 1 .. MAX_GEOMETRY_SHADER_INVOCATIONS
2805        */
2806       GLint Invocations;
2807       GLenum InputType;  /**< GL_POINTS, GL_LINES, GL_LINES_ADJACENCY_ARB,
2808                               GL_TRIANGLES, or GL_TRIANGLES_ADJACENCY_ARB */
2809       GLenum OutputType; /**< GL_POINTS, GL_LINE_STRIP or GL_TRIANGLE_STRIP */
2810       /**
2811        * True if gl_ClipDistance is written to.  Copied into
2812        * gl_geometry_program by _mesa_copy_linked_program_data().
2813        */
2814       GLboolean UsesClipDistance;
2815       GLuint ClipDistanceArraySize; /**< Size of the gl_ClipDistance array, or
2816                                          0 if not present. */
2817       bool UsesEndPrimitive;
2818       bool UsesStreams;
2819    } Geom;
2820
2821    /** Vertex shader state */
2822    struct {
2823       /**
2824        * True if gl_ClipDistance is written to.  Copied into gl_vertex_program
2825        * by _mesa_copy_linked_program_data().
2826        */
2827       GLboolean UsesClipDistance;
2828       GLuint ClipDistanceArraySize; /**< Size of the gl_ClipDistance array, or
2829                                          0 if not present. */
2830    } Vert;
2831
2832    /**
2833     * Compute shader state - copied into gl_compute_program by
2834     * _mesa_copy_linked_program_data().
2835     */
2836    struct {
2837       /**
2838        * If this shader contains a compute stage, size specified using
2839        * local_size_{x,y,z}.  Otherwise undefined.
2840        */
2841       unsigned LocalSize[3];
2842    } Comp;
2843
2844    /* post-link info: */
2845    unsigned NumUserUniformStorage;
2846    struct gl_uniform_storage *UniformStorage;
2847
2848    /**
2849     * Mapping from GL uniform locations returned by \c glUniformLocation to
2850     * UniformStorage entries. Arrays will have multiple contiguous slots
2851     * in the UniformRemapTable, all pointing to the same UniformStorage entry.
2852     */
2853    unsigned NumUniformRemapTable;
2854    struct gl_uniform_storage **UniformRemapTable;
2855
2856    /**
2857     * Size of the gl_ClipDistance array that is output from the last pipeline
2858     * stage before the fragment shader.
2859     */
2860    unsigned LastClipDistanceArraySize;
2861
2862    struct gl_uniform_block *UniformBlocks;
2863    unsigned NumUniformBlocks;
2864
2865    /**
2866     * Indices into the _LinkedShaders's UniformBlocks[] array for each stage
2867     * they're used in, or -1.
2868     *
2869     * This is used to maintain the Binding values of the stage's UniformBlocks[]
2870     * and to answer the GL_UNIFORM_BLOCK_REFERENCED_BY_*_SHADER queries.
2871     */
2872    int *UniformBlockStageIndex[MESA_SHADER_STAGES];
2873
2874    /**
2875     * Map of active uniform names to locations
2876     *
2877     * Maps any active uniform that is not an array element to a location.
2878     * Each active uniform, including individual structure members will appear
2879     * in this map.  This roughly corresponds to the set of names that would be
2880     * enumerated by \c glGetActiveUniform.
2881     */
2882    struct string_to_uint_map *UniformHash;
2883
2884    struct gl_active_atomic_buffer *AtomicBuffers;
2885    unsigned NumAtomicBuffers;
2886
2887    GLboolean LinkStatus;   /**< GL_LINK_STATUS */
2888    GLboolean Validated;
2889    GLboolean _Used;        /**< Ever used for drawing? */
2890    GLboolean SamplersValidated; /**< Samplers validated against texture units? */
2891    GLchar *InfoLog;
2892
2893    unsigned Version;       /**< GLSL version used for linking */
2894    GLboolean IsES;         /**< True if this program uses GLSL ES */
2895
2896    /**
2897     * Per-stage shaders resulting from the first stage of linking.
2898     *
2899     * Set of linked shaders for this program.  The array is accessed using the
2900     * \c MESA_SHADER_* defines.  Entries for non-existent stages will be
2901     * \c NULL.
2902     */
2903    struct gl_shader *_LinkedShaders[MESA_SHADER_STAGES];
2904
2905    /* True if any of the fragment shaders attached to this program use:
2906     * #extension ARB_fragment_coord_conventions: enable
2907     */
2908    GLboolean ARB_fragment_coord_conventions_enable;
2909 };   
2910
2911
2912 #define GLSL_DUMP      0x1  /**< Dump shaders to stdout */
2913 #define GLSL_LOG       0x2  /**< Write shaders to files */
2914 #define GLSL_OPT       0x4  /**< Force optimizations (override pragmas) */
2915 #define GLSL_NO_OPT    0x8  /**< Force no optimizations (override pragmas) */
2916 #define GLSL_UNIFORMS 0x10  /**< Print glUniform calls */
2917 #define GLSL_NOP_VERT 0x20  /**< Force no-op vertex shaders */
2918 #define GLSL_NOP_FRAG 0x40  /**< Force no-op fragment shaders */
2919 #define GLSL_USE_PROG 0x80  /**< Log glUseProgram calls */
2920 #define GLSL_REPORT_ERRORS 0x100  /**< Print compilation errors */
2921 #define GLSL_DUMP_ON_ERROR 0x200 /**< Dump shaders to stderr on compile error */
2922
2923
2924 /**
2925  * Context state for GLSL vertex/fragment shaders.
2926  * Extended to support pipeline object
2927  */
2928 struct gl_pipeline_object
2929 {
2930    /** Name of the pipeline object as received from glGenProgramPipelines.
2931     * It would be 0 for shaders without separate shader objects.
2932     */
2933    GLuint Name;
2934
2935    GLint RefCount;
2936
2937    mtx_t Mutex;
2938
2939    /**
2940     * Programs used for rendering
2941     *
2942     * There is a separate program set for each shader stage.
2943     */
2944    struct gl_shader_program *CurrentProgram[MESA_SHADER_STAGES];
2945
2946    struct gl_shader_program *_CurrentFragmentProgram;
2947
2948    /**
2949     * Program used by glUniform calls.
2950     *
2951     * Explicitly set by \c glUseProgram and \c glActiveProgramEXT.
2952     */
2953    struct gl_shader_program *ActiveProgram;
2954
2955    GLbitfield Flags;                    /**< Mask of GLSL_x flags */
2956
2957    GLboolean EverBound;                 /**< Has the pipeline object been created */
2958
2959    GLboolean Validated;                 /**< Pipeline Validation status */
2960
2961    GLchar *InfoLog;
2962 };
2963
2964 /**
2965  * Context state for GLSL pipeline shaders.
2966  */
2967 struct gl_pipeline_shader_state
2968 {
2969    /** Currently bound pipeline object. See _mesa_BindProgramPipeline() */
2970    struct gl_pipeline_object *Current;
2971
2972    /* Default Object to ensure that _Shader is never NULL */
2973    struct gl_pipeline_object *Default;
2974
2975    /** Pipeline objects */
2976    struct _mesa_HashTable *Objects;
2977 };
2978
2979 /**
2980  * Compiler options for a single GLSL shaders type
2981  */
2982 struct gl_shader_compiler_options
2983 {
2984    /** Driver-selectable options: */
2985    GLboolean EmitCondCodes;             /**< Use condition codes? */
2986    GLboolean EmitNoLoops;
2987    GLboolean EmitNoFunctions;
2988    GLboolean EmitNoCont;                  /**< Emit CONT opcode? */
2989    GLboolean EmitNoMainReturn;            /**< Emit CONT/RET opcodes? */
2990    GLboolean EmitNoNoise;                 /**< Emit NOISE opcodes? */
2991    GLboolean EmitNoPow;                   /**< Emit POW opcodes? */
2992    GLboolean LowerClipDistance; /**< Lower gl_ClipDistance from float[8] to vec4[2]? */
2993
2994    /**
2995     * \name Forms of indirect addressing the driver cannot do.
2996     */
2997    /*@{*/
2998    GLboolean EmitNoIndirectInput;   /**< No indirect addressing of inputs */
2999    GLboolean EmitNoIndirectOutput;  /**< No indirect addressing of outputs */
3000    GLboolean EmitNoIndirectTemp;    /**< No indirect addressing of temps */
3001    GLboolean EmitNoIndirectUniform; /**< No indirect addressing of constants */
3002    /*@}*/
3003
3004    GLuint MaxIfDepth;               /**< Maximum nested IF blocks */
3005    GLuint MaxUnrollIterations;
3006
3007    /**
3008     * Optimize code for array of structures backends.
3009     *
3010     * This is a proxy for:
3011     *   - preferring DP4 instructions (rather than MUL/MAD) for
3012     *     matrix * vector operations, such as position transformation.
3013     */
3014    GLboolean OptimizeForAOS;
3015
3016    struct gl_sl_pragmas DefaultPragmas; /**< Default #pragma settings */
3017 };
3018
3019
3020 /**
3021  * Occlusion/timer query object.
3022  */
3023 struct gl_query_object
3024 {
3025    GLenum Target;      /**< The query target, when active */
3026    GLuint Id;          /**< hash table ID/name */
3027    GLchar *Label;       /**< GL_KHR_debug */
3028    GLuint64EXT Result; /**< the counter */
3029    GLboolean Active;   /**< inside Begin/EndQuery */
3030    GLboolean Ready;    /**< result is ready? */
3031    GLboolean EverBound;/**< has query object ever been bound */
3032    GLuint Stream;      /**< The stream */
3033 };
3034
3035
3036 /**
3037  * Context state for query objects.
3038  */
3039 struct gl_query_state
3040 {
3041    struct _mesa_HashTable *QueryObjects;
3042    struct gl_query_object *CurrentOcclusionObject; /* GL_ARB_occlusion_query */
3043    struct gl_query_object *CurrentTimerObject;     /* GL_EXT_timer_query */
3044
3045    /** GL_NV_conditional_render */
3046    struct gl_query_object *CondRenderQuery;
3047
3048    /** GL_EXT_transform_feedback */
3049    struct gl_query_object *PrimitivesGenerated[MAX_VERTEX_STREAMS];
3050    struct gl_query_object *PrimitivesWritten[MAX_VERTEX_STREAMS];
3051
3052    /** GL_ARB_timer_query */
3053    struct gl_query_object *TimeElapsed;
3054
3055    GLenum CondRenderMode;
3056 };
3057
3058
3059 /** Sync object state */
3060 struct gl_sync_object
3061 {
3062    GLenum Type;               /**< GL_SYNC_FENCE */
3063    GLuint Name;               /**< Fence name */
3064    GLchar *Label;             /**< GL_KHR_debug */
3065    GLint RefCount;            /**< Reference count */
3066    GLboolean DeletePending;   /**< Object was deleted while there were still
3067                                * live references (e.g., sync not yet finished)
3068                                */
3069    GLenum SyncCondition;
3070    GLbitfield Flags;          /**< Flags passed to glFenceSync */
3071    GLuint StatusFlag:1;       /**< Has the sync object been signaled? */
3072 };
3073
3074
3075 /**
3076  * State which can be shared by multiple contexts:
3077  */
3078 struct gl_shared_state
3079 {
3080    mtx_t Mutex;            /**< for thread safety */
3081    GLint RefCount;                         /**< Reference count */
3082    struct _mesa_HashTable *DisplayList;    /**< Display lists hash table */
3083    struct _mesa_HashTable *TexObjects;     /**< Texture objects hash table */
3084
3085    /** Default texture objects (shared by all texture units) */
3086    struct gl_texture_object *DefaultTex[NUM_TEXTURE_TARGETS];
3087
3088    /** Fallback texture used when a bound texture is incomplete */
3089    struct gl_texture_object *FallbackTex[NUM_TEXTURE_TARGETS];
3090
3091    /**
3092     * \name Thread safety and statechange notification for texture
3093     * objects. 
3094     *
3095     * \todo Improve the granularity of locking.
3096     */
3097    /*@{*/
3098    mtx_t TexMutex;              /**< texobj thread safety */
3099    GLuint TextureStateStamp;            /**< state notification for shared tex */
3100    /*@}*/
3101
3102    /** Default buffer object for vertex arrays that aren't in VBOs */
3103    struct gl_buffer_object *NullBufferObj;
3104
3105    /**
3106     * \name Vertex/geometry/fragment programs
3107     */
3108    /*@{*/
3109    struct _mesa_HashTable *Programs; /**< All vertex/fragment programs */
3110    struct gl_vertex_program *DefaultVertexProgram;
3111    struct gl_fragment_program *DefaultFragmentProgram;
3112    struct gl_geometry_program *DefaultGeometryProgram;
3113    /*@}*/
3114
3115    /* GL_ATI_fragment_shader */
3116    struct _mesa_HashTable *ATIShaders;
3117    struct ati_fragment_shader *DefaultFragmentShader;
3118
3119    struct _mesa_HashTable *BufferObjects;
3120
3121    /** Table of both gl_shader and gl_shader_program objects */
3122    struct _mesa_HashTable *ShaderObjects;
3123
3124    /* GL_EXT_framebuffer_object */
3125    struct _mesa_HashTable *RenderBuffers;
3126    struct _mesa_HashTable *FrameBuffers;
3127
3128    /* GL_ARB_sync */
3129    struct set *SyncObjects;
3130
3131    /** GL_ARB_sampler_objects */
3132    struct _mesa_HashTable *SamplerObjects;
3133
3134    /**
3135     * Some context in this share group was affected by a GPU reset
3136     *
3137     * On the next call to \c glGetGraphicsResetStatus, contexts that have not
3138     * been affected by a GPU reset must also return
3139     * \c GL_INNOCENT_CONTEXT_RESET_ARB.
3140     *
3141     * Once this field becomes true, it is never reset to false.
3142     */
3143    bool ShareGroupReset;
3144 };
3145
3146
3147
3148 /**
3149  * Renderbuffers represent drawing surfaces such as color, depth and/or
3150  * stencil.  A framebuffer object has a set of renderbuffers.
3151  * Drivers will typically derive subclasses of this type.
3152  */
3153 struct gl_renderbuffer
3154 {
3155    mtx_t Mutex; /**< for thread safety */
3156    GLuint ClassID;        /**< Useful for drivers */
3157    GLuint Name;
3158    GLchar *Label;         /**< GL_KHR_debug */
3159    GLint RefCount;
3160    GLuint Width, Height;
3161    GLuint Depth;
3162    GLboolean Purgeable;  /**< Is the buffer purgeable under memory pressure? */
3163    GLboolean AttachedAnytime; /**< TRUE if it was attached to a framebuffer */
3164    /**
3165     * True for renderbuffers that wrap textures, giving the driver a chance to
3166     * flush render caches through the FinishRenderTexture hook.
3167     *
3168     * Drivers may also set this on renderbuffers other than those generated by
3169     * glFramebufferTexture(), though it means FinishRenderTexture() would be
3170     * called without a rb->TexImage.
3171     */
3172    GLboolean NeedsFinishRenderTexture;
3173    GLubyte NumSamples;
3174    GLenum InternalFormat; /**< The user-specified format */
3175    GLenum _BaseFormat;    /**< Either GL_RGB, GL_RGBA, GL_DEPTH_COMPONENT or
3176                                GL_STENCIL_INDEX. */
3177    mesa_format Format;      /**< The actual renderbuffer memory format */
3178    /**
3179     * Pointer to the texture image if this renderbuffer wraps a texture,
3180     * otherwise NULL.
3181     *
3182     * Note that the reference on the gl_texture_object containing this
3183     * TexImage is held by the gl_renderbuffer_attachment.
3184     */
3185    struct gl_texture_image *TexImage;
3186
3187    /** Delete this renderbuffer */
3188    void (*Delete)(struct gl_context *ctx, struct gl_renderbuffer *rb);
3189
3190    /** Allocate new storage for this renderbuffer */
3191    GLboolean (*AllocStorage)(struct gl_context *ctx,
3192                              struct gl_renderbuffer *rb,
3193                              GLenum internalFormat,
3194                              GLuint width, GLuint height);
3195 };
3196
3197
3198 /**
3199  * A renderbuffer attachment points to either a texture object (and specifies
3200  * a mipmap level, cube face or 3D texture slice) or points to a renderbuffer.
3201  */
3202 struct gl_renderbuffer_attachment
3203 {
3204    GLenum Type;  /**< \c GL_NONE or \c GL_TEXTURE or \c GL_RENDERBUFFER_EXT */
3205    GLboolean Complete;
3206
3207    /**
3208     * If \c Type is \c GL_RENDERBUFFER_EXT, this stores a pointer to the
3209     * application supplied renderbuffer object.
3210     */
3211    struct gl_renderbuffer *Renderbuffer;
3212
3213    /**
3214     * If \c Type is \c GL_TEXTURE, this stores a pointer to the application
3215     * supplied texture object.
3216     */
3217    struct gl_texture_object *Texture;
3218    GLuint TextureLevel; /**< Attached mipmap level. */
3219    GLuint CubeMapFace;  /**< 0 .. 5, for cube map textures. */
3220    GLuint Zoffset;      /**< Slice for 3D textures,  or layer for both 1D
3221                          * and 2D array textures */
3222    GLboolean Layered;
3223 };
3224
3225
3226 /**
3227  * A framebuffer is a collection of renderbuffers (color, depth, stencil, etc).
3228  * In C++ terms, think of this as a base class from which device drivers
3229  * will make derived classes.
3230  */
3231 struct gl_framebuffer
3232 {
3233    mtx_t Mutex;  /**< for thread safety */
3234    /**
3235     * If zero, this is a window system framebuffer.  If non-zero, this
3236     * is a FBO framebuffer; note that for some devices (i.e. those with
3237     * a natural pixel coordinate system for FBOs that differs from the
3238     * OpenGL/Mesa coordinate system), this means that the viewport,
3239     * polygon face orientation, and polygon stipple will have to be inverted.
3240     */
3241    GLuint Name;
3242    GLchar *Label;       /**< GL_KHR_debug */
3243
3244    GLint RefCount;
3245    GLboolean DeletePending;
3246
3247    /**
3248     * The framebuffer's visual. Immutable if this is a window system buffer.
3249     * Computed from attachments if user-made FBO.
3250     */
3251    struct gl_config Visual;
3252
3253    GLuint Width, Height;        /**< size of frame buffer in pixels */
3254
3255    /** \name  Drawing bounds (Intersection of buffer size and scissor box) */
3256    /*@{*/
3257    GLint _Xmin, _Xmax;  /**< inclusive */
3258    GLint _Ymin, _Ymax;  /**< exclusive */
3259    /*@}*/
3260
3261    /** \name  Derived Z buffer stuff */
3262    /*@{*/
3263    GLuint _DepthMax;    /**< Max depth buffer value */
3264    GLfloat _DepthMaxF;  /**< Float max depth buffer value */
3265    GLfloat _MRD;        /**< minimum resolvable difference in Z values */
3266    /*@}*/
3267
3268    /** One of the GL_FRAMEBUFFER_(IN)COMPLETE_* tokens */
3269    GLenum _Status;
3270
3271    /** Integer color values */
3272    GLboolean _IntegerColor;
3273
3274    /* ARB_color_buffer_float */
3275    GLboolean _AllColorBuffersFixedPoint; /* no integer, no float */
3276    GLboolean _HasSNormOrFloatColorBuffer;
3277
3278    /** Array of all renderbuffer attachments, indexed by BUFFER_* tokens. */
3279    struct gl_renderbuffer_attachment Attachment[BUFFER_COUNT];
3280
3281    /* In unextended OpenGL these vars are part of the GL_COLOR_BUFFER
3282     * attribute group and GL_PIXEL attribute group, respectively.
3283     */
3284    GLenum ColorDrawBuffer[MAX_DRAW_BUFFERS];
3285    GLenum ColorReadBuffer;
3286
3287    /** Computed from ColorDraw/ReadBuffer above */
3288    GLuint _NumColorDrawBuffers;
3289    GLint _ColorDrawBufferIndexes[MAX_DRAW_BUFFERS]; /**< BUFFER_x or -1 */
3290    GLint _ColorReadBufferIndex; /* -1 = None */
3291    struct gl_renderbuffer *_ColorDrawBuffers[MAX_DRAW_BUFFERS];
3292    struct gl_renderbuffer *_ColorReadBuffer;
3293
3294    /**
3295     * The maximum number of layers in the framebuffer, or 0 if the framebuffer
3296     * is not layered.  For cube maps and cube map arrays, each cube face
3297     * counts as a layer.
3298     */
3299    GLuint MaxNumLayers;
3300
3301    /** Delete this framebuffer */
3302    void (*Delete)(struct gl_framebuffer *fb);
3303 };
3304
3305
3306 /**
3307  * Precision info for shader datatypes.  See glGetShaderPrecisionFormat().
3308  */
3309 struct gl_precision
3310 {
3311    GLushort RangeMin;   /**< min value exponent */
3312    GLushort RangeMax;   /**< max value exponent */
3313    GLushort Precision;  /**< number of mantissa bits */
3314 };
3315
3316
3317 /**
3318  * Limits for vertex, geometry and fragment programs/shaders.
3319  */
3320 struct gl_program_constants
3321 {
3322    /* logical limits */
3323    GLuint MaxInstructions;
3324    GLuint MaxAluInstructions;
3325    GLuint MaxTexInstructions;
3326    GLuint MaxTexIndirections;
3327    GLuint MaxAttribs;
3328    GLuint MaxTemps;
3329    GLuint MaxAddressRegs;
3330    GLuint MaxAddressOffset;  /**< [-MaxAddressOffset, MaxAddressOffset-1] */
3331    GLuint MaxParameters;
3332    GLuint MaxLocalParams;
3333    GLuint MaxEnvParams;
3334    /* native/hardware limits */
3335    GLuint MaxNativeInstructions;
3336    GLuint MaxNativeAluInstructions;
3337    GLuint MaxNativeTexInstructions;
3338    GLuint MaxNativeTexIndirections;
3339    GLuint MaxNativeAttribs;
3340    GLuint MaxNativeTemps;
3341    GLuint MaxNativeAddressRegs;
3342    GLuint MaxNativeParameters;
3343    /* For shaders */
3344    GLuint MaxUniformComponents;  /**< Usually == MaxParameters * 4 */
3345
3346    /**
3347     * \name Per-stage input / output limits
3348     *
3349     * Previous to OpenGL 3.2, the intrastage data limits were advertised with
3350     * a single value: GL_MAX_VARYING_COMPONENTS (GL_MAX_VARYING_VECTORS in
3351     * ES).  This is stored as \c gl_constants::MaxVarying.
3352     *
3353     * Starting with OpenGL 3.2, the limits are advertised with per-stage
3354     * variables.  Each stage as a certain number of outputs that it can feed
3355     * to the next stage and a certain number inputs that it can consume from
3356     * the previous stage.
3357     *
3358     * Vertex shader inputs do not participate this in this accounting.
3359     * These are tracked exclusively by \c gl_program_constants::MaxAttribs.
3360     *
3361     * Fragment shader outputs do not participate this in this accounting.
3362     * These are tracked exclusively by \c gl_constants::MaxDrawBuffers.
3363     */
3364    /*@{*/
3365    GLuint MaxInputComponents;
3366    GLuint MaxOutputComponents;
3367    /*@}*/
3368
3369    /* ES 2.0 and GL_ARB_ES2_compatibility */
3370    struct gl_precision LowFloat, MediumFloat, HighFloat;
3371    struct gl_precision LowInt, MediumInt, HighInt;
3372    /* GL_ARB_uniform_buffer_object */
3373    GLuint MaxUniformBlocks;
3374    GLuint MaxCombinedUniformComponents;
3375    GLuint MaxTextureImageUnits;
3376
3377    /* GL_ARB_shader_atomic_counters */
3378    GLuint MaxAtomicBuffers;
3379    GLuint MaxAtomicCounters;
3380
3381    /* GL_ARB_shader_image_load_store */
3382    GLuint MaxImageUniforms;
3383 };
3384
3385
3386 /**
3387  * Constants which may be overridden by device driver during context creation
3388  * but are never changed after that.
3389  */
3390 struct gl_constants
3391 {
3392    GLuint MaxTextureMbytes;      /**< Max memory per image, in MB */
3393    GLuint MaxTextureLevels;      /**< Max mipmap levels. */ 
3394    GLuint Max3DTextureLevels;    /**< Max mipmap levels for 3D textures */
3395    GLuint MaxCubeTextureLevels;  /**< Max mipmap levels for cube textures */
3396    GLuint MaxArrayTextureLayers; /**< Max layers in array textures */
3397    GLuint MaxTextureRectSize;    /**< Max rectangle texture size, in pixes */
3398    GLuint MaxTextureCoordUnits;
3399    GLuint MaxCombinedTextureImageUnits;
3400    GLuint MaxTextureUnits; /**< = MIN(CoordUnits, FragmentProgram.ImageUnits) */
3401    GLfloat MaxTextureMaxAnisotropy;  /**< GL_EXT_texture_filter_anisotropic */
3402    GLfloat MaxTextureLodBias;        /**< GL_EXT_texture_lod_bias */
3403    GLuint MaxTextureBufferSize;      /**< GL_ARB_texture_buffer_object */
3404
3405    GLuint TextureBufferOffsetAlignment; /**< GL_ARB_texture_buffer_range */
3406
3407    GLuint MaxArrayLockSize;
3408
3409    GLint SubPixelBits;
3410
3411    GLfloat MinPointSize, MaxPointSize;       /**< aliased */
3412    GLfloat MinPointSizeAA, MaxPointSizeAA;   /**< antialiased */
3413    GLfloat PointSizeGranularity;
3414    GLfloat MinLineWidth, MaxLineWidth;       /**< aliased */
3415    GLfloat MinLineWidthAA, MaxLineWidthAA;   /**< antialiased */
3416    GLfloat LineWidthGranularity;
3417
3418    GLuint MaxClipPlanes;
3419    GLuint MaxLights;
3420    GLfloat MaxShininess;                     /**< GL_NV_light_max_exponent */
3421    GLfloat MaxSpotExponent;                  /**< GL_NV_light_max_exponent */
3422
3423    GLuint MaxViewportWidth, MaxViewportHeight;
3424    GLuint MaxViewports;                      /**< GL_ARB_viewport_array */
3425    GLuint ViewportSubpixelBits;              /**< GL_ARB_viewport_array */
3426    struct {
3427       GLfloat Min;
3428       GLfloat Max;
3429    } ViewportBounds;                         /**< GL_ARB_viewport_array */
3430
3431    struct gl_program_constants Program[MESA_SHADER_STAGES];
3432    GLuint MaxProgramMatrices;
3433    GLuint MaxProgramMatrixStackDepth;
3434
3435    struct {
3436       GLuint SamplesPassed;
3437       GLuint TimeElapsed;
3438       GLuint Timestamp;
3439       GLuint PrimitivesGenerated;
3440       GLuint PrimitivesWritten;
3441    } QueryCounterBits;
3442
3443    GLuint MaxDrawBuffers;    /**< GL_ARB_draw_buffers */
3444
3445    GLuint MaxColorAttachments;   /**< GL_EXT_framebuffer_object */
3446    GLuint MaxRenderbufferSize;   /**< GL_EXT_framebuffer_object */
3447    GLuint MaxSamples;            /**< GL_ARB_framebuffer_object */
3448
3449    /** Number of varying vectors between any two shader stages. */
3450    GLuint MaxVarying;
3451
3452    /** @{
3453     * GL_ARB_uniform_buffer_object
3454     */
3455    GLuint MaxCombinedUniformBlocks;
3456    GLuint MaxUniformBufferBindings;
3457    GLuint MaxUniformBlockSize;
3458    GLuint UniformBufferOffsetAlignment;
3459    /** @} */
3460
3461    /**
3462     * GL_ARB_explicit_uniform_location
3463     */
3464    GLuint MaxUserAssignableUniformLocations;
3465
3466    /** GL_ARB_geometry_shader4 */
3467    GLuint MaxGeometryOutputVertices;
3468    GLuint MaxGeometryTotalOutputComponents;
3469
3470    GLuint GLSLVersion;  /**< Desktop GLSL version supported (ex: 120 = 1.20) */
3471
3472    /**
3473     * Changes default GLSL extension behavior from "error" to "warn".  It's out
3474     * of spec, but it can make some apps work that otherwise wouldn't.
3475     */
3476    GLboolean ForceGLSLExtensionsWarn;
3477
3478    /**
3479     * If non-zero, forces GLSL shaders without the #version directive to behave
3480     * as if they began with "#version ForceGLSLVersion".
3481     */
3482    GLuint ForceGLSLVersion;
3483
3484    /**
3485     * Allow GLSL #extension directives in the middle of shaders.
3486     */
3487    GLboolean AllowGLSLExtensionDirectiveMidShader;
3488
3489    /**
3490     * Does the driver support real 32-bit integers?  (Otherwise, integers are
3491     * simulated via floats.)
3492     */
3493    GLboolean NativeIntegers;
3494
3495    /**
3496     * Does VertexID count from zero or from base vertex?
3497     *
3498     * \note
3499     * If desktop GLSL 1.30 or GLSL ES 3.00 are not supported, this field is
3500     * ignored and need not be set.
3501     */
3502    bool VertexID_is_zero_based;
3503
3504    /**
3505     * If the driver supports real 32-bit integers, what integer value should be
3506     * used for boolean true in uniform uploads?  (Usually 1 or ~0.)
3507     */
3508    GLuint UniformBooleanTrue;
3509
3510    /**
3511     * Maximum amount of time, measured in nanseconds, that the server can wait.
3512     */
3513    GLuint64 MaxServerWaitTimeout;
3514
3515    /** GL_EXT_provoking_vertex */
3516    GLboolean QuadsFollowProvokingVertexConvention;
3517
3518    /** OpenGL version 3.0 */
3519    GLbitfield ContextFlags;  /**< Ex: GL_CONTEXT_FLAG_FORWARD_COMPATIBLE_BIT */
3520
3521    /** OpenGL version 3.2 */
3522    GLbitfield ProfileMask;   /**< Mask of CONTEXT_x_PROFILE_BIT */
3523
3524    /** OpenGL version 4.4 */
3525    GLuint MaxVertexAttribStride;
3526
3527    /** GL_EXT_transform_feedback */
3528    GLuint MaxTransformFeedbackBuffers;
3529    GLuint MaxTransformFeedbackSeparateComponents;
3530    GLuint MaxTransformFeedbackInterleavedComponents;
3531    GLuint MaxVertexStreams;
3532
3533    /** GL_EXT_gpu_shader4 */
3534    GLint MinProgramTexelOffset, MaxProgramTexelOffset;
3535
3536    /** GL_ARB_texture_gather */
3537    GLuint MinProgramTextureGatherOffset;
3538    GLuint MaxProgramTextureGatherOffset;
3539    GLuint MaxProgramTextureGatherComponents;
3540
3541    /* GL_ARB_robustness */
3542    GLenum ResetStrategy;
3543
3544    /* GL_ARB_blend_func_extended */
3545    GLuint MaxDualSourceDrawBuffers;
3546
3547    /**
3548     * Whether the implementation strips out and ignores texture borders.
3549     *
3550     * Many GPU hardware implementations don't support rendering with texture
3551     * borders and mipmapped textures.  (Note: not static border color, but the
3552     * old 1-pixel border around each edge).  Implementations then have to do
3553     * slow fallbacks to be correct, or just ignore the border and be fast but
3554     * wrong.  Setting the flag strips the border off of TexImage calls,
3555     * providing "fast but wrong" at significantly reduced driver complexity.
3556     *
3557     * Texture borders are deprecated in GL 3.0.
3558     **/
3559    GLboolean StripTextureBorder;
3560
3561    /**
3562     * For drivers which can do a better job at eliminating unused uniforms
3563     * than the GLSL compiler.
3564     *
3565     * XXX Remove these as soon as a better solution is available.
3566     */
3567    GLboolean GLSLSkipStrictMaxUniformLimitCheck;
3568
3569    /**
3570     * Always use the GetTransformFeedbackVertexCount() driver hook, rather
3571     * than passing the transform feedback object to the drawing function.
3572     */
3573    GLboolean AlwaysUseGetTransformFeedbackVertexCount;
3574
3575    /** GL_ARB_map_buffer_alignment */
3576    GLuint MinMapBufferAlignment;
3577
3578    /**
3579     * Disable varying packing.  This is out of spec, but potentially useful
3580     * for older platforms that supports a limited number of texture
3581     * indirections--on these platforms, unpacking the varyings in the fragment
3582     * shader increases the number of texture indirections by 1, which might
3583     * make some shaders not executable at all.
3584     *
3585     * Drivers that support transform feedback must set this value to GL_FALSE.
3586     */
3587    GLboolean DisableVaryingPacking;
3588
3589    /**
3590     * Should meaningful names be generated for compiler temporary variables?
3591     *
3592     * Generally, it is not useful to have the compiler generate "meaningful"
3593     * names for temporary variables that it creates.  This can, however, be a
3594     * useful debugging aid.  In Mesa debug builds or release builds when
3595     * MESA_GLSL is set at run-time, meaningful names will be generated.
3596     * Drivers can also force names to be generated by setting this field.
3597     * For example, the i965 driver may set it when INTEL_DEBUG=vs (to dump
3598     * vertex shader assembly) is set at run-time.
3599     */
3600    bool GenerateTemporaryNames;
3601
3602    /*
3603     * Maximum value supported for an index in DrawElements and friends.
3604     *
3605     * This must be at least (1ull<<24)-1.  The default value is
3606     * (1ull<<32)-1.
3607     *
3608     * \since ES 3.0 or GL_ARB_ES3_compatibility
3609     * \sa _mesa_init_constants
3610     */
3611    GLuint64 MaxElementIndex;
3612
3613    /**
3614     * Disable interpretation of line continuations (lines ending with a
3615     * backslash character ('\') in GLSL source.
3616     */
3617    GLboolean DisableGLSLLineContinuations;
3618
3619    /** GL_ARB_texture_multisample */
3620    GLint MaxColorTextureSamples;
3621    GLint MaxDepthTextureSamples;
3622    GLint MaxIntegerSamples;
3623
3624    /**
3625     * GL_EXT_texture_multisample_blit_scaled implementation assumes that
3626     * samples are laid out in a rectangular grid roughly corresponding to
3627     * sample locations within a pixel. Below SampleMap{2,4,8}x variables
3628     * are used to map indices of rectangular grid to sample numbers within
3629     * a pixel. This mapping of indices to sample numbers must be initialized
3630     * by the driver for the target hardware. For example, if we have the 8X
3631     * MSAA sample number layout (sample positions) for XYZ hardware:
3632     *
3633     *        sample indices layout          sample number layout
3634     *            ---------                      ---------
3635     *            | 0 | 1 |                      | a | b |
3636     *            ---------                      ---------
3637     *            | 2 | 3 |                      | c | d |
3638     *            ---------                      ---------
3639     *            | 4 | 5 |                      | e | f |
3640     *            ---------                      ---------
3641     *            | 6 | 7 |                      | g | h |
3642     *            ---------                      ---------
3643     *
3644     * Where a,b,c,d,e,f,g,h are integers between [0-7].
3645     *
3646     * Then, initialize the SampleMap8x variable for XYZ hardware as shown
3647     * below:
3648     *    SampleMap8x = {a, b, c, d, e, f, g, h};
3649     *
3650     * Follow the logic for other sample counts.
3651     */
3652    uint8_t SampleMap2x[2];
3653    uint8_t SampleMap4x[4];
3654    uint8_t SampleMap8x[8];
3655
3656    /** GL_ARB_shader_atomic_counters */
3657    GLuint MaxAtomicBufferBindings;
3658    GLuint MaxAtomicBufferSize;
3659    GLuint MaxCombinedAtomicBuffers;
3660    GLuint MaxCombinedAtomicCounters;
3661
3662    /** GL_ARB_vertex_attrib_binding */
3663    GLint MaxVertexAttribRelativeOffset;
3664    GLint MaxVertexAttribBindings;
3665
3666    /* GL_ARB_shader_image_load_store */
3667    GLuint MaxImageUnits;
3668    GLuint MaxCombinedImageUnitsAndFragmentOutputs;
3669    GLuint MaxImageSamples;
3670    GLuint MaxCombinedImageUniforms;
3671
3672    /** GL_ARB_compute_shader */
3673    GLuint MaxComputeWorkGroupCount[3]; /* Array of x, y, z dimensions */
3674    GLuint MaxComputeWorkGroupSize[3]; /* Array of x, y, z dimensions */
3675    GLuint MaxComputeWorkGroupInvocations;
3676
3677    /** GL_ARB_gpu_shader5 */
3678    GLfloat MinFragmentInterpolationOffset;
3679    GLfloat MaxFragmentInterpolationOffset;
3680
3681    GLboolean FakeSWMSAA;
3682
3683    /** GL_KHR_context_flush_control */
3684    GLenum ContextReleaseBehavior;
3685
3686    struct gl_shader_compiler_options ShaderCompilerOptions[MESA_SHADER_STAGES];
3687 };
3688
3689
3690 /**
3691  * Enable flag for each OpenGL extension.  Different device drivers will
3692  * enable different extensions at runtime.
3693  */
3694 struct gl_extensions
3695 {
3696    GLboolean dummy;  /* don't remove this! */
3697    GLboolean dummy_true;  /* Set true by _mesa_init_extensions(). */
3698    GLboolean dummy_false; /* Set false by _mesa_init_extensions(). */
3699    GLboolean ANGLE_texture_compression_dxt;
3700    GLboolean ARB_ES2_compatibility;
3701    GLboolean ARB_ES3_compatibility;
3702    GLboolean ARB_arrays_of_arrays;
3703    GLboolean ARB_base_instance;
3704    GLboolean ARB_blend_func_extended;
3705    GLboolean ARB_buffer_storage;
3706    GLboolean ARB_clear_texture;
3707    GLboolean ARB_clip_control;
3708    GLboolean ARB_color_buffer_float;
3709    GLboolean ARB_compute_shader;
3710    GLboolean ARB_conditional_render_inverted;
3711    GLboolean ARB_conservative_depth;
3712    GLboolean ARB_copy_image;
3713    GLboolean ARB_depth_buffer_float;
3714    GLboolean ARB_depth_clamp;
3715    GLboolean ARB_depth_texture;
3716    GLboolean ARB_derivative_control;
3717    GLboolean ARB_draw_buffers_blend;
3718    GLboolean ARB_draw_elements_base_vertex;
3719    GLboolean ARB_draw_indirect;
3720    GLboolean ARB_draw_instanced;
3721    GLboolean ARB_fragment_coord_conventions;
3722    GLboolean ARB_fragment_layer_viewport;
3723    GLboolean ARB_fragment_program;
3724    GLboolean ARB_fragment_program_shadow;
3725    GLboolean ARB_fragment_shader;
3726    GLboolean ARB_framebuffer_object;
3727    GLboolean ARB_explicit_attrib_location;
3728    GLboolean ARB_explicit_uniform_location;
3729    GLboolean ARB_geometry_shader4;
3730    GLboolean ARB_gpu_shader5;
3731    GLboolean ARB_half_float_vertex;
3732    GLboolean ARB_instanced_arrays;
3733    GLboolean ARB_internalformat_query;
3734    GLboolean ARB_map_buffer_range;
3735    GLboolean ARB_occlusion_query;
3736    GLboolean ARB_occlusion_query2;
3737    GLboolean ARB_point_sprite;
3738    GLboolean ARB_sample_shading;
3739    GLboolean ARB_seamless_cube_map;
3740    GLboolean ARB_shader_atomic_counters;
3741    GLboolean ARB_shader_bit_encoding;
3742    GLboolean ARB_shader_image_load_store;
3743    GLboolean ARB_shader_stencil_export;
3744    GLboolean ARB_shader_texture_lod;
3745    GLboolean ARB_shading_language_packing;
3746    GLboolean ARB_shading_language_420pack;
3747    GLboolean ARB_shadow;
3748    GLboolean ARB_stencil_texturing;
3749    GLboolean ARB_sync;
3750    GLboolean ARB_texture_border_clamp;
3751    GLboolean ARB_texture_buffer_object;
3752    GLboolean ARB_texture_buffer_object_rgb32;
3753    GLboolean ARB_texture_buffer_range;
3754    GLboolean ARB_texture_compression_bptc;
3755    GLboolean ARB_texture_compression_rgtc;
3756    GLboolean ARB_texture_cube_map;
3757    GLboolean ARB_texture_cube_map_array;
3758    GLboolean ARB_texture_env_combine;
3759    GLboolean ARB_texture_env_crossbar;
3760    GLboolean ARB_texture_env_dot3;
3761    GLboolean ARB_texture_float;
3762    GLboolean ARB_texture_gather;
3763    GLboolean ARB_texture_mirror_clamp_to_edge;
3764    GLboolean ARB_texture_multisample;
3765    GLboolean ARB_texture_non_power_of_two;
3766    GLboolean ARB_texture_stencil8;
3767    GLboolean ARB_texture_query_levels;
3768    GLboolean ARB_texture_query_lod;
3769    GLboolean ARB_texture_rg;
3770    GLboolean ARB_texture_rgb10_a2ui;
3771    GLboolean ARB_texture_view;
3772    GLboolean ARB_timer_query;
3773    GLboolean ARB_transform_feedback2;
3774    GLboolean ARB_transform_feedback3;
3775    GLboolean ARB_transform_feedback_instanced;
3776    GLboolean ARB_uniform_buffer_object;
3777    GLboolean ARB_vertex_program;
3778    GLboolean ARB_vertex_shader;
3779    GLboolean ARB_vertex_type_10f_11f_11f_rev;
3780    GLboolean ARB_vertex_type_2_10_10_10_rev;
3781    GLboolean ARB_viewport_array;
3782    GLboolean EXT_blend_color;
3783    GLboolean EXT_blend_equation_separate;
3784    GLboolean EXT_blend_func_separate;
3785    GLboolean EXT_blend_minmax;
3786    GLboolean EXT_depth_bounds_test;
3787    GLboolean EXT_draw_buffers2;
3788    GLboolean EXT_framebuffer_multisample;
3789    GLboolean EXT_framebuffer_multisample_blit_scaled;
3790    GLboolean EXT_framebuffer_sRGB;
3791    GLboolean EXT_gpu_program_parameters;
3792    GLboolean EXT_gpu_shader4;
3793    GLboolean EXT_packed_float;
3794    GLboolean EXT_pixel_buffer_object;
3795    GLboolean EXT_point_parameters;
3796    GLboolean EXT_provoking_vertex;
3797    GLboolean EXT_shader_integer_mix;
3798    GLboolean EXT_stencil_two_side;
3799    GLboolean EXT_texture3D;
3800    GLboolean EXT_texture_array;
3801    GLboolean EXT_texture_compression_latc;
3802    GLboolean EXT_texture_compression_s3tc;
3803    GLboolean EXT_texture_env_dot3;
3804    GLboolean EXT_texture_filter_anisotropic;
3805    GLboolean EXT_texture_integer;
3806    GLboolean EXT_texture_mirror_clamp;
3807    GLboolean EXT_texture_shared_exponent;
3808    GLboolean EXT_texture_snorm;
3809    GLboolean EXT_texture_sRGB;
3810    GLboolean EXT_texture_sRGB_decode;
3811    GLboolean EXT_texture_swizzle;
3812    GLboolean EXT_transform_feedback;
3813    GLboolean EXT_timer_query;
3814    GLboolean EXT_vertex_array_bgra;
3815    GLboolean OES_standard_derivatives;
3816    /* vendor extensions */
3817    GLboolean AMD_performance_monitor;
3818    GLboolean AMD_seamless_cubemap_per_texture;
3819    GLboolean AMD_vertex_shader_layer;
3820    GLboolean AMD_vertex_shader_viewport_index;
3821    GLboolean APPLE_object_purgeable;
3822    GLboolean ATI_texture_compression_3dc;
3823    GLboolean ATI_texture_mirror_once;
3824    GLboolean ATI_texture_env_combine3;
3825    GLboolean ATI_fragment_shader;
3826    GLboolean ATI_separate_stencil;
3827    GLboolean INTEL_performance_query;
3828    GLboolean MESA_pack_invert;
3829    GLboolean MESA_ycbcr_texture;
3830    GLboolean NV_conditional_render;
3831    GLboolean NV_fog_distance;
3832    GLboolean NV_fragment_program_option;
3833    GLboolean NV_point_sprite;
3834    GLboolean NV_primitive_restart;
3835    GLboolean NV_texture_barrier;
3836    GLboolean NV_texture_env_combine4;
3837    GLboolean NV_texture_rectangle;
3838    GLboolean NV_vdpau_interop;
3839    GLboolean TDFX_texture_compression_FXT1;
3840    GLboolean OES_EGL_image;
3841    GLboolean OES_draw_texture;
3842    GLboolean OES_depth_texture_cube_map;
3843    GLboolean OES_EGL_image_external;
3844    GLboolean OES_compressed_ETC1_RGB8_texture;
3845    GLboolean extension_sentinel;
3846    /** The extension string */
3847    const GLubyte *String;
3848    /** Number of supported extensions */
3849    GLuint Count;
3850 };
3851
3852
3853 /**
3854  * A stack of matrices (projection, modelview, color, texture, etc).
3855  */
3856 struct gl_matrix_stack
3857 {
3858    GLmatrix *Top;      /**< points into Stack */
3859    GLmatrix *Stack;    /**< array [MaxDepth] of GLmatrix */
3860    GLuint Depth;       /**< 0 <= Depth < MaxDepth */
3861    GLuint MaxDepth;    /**< size of Stack[] array */
3862    GLuint DirtyFlag;   /**< _NEW_MODELVIEW or _NEW_PROJECTION, for example */
3863 };
3864
3865
3866 /**
3867  * \name Bits for image transfer operations 
3868  * \sa __struct gl_contextRec::ImageTransferState.
3869  */
3870 /*@{*/
3871 #define IMAGE_SCALE_BIAS_BIT                      0x1
3872 #define IMAGE_SHIFT_OFFSET_BIT                    0x2
3873 #define IMAGE_MAP_COLOR_BIT                       0x4
3874 #define IMAGE_CLAMP_BIT                           0x800
3875
3876
3877 /** Pixel Transfer ops */
3878 #define IMAGE_BITS (IMAGE_SCALE_BIAS_BIT |                      \
3879                     IMAGE_SHIFT_OFFSET_BIT |                    \
3880                     IMAGE_MAP_COLOR_BIT)
3881
3882 /**
3883  * \name Bits to indicate what state has changed.  
3884  */
3885 /*@{*/
3886 #define _NEW_MODELVIEW         (1 << 0)   /**< gl_context::ModelView */
3887 #define _NEW_PROJECTION        (1 << 1)   /**< gl_context::Projection */
3888 #define _NEW_TEXTURE_MATRIX    (1 << 2)   /**< gl_context::TextureMatrix */
3889 #define _NEW_COLOR             (1 << 3)   /**< gl_context::Color */
3890 #define _NEW_DEPTH             (1 << 4)   /**< gl_context::Depth */
3891 #define _NEW_EVAL              (1 << 5)   /**< gl_context::Eval, EvalMap */
3892 #define _NEW_FOG               (1 << 6)   /**< gl_context::Fog */
3893 #define _NEW_HINT              (1 << 7)   /**< gl_context::Hint */
3894 #define _NEW_LIGHT             (1 << 8)   /**< gl_context::Light */
3895 #define _NEW_LINE              (1 << 9)   /**< gl_context::Line */
3896 #define _NEW_PIXEL             (1 << 10)  /**< gl_context::Pixel */
3897 #define _NEW_POINT             (1 << 11)  /**< gl_context::Point */
3898 #define _NEW_POLYGON           (1 << 12)  /**< gl_context::Polygon */
3899 #define _NEW_POLYGONSTIPPLE    (1 << 13)  /**< gl_context::PolygonStipple */
3900 #define _NEW_SCISSOR           (1 << 14)  /**< gl_context::Scissor */
3901 #define _NEW_STENCIL           (1 << 15)  /**< gl_context::Stencil */
3902 #define _NEW_TEXTURE           (1 << 16)  /**< gl_context::Texture */
3903 #define _NEW_TRANSFORM         (1 << 17)  /**< gl_context::Transform */
3904 #define _NEW_VIEWPORT          (1 << 18)  /**< gl_context::Viewport */
3905 /* gap, re-use for core Mesa state only; use ctx->DriverFlags otherwise */
3906 #define _NEW_ARRAY             (1 << 20)  /**< gl_context::Array */
3907 #define _NEW_RENDERMODE        (1 << 21)  /**< gl_context::RenderMode, etc */
3908 #define _NEW_BUFFERS           (1 << 22)  /**< gl_context::Visual, DrawBuffer, */
3909 #define _NEW_CURRENT_ATTRIB    (1 << 23)  /**< gl_context::Current */
3910 #define _NEW_MULTISAMPLE       (1 << 24)  /**< gl_context::Multisample */
3911 #define _NEW_TRACK_MATRIX      (1 << 25)  /**< gl_context::VertexProgram */
3912 #define _NEW_PROGRAM           (1 << 26)  /**< New program/shader state */
3913 #define _NEW_PROGRAM_CONSTANTS (1 << 27)
3914 #define _NEW_BUFFER_OBJECT     (1 << 28)
3915 #define _NEW_FRAG_CLAMP        (1 << 29)
3916 /* gap, re-use for core Mesa state only; use ctx->DriverFlags otherwise */
3917 #define _NEW_VARYING_VP_INPUTS (1 << 31) /**< gl_context::varying_vp_inputs */
3918 #define _NEW_ALL ~0
3919 /*@}*/
3920
3921
3922 /**
3923  * Composite state flags
3924  */
3925 /*@{*/
3926 #define _MESA_NEW_NEED_EYE_COORDS         (_NEW_LIGHT |         \
3927                                            _NEW_TEXTURE |       \
3928                                            _NEW_POINT |         \
3929                                            _NEW_PROGRAM |       \
3930                                            _NEW_MODELVIEW)
3931
3932 #define _MESA_NEW_SEPARATE_SPECULAR        (_NEW_LIGHT | \
3933                                             _NEW_FOG | \
3934                                             _NEW_PROGRAM)
3935
3936
3937 /*@}*/
3938
3939
3940
3941
3942 /* This has to be included here. */
3943 #include "dd.h"
3944
3945
3946 /**
3947  * Display list flags.
3948  * Strictly this is a tnl-private concept, but it doesn't seem
3949  * worthwhile adding a tnl private structure just to hold this one bit
3950  * of information:
3951  */
3952 #define DLIST_DANGLING_REFS     0x1 
3953
3954
3955 /** Opaque declaration of display list payload data type */
3956 union gl_dlist_node;
3957
3958
3959 /**
3960  * Provide a location where information about a display list can be
3961  * collected.  Could be extended with driverPrivate structures,
3962  * etc. in the future.
3963  */
3964 struct gl_display_list
3965 {
3966    GLuint Name;
3967    GLchar *Label;     /**< GL_KHR_debug */
3968    GLbitfield Flags;  /**< DLIST_x flags */
3969    /** The dlist commands are in a linked list of nodes */
3970    union gl_dlist_node *Head;
3971 };
3972
3973
3974 /**
3975  * State used during display list compilation and execution.
3976  */
3977 struct gl_dlist_state
3978 {
3979    GLuint CallDepth;            /**< Current recursion calling depth */
3980
3981    struct gl_display_list *CurrentList; /**< List currently being compiled */
3982    union gl_dlist_node *CurrentBlock; /**< Pointer to current block of nodes */
3983    GLuint CurrentPos;           /**< Index into current block of nodes */
3984
3985    GLvertexformat ListVtxfmt;
3986
3987    GLubyte ActiveAttribSize[VERT_ATTRIB_MAX];
3988    GLfloat CurrentAttrib[VERT_ATTRIB_MAX][4];
3989    
3990    GLubyte ActiveMaterialSize[MAT_ATTRIB_MAX];
3991    GLfloat CurrentMaterial[MAT_ATTRIB_MAX][4];
3992
3993    struct {
3994       /* State known to have been set by the currently-compiling display
3995        * list.  Used to eliminate some redundant state changes.
3996        */
3997       GLenum ShadeModel;
3998    } Current;
3999 };
4000
4001 /** @{
4002  *
4003  * These are a mapping of the GL_ARB_debug_output/GL_KHR_debug enums
4004  * to small enums suitable for use as an array index.
4005  */
4006
4007 enum mesa_debug_source {
4008    MESA_DEBUG_SOURCE_API,
4009    MESA_DEBUG_SOURCE_WINDOW_SYSTEM,
4010    MESA_DEBUG_SOURCE_SHADER_COMPILER,
4011    MESA_DEBUG_SOURCE_THIRD_PARTY,
4012    MESA_DEBUG_SOURCE_APPLICATION,
4013    MESA_DEBUG_SOURCE_OTHER,
4014    MESA_DEBUG_SOURCE_COUNT
4015 };
4016
4017 enum mesa_debug_type {
4018    MESA_DEBUG_TYPE_ERROR,
4019    MESA_DEBUG_TYPE_DEPRECATED,
4020    MESA_DEBUG_TYPE_UNDEFINED,
4021    MESA_DEBUG_TYPE_PORTABILITY,
4022    MESA_DEBUG_TYPE_PERFORMANCE,
4023    MESA_DEBUG_TYPE_OTHER,
4024    MESA_DEBUG_TYPE_MARKER,
4025    MESA_DEBUG_TYPE_PUSH_GROUP,
4026    MESA_DEBUG_TYPE_POP_GROUP,
4027    MESA_DEBUG_TYPE_COUNT
4028 };
4029
4030 enum mesa_debug_severity {
4031    MESA_DEBUG_SEVERITY_LOW,
4032    MESA_DEBUG_SEVERITY_MEDIUM,
4033    MESA_DEBUG_SEVERITY_HIGH,
4034    MESA_DEBUG_SEVERITY_NOTIFICATION,
4035    MESA_DEBUG_SEVERITY_COUNT
4036 };
4037
4038 /** @} */
4039
4040 /**
4041  * Enum for the OpenGL APIs we know about and may support.
4042  *
4043  * NOTE: This must match the api_enum table in
4044  * src/mesa/main/get_hash_generator.py
4045  */
4046 typedef enum
4047 {
4048    API_OPENGL_COMPAT,      /* legacy / compatibility contexts */
4049    API_OPENGLES,
4050    API_OPENGLES2,
4051    API_OPENGL_CORE,
4052    API_OPENGL_LAST = API_OPENGL_CORE
4053 } gl_api;
4054
4055 /**
4056  * Driver-specific state flags.
4057  *
4058  * These are or'd with gl_context::NewDriverState to notify a driver about
4059  * a state change. The driver sets the flags at context creation and
4060  * the meaning of the bits set is opaque to core Mesa.
4061  */
4062 struct gl_driver_flags
4063 {
4064    /** gl_context::Array::_DrawArrays (vertex array state) */
4065    uint64_t NewArray;
4066
4067    /** gl_context::TransformFeedback::CurrentObject */
4068    uint64_t NewTransformFeedback;
4069
4070    /** gl_context::TransformFeedback::CurrentObject::shader_program */
4071    uint64_t NewTransformFeedbackProg;
4072
4073    /** gl_context::RasterDiscard */
4074    uint64_t NewRasterizerDiscard;
4075
4076    /**
4077     * gl_context::UniformBufferBindings
4078     * gl_shader_program::UniformBlocks
4079     */
4080    uint64_t NewUniformBuffer;
4081
4082    uint64_t NewTextureBuffer;
4083
4084    /**
4085     * gl_context::AtomicBufferBindings
4086     */
4087    uint64_t NewAtomicBuffer;
4088
4089    /**
4090     * gl_context::ImageUnits
4091     */
4092    uint64_t NewImageUnits;
4093 };
4094
4095 struct gl_uniform_buffer_binding
4096 {
4097    struct gl_buffer_object *BufferObject;
4098    /** Start of uniform block data in the buffer */
4099    GLintptr Offset;
4100    /** Size of data allowed to be referenced from the buffer (in bytes) */
4101    GLsizeiptr Size;
4102    /**
4103     * glBindBufferBase() indicates that the Size should be ignored and only
4104     * limited by the current size of the BufferObject.
4105     */
4106    GLboolean AutomaticSize;
4107 };
4108
4109 /**
4110  * ARB_shader_image_load_store image unit.
4111  */
4112 struct gl_image_unit
4113 {
4114    /**
4115     * Texture object bound to this unit.
4116     */
4117    struct gl_texture_object *TexObj;
4118
4119    /**
4120     * Level of the texture object bound to this unit.
4121     */
4122    GLuint Level;
4123
4124    /**
4125     * \c GL_TRUE if the whole level is bound as an array of layers, \c
4126     * GL_FALSE if only some specific layer of the texture is bound.
4127     * \sa Layer
4128     */
4129    GLboolean Layered;
4130
4131    /**
4132     * Layer of the texture object bound to this unit, or zero if the
4133     * whole level is bound.
4134     */
4135    GLuint Layer;
4136
4137    /**
4138     * Access allowed to this texture image.  Either \c GL_READ_ONLY,
4139     * \c GL_WRITE_ONLY or \c GL_READ_WRITE.
4140     */
4141    GLenum Access;
4142
4143    /**
4144     * GL internal format that determines the interpretation of the
4145     * image memory when shader image operations are performed through
4146     * this unit.
4147     */
4148    GLenum Format;
4149
4150    /**
4151     * Mesa format corresponding to \c Format.
4152     */
4153    mesa_format _ActualFormat;
4154
4155    /**
4156     * GL_TRUE if the state of this image unit is valid and access from
4157     * the shader is allowed.  Otherwise loads from this unit should
4158     * return zero and stores should have no effect.
4159     */
4160    GLboolean _Valid;
4161 };
4162
4163 /**
4164  * Binding point for an atomic counter buffer object.
4165  */
4166 struct gl_atomic_buffer_binding
4167 {
4168    struct gl_buffer_object *BufferObject;
4169    GLintptr Offset;
4170    GLsizeiptr Size;
4171 };
4172
4173 /**
4174  * Mesa rendering context.
4175  *
4176  * This is the central context data structure for Mesa.  Almost all
4177  * OpenGL state is contained in this structure.
4178  * Think of this as a base class from which device drivers will derive
4179  * sub classes.
4180  */
4181 struct gl_context
4182 {
4183    /** State possibly shared with other contexts in the address space */
4184    struct gl_shared_state *Shared;
4185
4186    /** \name API function pointer tables */
4187    /*@{*/
4188    gl_api API;
4189    /**
4190     * The current dispatch table for non-displaylist-saving execution, either
4191     * BeginEnd or OutsideBeginEnd
4192     */
4193    struct _glapi_table *Exec;
4194    /**
4195     * The normal dispatch table for non-displaylist-saving, non-begin/end
4196     */
4197    struct _glapi_table *OutsideBeginEnd;
4198    /** The dispatch table used between glNewList() and glEndList() */
4199    struct _glapi_table *Save;
4200    /**
4201     * The dispatch table used between glBegin() and glEnd() (outside of a
4202     * display list).  Only valid functions between those two are set, which is
4203     * mostly just the set in a GLvertexformat struct.
4204     */
4205    struct _glapi_table *BeginEnd;
4206    /**
4207     * Tracks the current dispatch table out of the 3 above, so that it can be
4208     * re-set on glXMakeCurrent().
4209     */
4210    struct _glapi_table *CurrentDispatch;
4211    /*@}*/
4212
4213    struct gl_config Visual;
4214    struct gl_framebuffer *DrawBuffer;   /**< buffer for writing */
4215    struct gl_framebuffer *ReadBuffer;   /**< buffer for reading */
4216    struct gl_framebuffer *WinSysDrawBuffer;  /**< set with MakeCurrent */
4217    struct gl_framebuffer *WinSysReadBuffer;  /**< set with MakeCurrent */
4218
4219    /**
4220     * Device driver function pointer table
4221     */
4222    struct dd_function_table Driver;
4223
4224    /** Core/Driver constants */
4225    struct gl_constants Const;
4226
4227    /** \name The various 4x4 matrix stacks */
4228    /*@{*/
4229    struct gl_matrix_stack ModelviewMatrixStack;
4230    struct gl_matrix_stack ProjectionMatrixStack;
4231    struct gl_matrix_stack TextureMatrixStack[MAX_TEXTURE_UNITS];
4232    struct gl_matrix_stack ProgramMatrixStack[MAX_PROGRAM_MATRICES];
4233    struct gl_matrix_stack *CurrentStack; /**< Points to one of the above stacks */
4234    /*@}*/
4235
4236    /** Combined modelview and projection matrix */
4237    GLmatrix _ModelProjectMatrix;
4238
4239    /** \name Display lists */
4240    struct gl_dlist_state ListState;
4241
4242    GLboolean ExecuteFlag;       /**< Execute GL commands? */
4243    GLboolean CompileFlag;       /**< Compile GL commands into display list? */
4244
4245    /** Extension information */
4246    struct gl_extensions Extensions;
4247
4248    /** GL version integer, for example 31 for GL 3.1, or 20 for GLES 2.0. */
4249    GLuint Version;
4250    char *VersionString;
4251
4252    /** \name State attribute stack (for glPush/PopAttrib) */
4253    /*@{*/
4254    GLuint AttribStackDepth;
4255    struct gl_attrib_node *AttribStack[MAX_ATTRIB_STACK_DEPTH];
4256    /*@}*/
4257
4258    /** \name Renderer attribute groups
4259     * 
4260     * We define a struct for each attribute group to make pushing and popping
4261     * attributes easy.  Also it's a good organization.
4262     */
4263    /*@{*/
4264    struct gl_accum_attrib       Accum;          /**< Accum buffer attributes */
4265    struct gl_colorbuffer_attrib Color;          /**< Color buffer attributes */
4266    struct gl_current_attrib     Current;        /**< Current attributes */
4267    struct gl_depthbuffer_attrib Depth;          /**< Depth buffer attributes */
4268    struct gl_eval_attrib        Eval;           /**< Eval attributes */
4269    struct gl_fog_attrib         Fog;            /**< Fog attributes */
4270    struct gl_hint_attrib        Hint;           /**< Hint attributes */
4271    struct gl_light_attrib       Light;          /**< Light attributes */
4272    struct gl_line_attrib        Line;           /**< Line attributes */
4273    struct gl_list_attrib        List;           /**< List attributes */
4274    struct gl_multisample_attrib Multisample;
4275    struct gl_pixel_attrib       Pixel;          /**< Pixel attributes */
4276    struct gl_point_attrib       Point;          /**< Point attributes */
4277    struct gl_polygon_attrib     Polygon;        /**< Polygon attributes */
4278    GLuint PolygonStipple[32];                   /**< Polygon stipple */
4279    struct gl_scissor_attrib     Scissor;        /**< Scissor attributes */
4280    struct gl_stencil_attrib     Stencil;        /**< Stencil buffer attributes */
4281    struct gl_texture_attrib     Texture;        /**< Texture attributes */
4282    struct gl_transform_attrib   Transform;      /**< Transformation attributes */
4283    struct gl_viewport_attrib    ViewportArray[MAX_VIEWPORTS];   /**< Viewport attributes */
4284    /*@}*/
4285
4286    /** \name Client attribute stack */
4287    /*@{*/
4288    GLuint ClientAttribStackDepth;
4289    struct gl_attrib_node *ClientAttribStack[MAX_CLIENT_ATTRIB_STACK_DEPTH];
4290    /*@}*/
4291
4292    /** \name Client attribute groups */
4293    /*@{*/
4294    struct gl_array_attrib       Array;  /**< Vertex arrays */
4295    struct gl_pixelstore_attrib  Pack;   /**< Pixel packing */
4296    struct gl_pixelstore_attrib  Unpack; /**< Pixel unpacking */
4297    struct gl_pixelstore_attrib  DefaultPacking; /**< Default params */
4298    /*@}*/
4299
4300    /** \name Other assorted state (not pushed/popped on attribute stack) */
4301    /*@{*/
4302    struct gl_pixelmaps          PixelMaps;
4303
4304    struct gl_evaluators EvalMap;   /**< All evaluators */
4305    struct gl_feedback   Feedback;  /**< Feedback */
4306    struct gl_selection  Select;    /**< Selection */
4307
4308    struct gl_program_state Program;  /**< general program state */
4309    struct gl_vertex_program_state VertexProgram;
4310    struct gl_fragment_program_state FragmentProgram;
4311    struct gl_geometry_program_state GeometryProgram;
4312    struct gl_compute_program_state ComputeProgram;
4313    struct gl_ati_fragment_shader_state ATIFragmentShader;
4314
4315    struct gl_pipeline_shader_state Pipeline; /**< GLSL pipeline shader object state */
4316    struct gl_pipeline_object Shader; /**< GLSL shader object state */
4317
4318    /**
4319     * Current active shader pipeline state
4320     *
4321     * Almost all internal users want ::_Shader instead of ::Shader.  The
4322     * exceptions are bits of legacy GLSL API that do not know about separate
4323     * shader objects.
4324     *
4325     * If a program is active via \c glUseProgram, this will point to
4326     * \c ::Shader.
4327     *
4328     * If a program pipeline is active via \c glBindProgramPipeline, this will
4329     * point to \c ::Pipeline.Current.
4330     *
4331     * If neither a program nor a program pipeline is active, this will point to
4332     * \c ::Pipeline.Default.  This ensures that \c ::_Shader will never be
4333     * \c NULL.
4334     */
4335    struct gl_pipeline_object *_Shader;
4336
4337    struct gl_query_state Query;  /**< occlusion, timer queries */
4338
4339    struct gl_transform_feedback_state TransformFeedback;
4340
4341    struct gl_perf_monitor_state PerfMonitor;
4342
4343    struct gl_buffer_object *DrawIndirectBuffer; /** < GL_ARB_draw_indirect */
4344
4345    struct gl_buffer_object *CopyReadBuffer; /**< GL_ARB_copy_buffer */
4346    struct gl_buffer_object *CopyWriteBuffer; /**< GL_ARB_copy_buffer */
4347
4348    /**
4349     * Current GL_ARB_uniform_buffer_object binding referenced by
4350     * GL_UNIFORM_BUFFER target for glBufferData, glMapBuffer, etc.
4351     */
4352    struct gl_buffer_object *UniformBuffer;
4353
4354    /**
4355     * Array of uniform buffers for GL_ARB_uniform_buffer_object and GL 3.1.
4356     * This is set up using glBindBufferRange() or glBindBufferBase().  They are
4357     * associated with uniform blocks by glUniformBlockBinding()'s state in the
4358     * shader program.
4359     */
4360    struct gl_uniform_buffer_binding
4361       UniformBufferBindings[MAX_COMBINED_UNIFORM_BUFFERS];
4362
4363    /**
4364     * Object currently associated with the GL_ATOMIC_COUNTER_BUFFER
4365     * target.
4366     */
4367    struct gl_buffer_object *AtomicBuffer;
4368
4369    /**
4370     * Array of atomic counter buffer binding points.
4371     */
4372    struct gl_atomic_buffer_binding
4373       AtomicBufferBindings[MAX_COMBINED_ATOMIC_BUFFERS];
4374
4375    /**
4376     * Array of image units for ARB_shader_image_load_store.
4377     */
4378    struct gl_image_unit ImageUnits[MAX_IMAGE_UNITS];
4379
4380    /*@}*/
4381
4382    struct gl_meta_state *Meta;  /**< for "meta" operations */
4383
4384    /* GL_EXT_framebuffer_object */
4385    struct gl_renderbuffer *CurrentRenderbuffer;
4386
4387    GLenum ErrorValue;        /**< Last error code */
4388
4389    /**
4390     * Recognize and silence repeated error debug messages in buggy apps.
4391     */
4392    const char *ErrorDebugFmtString;
4393    GLuint ErrorDebugCount;
4394
4395    /* GL_ARB_debug_output/GL_KHR_debug */
4396    struct gl_debug_state *Debug;
4397
4398    GLenum RenderMode;        /**< either GL_RENDER, GL_SELECT, GL_FEEDBACK */
4399    GLbitfield NewState;      /**< bitwise-or of _NEW_* flags */
4400    uint64_t NewDriverState;  /**< bitwise-or of flags from DriverFlags */
4401
4402    struct gl_driver_flags DriverFlags;
4403
4404    GLboolean ViewportInitialized;  /**< has viewport size been initialized? */
4405
4406    GLbitfield64 varying_vp_inputs;  /**< mask of VERT_BIT_* flags */
4407
4408    /** \name Derived state */
4409    GLbitfield _ImageTransferState;/**< bitwise-or of IMAGE_*_BIT flags */
4410    GLfloat _EyeZDir[3];
4411    GLfloat _ModelViewInvScale;
4412    GLboolean _NeedEyeCoords;
4413    GLboolean _ForceEyeCoords; 
4414
4415    GLuint TextureStateTimestamp; /**< detect changes to shared state */
4416
4417    struct gl_list_extensions *ListExt; /**< driver dlist extensions */
4418
4419    /** \name For debugging/development only */
4420    /*@{*/
4421    GLboolean FirstTimeCurrent;
4422    /*@}*/
4423
4424    /**
4425     * False if this context was created without a config. This is needed
4426     * because the initial state of glDrawBuffers depends on this
4427     */
4428    GLboolean HasConfig;
4429
4430    /** software compression/decompression supported or not */
4431    GLboolean Mesa_DXTn;
4432
4433    GLboolean TextureFormatSupported[MESA_FORMAT_COUNT];
4434
4435    GLboolean RasterDiscard;  /**< GL_RASTERIZER_DISCARD */
4436
4437    /**
4438     * \name Hooks for module contexts.  
4439     *
4440     * These will eventually live in the driver or elsewhere.
4441     */
4442    /*@{*/
4443    void *swrast_context;
4444    void *swsetup_context;
4445    void *swtnl_context;
4446    struct vbo_context *vbo_context;
4447    struct st_context *st;
4448    void *aelt_context;
4449    /*@}*/
4450
4451    /**
4452     * \name NV_vdpau_interop
4453     */
4454    /*@{*/
4455    const void *vdpDevice;
4456    const void *vdpGetProcAddress;
4457    struct set *vdpSurfaces;
4458    /*@}*/
4459
4460    /**
4461     * Has this context observed a GPU reset in any context in the share group?
4462     *
4463     * Once this field becomes true, it is never reset to false.
4464     */
4465    GLboolean ShareGroupReset;
4466 };
4467
4468
4469 #ifdef DEBUG
4470 extern int MESA_VERBOSE;
4471 extern int MESA_DEBUG_FLAGS;
4472 # define MESA_FUNCTION __FUNCTION__
4473 #else
4474 # define MESA_VERBOSE 0
4475 # define MESA_DEBUG_FLAGS 0
4476 # define MESA_FUNCTION "a function"
4477 # ifndef NDEBUG
4478 #  define NDEBUG
4479 # endif
4480 #endif
4481
4482
4483 /** The MESA_VERBOSE var is a bitmask of these flags */
4484 enum _verbose
4485 {
4486    VERBOSE_VARRAY               = 0x0001,
4487    VERBOSE_TEXTURE              = 0x0002,
4488    VERBOSE_MATERIAL             = 0x0004,
4489    VERBOSE_PIPELINE             = 0x0008,
4490    VERBOSE_DRIVER               = 0x0010,
4491    VERBOSE_STATE                = 0x0020,
4492    VERBOSE_API                  = 0x0040,
4493    VERBOSE_DISPLAY_LIST         = 0x0100,
4494    VERBOSE_LIGHTING             = 0x0200,
4495    VERBOSE_PRIMS                = 0x0400,
4496    VERBOSE_VERTS                = 0x0800,
4497    VERBOSE_DISASSEM             = 0x1000,
4498    VERBOSE_DRAW                 = 0x2000,
4499    VERBOSE_SWAPBUFFERS          = 0x4000
4500 };
4501
4502
4503 /** The MESA_DEBUG_FLAGS var is a bitmask of these flags */
4504 enum _debug
4505 {
4506    DEBUG_SILENT                 = (1 << 0),
4507    DEBUG_ALWAYS_FLUSH           = (1 << 1),
4508    DEBUG_INCOMPLETE_TEXTURE     = (1 << 2),
4509    DEBUG_INCOMPLETE_FBO         = (1 << 3)
4510 };
4511
4512
4513
4514 #ifdef __cplusplus
4515 }
4516 #endif
4517
4518 #endif /* MTYPES_H */