Added few more stubs so that control reaches to DestroyDevice().
[mesa.git] / src / compiler / shader_enums.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 #ifndef SHADER_ENUMS_H
27 #define SHADER_ENUMS_H
28
29 #include <stdbool.h>
30
31 /* Project-wide (GL and Vulkan) maximum. */
32 #define MAX_DRAW_BUFFERS 8
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /**
39 * Shader stages.
40 *
41 * The order must match how shaders are ordered in the pipeline.
42 * The GLSL linker assumes that if i<j, then the j-th shader is
43 * executed later than the i-th shader.
44 */
45 typedef enum
46 {
47 MESA_SHADER_NONE = -1,
48 MESA_SHADER_VERTEX = 0,
49 MESA_SHADER_TESS_CTRL = 1,
50 MESA_SHADER_TESS_EVAL = 2,
51 MESA_SHADER_GEOMETRY = 3,
52 MESA_SHADER_FRAGMENT = 4,
53 MESA_SHADER_COMPUTE = 5,
54 /* must be last so it doesn't affect the GL pipeline */
55 MESA_SHADER_KERNEL = 6,
56 } gl_shader_stage;
57
58 static inline bool
59 gl_shader_stage_is_compute(gl_shader_stage stage)
60 {
61 return stage == MESA_SHADER_COMPUTE || stage == MESA_SHADER_KERNEL;
62 }
63
64 /**
65 * Number of STATE_* values we need to address any GL state.
66 * Used to dimension arrays.
67 */
68 #define STATE_LENGTH 5
69
70 typedef short gl_state_index16; /* see enum gl_state_index */
71
72 const char *gl_shader_stage_name(gl_shader_stage stage);
73
74 /**
75 * Translate a gl_shader_stage to a short shader stage name for debug
76 * printouts and error messages.
77 */
78 const char *_mesa_shader_stage_to_string(unsigned stage);
79
80 /**
81 * Translate a gl_shader_stage to a shader stage abbreviation (VS, GS, FS)
82 * for debug printouts and error messages.
83 */
84 const char *_mesa_shader_stage_to_abbrev(unsigned stage);
85
86 /**
87 * GL related stages (not including CL)
88 */
89 #define MESA_SHADER_STAGES (MESA_SHADER_COMPUTE + 1)
90
91 /**
92 * All stages
93 */
94 #define MESA_ALL_SHADER_STAGES (MESA_SHADER_KERNEL + 1)
95
96
97 /**
98 * Indexes for vertex program attributes.
99 * GL_NV_vertex_program aliases generic attributes over the conventional
100 * attributes. In GL_ARB_vertex_program shader the aliasing is optional.
101 * In GL_ARB_vertex_shader / OpenGL 2.0 the aliasing is disallowed (the
102 * generic attributes are distinct/separate).
103 */
104 typedef enum
105 {
106 VERT_ATTRIB_POS,
107 VERT_ATTRIB_NORMAL,
108 VERT_ATTRIB_COLOR0,
109 VERT_ATTRIB_COLOR1,
110 VERT_ATTRIB_FOG,
111 VERT_ATTRIB_COLOR_INDEX,
112 VERT_ATTRIB_EDGEFLAG,
113 VERT_ATTRIB_TEX0,
114 VERT_ATTRIB_TEX1,
115 VERT_ATTRIB_TEX2,
116 VERT_ATTRIB_TEX3,
117 VERT_ATTRIB_TEX4,
118 VERT_ATTRIB_TEX5,
119 VERT_ATTRIB_TEX6,
120 VERT_ATTRIB_TEX7,
121 VERT_ATTRIB_POINT_SIZE,
122 VERT_ATTRIB_GENERIC0,
123 VERT_ATTRIB_GENERIC1,
124 VERT_ATTRIB_GENERIC2,
125 VERT_ATTRIB_GENERIC3,
126 VERT_ATTRIB_GENERIC4,
127 VERT_ATTRIB_GENERIC5,
128 VERT_ATTRIB_GENERIC6,
129 VERT_ATTRIB_GENERIC7,
130 VERT_ATTRIB_GENERIC8,
131 VERT_ATTRIB_GENERIC9,
132 VERT_ATTRIB_GENERIC10,
133 VERT_ATTRIB_GENERIC11,
134 VERT_ATTRIB_GENERIC12,
135 VERT_ATTRIB_GENERIC13,
136 VERT_ATTRIB_GENERIC14,
137 VERT_ATTRIB_GENERIC15,
138 VERT_ATTRIB_MAX
139 } gl_vert_attrib;
140
141 const char *gl_vert_attrib_name(gl_vert_attrib 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 * VERT_ATTRIB_MAT
157 * include the generic shader attributes used to alias
158 * varying material values for the TNL shader programs.
159 * They are located at the end of the generic attribute
160 * block not to overlap with the generic 0 attribute.
161 */
162 #define VERT_ATTRIB_FF(i) (VERT_ATTRIB_POS + (i))
163 #define VERT_ATTRIB_FF_MAX VERT_ATTRIB_GENERIC0
164
165 #define VERT_ATTRIB_TEX(i) (VERT_ATTRIB_TEX0 + (i))
166 #define VERT_ATTRIB_TEX_MAX MAX_TEXTURE_COORD_UNITS
167
168 #define VERT_ATTRIB_GENERIC(i) (VERT_ATTRIB_GENERIC0 + (i))
169 #define VERT_ATTRIB_GENERIC_MAX MAX_VERTEX_GENERIC_ATTRIBS
170
171 #define VERT_ATTRIB_MAT0 \
172 (VERT_ATTRIB_GENERIC_MAX - VERT_ATTRIB_MAT_MAX)
173 #define VERT_ATTRIB_MAT(i) \
174 VERT_ATTRIB_GENERIC((i) + VERT_ATTRIB_MAT0)
175 #define VERT_ATTRIB_MAT_MAX MAT_ATTRIB_MAX
176
177 /**
178 * Bitflags for vertex attributes.
179 * These are used in bitfields in many places.
180 */
181 /*@{*/
182 #define VERT_BIT_POS BITFIELD_BIT(VERT_ATTRIB_POS)
183 #define VERT_BIT_NORMAL BITFIELD_BIT(VERT_ATTRIB_NORMAL)
184 #define VERT_BIT_COLOR0 BITFIELD_BIT(VERT_ATTRIB_COLOR0)
185 #define VERT_BIT_COLOR1 BITFIELD_BIT(VERT_ATTRIB_COLOR1)
186 #define VERT_BIT_FOG BITFIELD_BIT(VERT_ATTRIB_FOG)
187 #define VERT_BIT_COLOR_INDEX BITFIELD_BIT(VERT_ATTRIB_COLOR_INDEX)
188 #define VERT_BIT_EDGEFLAG BITFIELD_BIT(VERT_ATTRIB_EDGEFLAG)
189 #define VERT_BIT_TEX0 BITFIELD_BIT(VERT_ATTRIB_TEX0)
190 #define VERT_BIT_TEX1 BITFIELD_BIT(VERT_ATTRIB_TEX1)
191 #define VERT_BIT_TEX2 BITFIELD_BIT(VERT_ATTRIB_TEX2)
192 #define VERT_BIT_TEX3 BITFIELD_BIT(VERT_ATTRIB_TEX3)
193 #define VERT_BIT_TEX4 BITFIELD_BIT(VERT_ATTRIB_TEX4)
194 #define VERT_BIT_TEX5 BITFIELD_BIT(VERT_ATTRIB_TEX5)
195 #define VERT_BIT_TEX6 BITFIELD_BIT(VERT_ATTRIB_TEX6)
196 #define VERT_BIT_TEX7 BITFIELD_BIT(VERT_ATTRIB_TEX7)
197 #define VERT_BIT_POINT_SIZE BITFIELD_BIT(VERT_ATTRIB_POINT_SIZE)
198 #define VERT_BIT_GENERIC0 BITFIELD_BIT(VERT_ATTRIB_GENERIC0)
199
200 #define VERT_BIT(i) BITFIELD_BIT(i)
201 #define VERT_BIT_ALL BITFIELD_RANGE(0, VERT_ATTRIB_MAX)
202
203 #define VERT_BIT_FF(i) VERT_BIT(i)
204 #define VERT_BIT_FF_ALL BITFIELD_RANGE(0, VERT_ATTRIB_FF_MAX)
205 #define VERT_BIT_TEX(i) VERT_BIT(VERT_ATTRIB_TEX(i))
206 #define VERT_BIT_TEX_ALL \
207 BITFIELD_RANGE(VERT_ATTRIB_TEX(0), VERT_ATTRIB_TEX_MAX)
208
209 #define VERT_BIT_GENERIC(i) VERT_BIT(VERT_ATTRIB_GENERIC(i))
210 #define VERT_BIT_GENERIC_ALL \
211 BITFIELD_RANGE(VERT_ATTRIB_GENERIC(0), VERT_ATTRIB_GENERIC_MAX)
212
213 #define VERT_BIT_MAT(i) VERT_BIT(VERT_ATTRIB_MAT(i))
214 #define VERT_BIT_MAT_ALL \
215 BITFIELD_RANGE(VERT_ATTRIB_MAT(0), VERT_ATTRIB_MAT_MAX)
216 /*@}*/
217
218 #define MAX_VARYING 32 /**< number of float[4] vectors */
219
220 /**
221 * Indexes for vertex shader outputs, geometry shader inputs/outputs, and
222 * fragment shader inputs.
223 *
224 * Note that some of these values are not available to all pipeline stages.
225 *
226 * When this enum is updated, the following code must be updated too:
227 * - vertResults (in prog_print.c's arb_output_attrib_string())
228 * - fragAttribs (in prog_print.c's arb_input_attrib_string())
229 * - _mesa_varying_slot_in_fs()
230 */
231 typedef enum
232 {
233 VARYING_SLOT_POS,
234 VARYING_SLOT_COL0, /* COL0 and COL1 must be contiguous */
235 VARYING_SLOT_COL1,
236 VARYING_SLOT_FOGC,
237 VARYING_SLOT_TEX0, /* TEX0-TEX7 must be contiguous */
238 VARYING_SLOT_TEX1,
239 VARYING_SLOT_TEX2,
240 VARYING_SLOT_TEX3,
241 VARYING_SLOT_TEX4,
242 VARYING_SLOT_TEX5,
243 VARYING_SLOT_TEX6,
244 VARYING_SLOT_TEX7,
245 VARYING_SLOT_PSIZ, /* Does not appear in FS */
246 VARYING_SLOT_BFC0, /* Does not appear in FS */
247 VARYING_SLOT_BFC1, /* Does not appear in FS */
248 VARYING_SLOT_EDGE, /* Does not appear in FS */
249 VARYING_SLOT_CLIP_VERTEX, /* Does not appear in FS */
250 VARYING_SLOT_CLIP_DIST0,
251 VARYING_SLOT_CLIP_DIST1,
252 VARYING_SLOT_CULL_DIST0,
253 VARYING_SLOT_CULL_DIST1,
254 VARYING_SLOT_PRIMITIVE_ID, /* Does not appear in VS */
255 VARYING_SLOT_LAYER, /* Appears as VS or GS output */
256 VARYING_SLOT_VIEWPORT, /* Appears as VS or GS output */
257 VARYING_SLOT_FACE, /* FS only */
258 VARYING_SLOT_PNTC, /* FS only */
259 VARYING_SLOT_TESS_LEVEL_OUTER, /* Only appears as TCS output. */
260 VARYING_SLOT_TESS_LEVEL_INNER, /* Only appears as TCS output. */
261 VARYING_SLOT_BOUNDING_BOX0, /* Only appears as TCS output. */
262 VARYING_SLOT_BOUNDING_BOX1, /* Only appears as TCS output. */
263 VARYING_SLOT_VIEW_INDEX,
264 VARYING_SLOT_VIEWPORT_MASK, /* Does not appear in FS */
265 VARYING_SLOT_VAR0, /* First generic varying slot */
266 /* the remaining are simply for the benefit of gl_varying_slot_name()
267 * and not to be construed as an upper bound:
268 */
269 VARYING_SLOT_VAR1,
270 VARYING_SLOT_VAR2,
271 VARYING_SLOT_VAR3,
272 VARYING_SLOT_VAR4,
273 VARYING_SLOT_VAR5,
274 VARYING_SLOT_VAR6,
275 VARYING_SLOT_VAR7,
276 VARYING_SLOT_VAR8,
277 VARYING_SLOT_VAR9,
278 VARYING_SLOT_VAR10,
279 VARYING_SLOT_VAR11,
280 VARYING_SLOT_VAR12,
281 VARYING_SLOT_VAR13,
282 VARYING_SLOT_VAR14,
283 VARYING_SLOT_VAR15,
284 VARYING_SLOT_VAR16,
285 VARYING_SLOT_VAR17,
286 VARYING_SLOT_VAR18,
287 VARYING_SLOT_VAR19,
288 VARYING_SLOT_VAR20,
289 VARYING_SLOT_VAR21,
290 VARYING_SLOT_VAR22,
291 VARYING_SLOT_VAR23,
292 VARYING_SLOT_VAR24,
293 VARYING_SLOT_VAR25,
294 VARYING_SLOT_VAR26,
295 VARYING_SLOT_VAR27,
296 VARYING_SLOT_VAR28,
297 VARYING_SLOT_VAR29,
298 VARYING_SLOT_VAR30,
299 VARYING_SLOT_VAR31,
300 } gl_varying_slot;
301
302
303 #define VARYING_SLOT_MAX (VARYING_SLOT_VAR0 + MAX_VARYING)
304 #define VARYING_SLOT_PATCH0 (VARYING_SLOT_MAX)
305 #define VARYING_SLOT_TESS_MAX (VARYING_SLOT_PATCH0 + MAX_VARYING)
306 #define MAX_VARYINGS_INCL_PATCH (VARYING_SLOT_TESS_MAX - VARYING_SLOT_VAR0)
307
308 const char *gl_varying_slot_name(gl_varying_slot slot);
309
310 /**
311 * Bitflags for varying slots.
312 */
313 /*@{*/
314 #define VARYING_BIT_POS BITFIELD64_BIT(VARYING_SLOT_POS)
315 #define VARYING_BIT_COL0 BITFIELD64_BIT(VARYING_SLOT_COL0)
316 #define VARYING_BIT_COL1 BITFIELD64_BIT(VARYING_SLOT_COL1)
317 #define VARYING_BIT_FOGC BITFIELD64_BIT(VARYING_SLOT_FOGC)
318 #define VARYING_BIT_TEX0 BITFIELD64_BIT(VARYING_SLOT_TEX0)
319 #define VARYING_BIT_TEX1 BITFIELD64_BIT(VARYING_SLOT_TEX1)
320 #define VARYING_BIT_TEX2 BITFIELD64_BIT(VARYING_SLOT_TEX2)
321 #define VARYING_BIT_TEX3 BITFIELD64_BIT(VARYING_SLOT_TEX3)
322 #define VARYING_BIT_TEX4 BITFIELD64_BIT(VARYING_SLOT_TEX4)
323 #define VARYING_BIT_TEX5 BITFIELD64_BIT(VARYING_SLOT_TEX5)
324 #define VARYING_BIT_TEX6 BITFIELD64_BIT(VARYING_SLOT_TEX6)
325 #define VARYING_BIT_TEX7 BITFIELD64_BIT(VARYING_SLOT_TEX7)
326 #define VARYING_BIT_TEX(U) BITFIELD64_BIT(VARYING_SLOT_TEX0 + (U))
327 #define VARYING_BITS_TEX_ANY BITFIELD64_RANGE(VARYING_SLOT_TEX0, \
328 MAX_TEXTURE_COORD_UNITS)
329 #define VARYING_BIT_PSIZ BITFIELD64_BIT(VARYING_SLOT_PSIZ)
330 #define VARYING_BIT_BFC0 BITFIELD64_BIT(VARYING_SLOT_BFC0)
331 #define VARYING_BIT_BFC1 BITFIELD64_BIT(VARYING_SLOT_BFC1)
332 #define VARYING_BITS_COLOR (VARYING_BIT_COL0 | \
333 VARYING_BIT_COL1 | \
334 VARYING_BIT_BFC0 | \
335 VARYING_BIT_BFC1)
336 #define VARYING_BIT_EDGE BITFIELD64_BIT(VARYING_SLOT_EDGE)
337 #define VARYING_BIT_CLIP_VERTEX BITFIELD64_BIT(VARYING_SLOT_CLIP_VERTEX)
338 #define VARYING_BIT_CLIP_DIST0 BITFIELD64_BIT(VARYING_SLOT_CLIP_DIST0)
339 #define VARYING_BIT_CLIP_DIST1 BITFIELD64_BIT(VARYING_SLOT_CLIP_DIST1)
340 #define VARYING_BIT_CULL_DIST0 BITFIELD64_BIT(VARYING_SLOT_CULL_DIST0)
341 #define VARYING_BIT_CULL_DIST1 BITFIELD64_BIT(VARYING_SLOT_CULL_DIST1)
342 #define VARYING_BIT_PRIMITIVE_ID BITFIELD64_BIT(VARYING_SLOT_PRIMITIVE_ID)
343 #define VARYING_BIT_LAYER BITFIELD64_BIT(VARYING_SLOT_LAYER)
344 #define VARYING_BIT_VIEWPORT BITFIELD64_BIT(VARYING_SLOT_VIEWPORT)
345 #define VARYING_BIT_FACE BITFIELD64_BIT(VARYING_SLOT_FACE)
346 #define VARYING_BIT_PNTC BITFIELD64_BIT(VARYING_SLOT_PNTC)
347 #define VARYING_BIT_TESS_LEVEL_OUTER BITFIELD64_BIT(VARYING_SLOT_TESS_LEVEL_OUTER)
348 #define VARYING_BIT_TESS_LEVEL_INNER BITFIELD64_BIT(VARYING_SLOT_TESS_LEVEL_INNER)
349 #define VARYING_BIT_BOUNDING_BOX0 BITFIELD64_BIT(VARYING_SLOT_BOUNDING_BOX0)
350 #define VARYING_BIT_BOUNDING_BOX1 BITFIELD64_BIT(VARYING_SLOT_BOUNDING_BOX1)
351 #define VARYING_BIT_VIEWPORT_MASK BITFIELD64_BIT(VARYING_SLOT_VIEWPORT_MASK)
352 #define VARYING_BIT_VAR(V) BITFIELD64_BIT(VARYING_SLOT_VAR0 + (V))
353 /*@}*/
354
355 /**
356 * Bitflags for system values.
357 */
358 #define SYSTEM_BIT_SAMPLE_ID ((uint64_t)1 << SYSTEM_VALUE_SAMPLE_ID)
359 #define SYSTEM_BIT_SAMPLE_POS ((uint64_t)1 << SYSTEM_VALUE_SAMPLE_POS)
360 #define SYSTEM_BIT_SAMPLE_MASK_IN ((uint64_t)1 << SYSTEM_VALUE_SAMPLE_MASK_IN)
361 #define SYSTEM_BIT_LOCAL_INVOCATION_ID ((uint64_t)1 << SYSTEM_VALUE_LOCAL_INVOCATION_ID)
362
363 /**
364 * If the gl_register_file is PROGRAM_SYSTEM_VALUE, the register index will be
365 * one of these values. If a NIR variable's mode is nir_var_system_value, it
366 * will be one of these values.
367 */
368 typedef enum
369 {
370 /**
371 * \name System values applicable to all shaders
372 */
373 /*@{*/
374
375 /**
376 * Builtin variables added by GL_ARB_shader_ballot.
377 */
378 /*@{*/
379
380 /**
381 * From the GL_ARB_shader-ballot spec:
382 *
383 * "A sub-group is a collection of invocations which execute in lockstep.
384 * The variable <gl_SubGroupSizeARB> is the maximum number of
385 * invocations in a sub-group. The maximum <gl_SubGroupSizeARB>
386 * supported in this extension is 64."
387 *
388 * The spec defines this as a uniform. However, it's highly unlikely that
389 * implementations actually treat it as a uniform (which is loaded from a
390 * constant buffer). Most likely, this is an implementation-wide constant,
391 * or perhaps something that depends on the shader stage.
392 */
393 SYSTEM_VALUE_SUBGROUP_SIZE,
394
395 /**
396 * From the GL_ARB_shader_ballot spec:
397 *
398 * "The variable <gl_SubGroupInvocationARB> holds the index of the
399 * invocation within sub-group. This variable is in the range 0 to
400 * <gl_SubGroupSizeARB>-1, where <gl_SubGroupSizeARB> is the total
401 * number of invocations in a sub-group."
402 */
403 SYSTEM_VALUE_SUBGROUP_INVOCATION,
404
405 /**
406 * From the GL_ARB_shader_ballot spec:
407 *
408 * "The <gl_SubGroup??MaskARB> variables provide a bitmask for all
409 * invocations, with one bit per invocation starting with the least
410 * significant bit, according to the following table,
411 *
412 * variable equation for bit values
413 * -------------------- ------------------------------------
414 * gl_SubGroupEqMaskARB bit index == gl_SubGroupInvocationARB
415 * gl_SubGroupGeMaskARB bit index >= gl_SubGroupInvocationARB
416 * gl_SubGroupGtMaskARB bit index > gl_SubGroupInvocationARB
417 * gl_SubGroupLeMaskARB bit index <= gl_SubGroupInvocationARB
418 * gl_SubGroupLtMaskARB bit index < gl_SubGroupInvocationARB
419 */
420 SYSTEM_VALUE_SUBGROUP_EQ_MASK,
421 SYSTEM_VALUE_SUBGROUP_GE_MASK,
422 SYSTEM_VALUE_SUBGROUP_GT_MASK,
423 SYSTEM_VALUE_SUBGROUP_LE_MASK,
424 SYSTEM_VALUE_SUBGROUP_LT_MASK,
425 /*@}*/
426
427 /**
428 * Builtin variables added by VK_KHR_subgroups
429 */
430 /*@{*/
431 SYSTEM_VALUE_NUM_SUBGROUPS,
432 SYSTEM_VALUE_SUBGROUP_ID,
433 /*@}*/
434
435 /*@}*/
436
437 /**
438 * \name Vertex shader system values
439 */
440 /*@{*/
441 /**
442 * OpenGL-style vertex ID.
443 *
444 * Section 2.11.7 (Shader Execution), subsection Shader Inputs, of the
445 * OpenGL 3.3 core profile spec says:
446 *
447 * "gl_VertexID holds the integer index i implicitly passed by
448 * DrawArrays or one of the other drawing commands defined in section
449 * 2.8.3."
450 *
451 * Section 2.8.3 (Drawing Commands) of the same spec says:
452 *
453 * "The commands....are equivalent to the commands with the same base
454 * name (without the BaseVertex suffix), except that the ith element
455 * transferred by the corresponding draw call will be taken from
456 * element indices[i] + basevertex of each enabled array."
457 *
458 * Additionally, the overview in the GL_ARB_shader_draw_parameters spec
459 * says:
460 *
461 * "In unextended GL, vertex shaders have inputs named gl_VertexID and
462 * gl_InstanceID, which contain, respectively the index of the vertex
463 * and instance. The value of gl_VertexID is the implicitly passed
464 * index of the vertex being processed, which includes the value of
465 * baseVertex, for those commands that accept it."
466 *
467 * gl_VertexID gets basevertex added in. This differs from DirectX where
468 * SV_VertexID does \b not get basevertex added in.
469 *
470 * \note
471 * If all system values are available, \c SYSTEM_VALUE_VERTEX_ID will be
472 * equal to \c SYSTEM_VALUE_VERTEX_ID_ZERO_BASE plus
473 * \c SYSTEM_VALUE_BASE_VERTEX.
474 *
475 * \sa SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, SYSTEM_VALUE_BASE_VERTEX
476 */
477 SYSTEM_VALUE_VERTEX_ID,
478
479 /**
480 * Instanced ID as supplied to gl_InstanceID
481 *
482 * Values assigned to gl_InstanceID always begin with zero, regardless of
483 * the value of baseinstance.
484 *
485 * Section 11.1.3.9 (Shader Inputs) of the OpenGL 4.4 core profile spec
486 * says:
487 *
488 * "gl_InstanceID holds the integer instance number of the current
489 * primitive in an instanced draw call (see section 10.5)."
490 *
491 * Through a big chain of pseudocode, section 10.5 describes that
492 * baseinstance is not counted by gl_InstanceID. In that section, notice
493 *
494 * "If an enabled vertex attribute array is instanced (it has a
495 * non-zero divisor as specified by VertexAttribDivisor), the element
496 * index that is transferred to the GL, for all vertices, is given by
497 *
498 * floor(instance/divisor) + baseinstance
499 *
500 * If an array corresponding to an attribute required by a vertex
501 * shader is not enabled, then the corresponding element is taken from
502 * the current attribute state (see section 10.2)."
503 *
504 * Note that baseinstance is \b not included in the value of instance.
505 */
506 SYSTEM_VALUE_INSTANCE_ID,
507
508 /**
509 * Vulkan InstanceIndex.
510 *
511 * InstanceIndex = gl_InstanceID + gl_BaseInstance
512 */
513 SYSTEM_VALUE_INSTANCE_INDEX,
514
515 /**
516 * DirectX-style vertex ID.
517 *
518 * Unlike \c SYSTEM_VALUE_VERTEX_ID, this system value does \b not include
519 * the value of basevertex.
520 *
521 * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_BASE_VERTEX
522 */
523 SYSTEM_VALUE_VERTEX_ID_ZERO_BASE,
524
525 /**
526 * Value of \c basevertex passed to \c glDrawElementsBaseVertex and similar
527 * functions.
528 *
529 * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_VERTEX_ID_ZERO_BASE
530 */
531 SYSTEM_VALUE_BASE_VERTEX,
532
533 /**
534 * Depending on the type of the draw call (indexed or non-indexed),
535 * is the value of \c basevertex passed to \c glDrawElementsBaseVertex and
536 * similar, or is the value of \c first passed to \c glDrawArrays and
537 * similar.
538 *
539 * \note
540 * It can be used to calculate the \c SYSTEM_VALUE_VERTEX_ID as
541 * \c SYSTEM_VALUE_VERTEX_ID_ZERO_BASE plus \c SYSTEM_VALUE_FIRST_VERTEX.
542 *
543 * \sa SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, SYSTEM_VALUE_VERTEX_ID
544 */
545 SYSTEM_VALUE_FIRST_VERTEX,
546
547 /**
548 * If the Draw command used to start the rendering was an indexed draw
549 * or not (~0/0). Useful to calculate \c SYSTEM_VALUE_BASE_VERTEX as
550 * \c SYSTEM_VALUE_IS_INDEXED_DRAW & \c SYSTEM_VALUE_FIRST_VERTEX.
551 */
552 SYSTEM_VALUE_IS_INDEXED_DRAW,
553
554 /**
555 * Value of \c baseinstance passed to instanced draw entry points
556 *
557 * \sa SYSTEM_VALUE_INSTANCE_ID
558 */
559 SYSTEM_VALUE_BASE_INSTANCE,
560
561 /**
562 * From _ARB_shader_draw_parameters:
563 *
564 * "Additionally, this extension adds a further built-in variable,
565 * gl_DrawID to the shading language. This variable contains the index
566 * of the draw currently being processed by a Multi* variant of a
567 * drawing command (such as MultiDrawElements or
568 * MultiDrawArraysIndirect)."
569 *
570 * If GL_ARB_multi_draw_indirect is not supported, this is always 0.
571 */
572 SYSTEM_VALUE_DRAW_ID,
573 /*@}*/
574
575 /**
576 * \name Geometry shader system values
577 */
578 /*@{*/
579 SYSTEM_VALUE_INVOCATION_ID, /**< (Also in Tessellation Control shader) */
580 /*@}*/
581
582 /**
583 * \name Fragment shader system values
584 */
585 /*@{*/
586 SYSTEM_VALUE_FRAG_COORD,
587 SYSTEM_VALUE_POINT_COORD,
588 SYSTEM_VALUE_LINE_COORD, /**< Coord along axis perpendicular to line */
589 SYSTEM_VALUE_FRONT_FACE,
590 SYSTEM_VALUE_SAMPLE_ID,
591 SYSTEM_VALUE_SAMPLE_POS,
592 SYSTEM_VALUE_SAMPLE_MASK_IN,
593 SYSTEM_VALUE_HELPER_INVOCATION,
594 SYSTEM_VALUE_COLOR0,
595 SYSTEM_VALUE_COLOR1,
596 /*@}*/
597
598 /**
599 * \name Tessellation Evaluation shader system values
600 */
601 /*@{*/
602 SYSTEM_VALUE_TESS_COORD,
603 SYSTEM_VALUE_VERTICES_IN, /**< Tessellation vertices in input patch */
604 SYSTEM_VALUE_PRIMITIVE_ID,
605 SYSTEM_VALUE_TESS_LEVEL_OUTER, /**< TES input */
606 SYSTEM_VALUE_TESS_LEVEL_INNER, /**< TES input */
607 SYSTEM_VALUE_TESS_LEVEL_OUTER_DEFAULT, /**< TCS input for passthru TCS */
608 SYSTEM_VALUE_TESS_LEVEL_INNER_DEFAULT, /**< TCS input for passthru TCS */
609 /*@}*/
610
611 /**
612 * \name Compute shader system values
613 */
614 /*@{*/
615 SYSTEM_VALUE_LOCAL_INVOCATION_ID,
616 SYSTEM_VALUE_LOCAL_INVOCATION_INDEX,
617 SYSTEM_VALUE_GLOBAL_INVOCATION_ID,
618 SYSTEM_VALUE_BASE_GLOBAL_INVOCATION_ID,
619 SYSTEM_VALUE_GLOBAL_INVOCATION_INDEX,
620 SYSTEM_VALUE_WORK_GROUP_ID,
621 SYSTEM_VALUE_NUM_WORK_GROUPS,
622 SYSTEM_VALUE_LOCAL_GROUP_SIZE,
623 SYSTEM_VALUE_GLOBAL_GROUP_SIZE,
624 SYSTEM_VALUE_WORK_DIM,
625 SYSTEM_VALUE_USER_DATA_AMD,
626 /*@}*/
627
628 /** Required for VK_KHR_device_group */
629 SYSTEM_VALUE_DEVICE_INDEX,
630
631 /** Required for VK_KHX_multiview */
632 SYSTEM_VALUE_VIEW_INDEX,
633
634 /**
635 * Driver internal vertex-count, used (for example) for drivers to
636 * calculate stride for stream-out outputs. Not externally visible.
637 */
638 SYSTEM_VALUE_VERTEX_CNT,
639
640 /**
641 * Required for AMD_shader_explicit_vertex_parameter and also used for
642 * varying-fetch instructions.
643 *
644 * The _SIZE value is "primitive size", used to scale i/j in primitive
645 * space to pixel space.
646 */
647 SYSTEM_VALUE_BARYCENTRIC_PERSP_PIXEL,
648 SYSTEM_VALUE_BARYCENTRIC_PERSP_SAMPLE,
649 SYSTEM_VALUE_BARYCENTRIC_PERSP_CENTROID,
650 SYSTEM_VALUE_BARYCENTRIC_PERSP_SIZE,
651 SYSTEM_VALUE_BARYCENTRIC_LINEAR_PIXEL,
652 SYSTEM_VALUE_BARYCENTRIC_LINEAR_CENTROID,
653 SYSTEM_VALUE_BARYCENTRIC_LINEAR_SAMPLE,
654 SYSTEM_VALUE_BARYCENTRIC_PULL_MODEL,
655
656 /**
657 * IR3 specific geometry shader and tesselation control shader system
658 * values that packs invocation id, thread id and vertex id. Having this
659 * as a nir level system value lets us do the unpacking in nir.
660 */
661 SYSTEM_VALUE_GS_HEADER_IR3,
662 SYSTEM_VALUE_TCS_HEADER_IR3,
663
664 SYSTEM_VALUE_MAX /**< Number of values */
665 } gl_system_value;
666
667 const char *gl_system_value_name(gl_system_value sysval);
668
669 /**
670 * The possible interpolation qualifiers that can be applied to a fragment
671 * shader input in GLSL.
672 *
673 * Note: INTERP_MODE_NONE must be 0 so that memsetting the
674 * ir_variable data structure to 0 causes the default behavior.
675 */
676 enum glsl_interp_mode
677 {
678 INTERP_MODE_NONE = 0,
679 INTERP_MODE_SMOOTH,
680 INTERP_MODE_FLAT,
681 INTERP_MODE_NOPERSPECTIVE,
682 INTERP_MODE_EXPLICIT,
683 INTERP_MODE_COLOR, /**< glShadeModel determines the interp mode */
684 INTERP_MODE_COUNT /**< Number of interpolation qualifiers */
685 };
686
687 enum glsl_interface_packing {
688 GLSL_INTERFACE_PACKING_STD140,
689 GLSL_INTERFACE_PACKING_SHARED,
690 GLSL_INTERFACE_PACKING_PACKED,
691 GLSL_INTERFACE_PACKING_STD430
692 };
693
694 const char *glsl_interp_mode_name(enum glsl_interp_mode qual);
695
696 /**
697 * Fragment program results
698 */
699 typedef enum
700 {
701 FRAG_RESULT_DEPTH = 0,
702 FRAG_RESULT_STENCIL = 1,
703 /* If a single color should be written to all render targets, this
704 * register is written. No FRAG_RESULT_DATAn will be written.
705 */
706 FRAG_RESULT_COLOR = 2,
707 FRAG_RESULT_SAMPLE_MASK = 3,
708
709 /* FRAG_RESULT_DATAn are the per-render-target (GLSL gl_FragData[n]
710 * or ARB_fragment_program fragment.color[n]) color results. If
711 * any are written, FRAG_RESULT_COLOR will not be written.
712 * FRAG_RESULT_DATA1 and up are simply for the benefit of
713 * gl_frag_result_name() and not to be construed as an upper bound
714 */
715 FRAG_RESULT_DATA0 = 4,
716 FRAG_RESULT_DATA1,
717 FRAG_RESULT_DATA2,
718 FRAG_RESULT_DATA3,
719 FRAG_RESULT_DATA4,
720 FRAG_RESULT_DATA5,
721 FRAG_RESULT_DATA6,
722 FRAG_RESULT_DATA7,
723 } gl_frag_result;
724
725 const char *gl_frag_result_name(gl_frag_result result);
726
727 #define FRAG_RESULT_MAX (FRAG_RESULT_DATA0 + MAX_DRAW_BUFFERS)
728
729 /**
730 * \brief Layout qualifiers for gl_FragDepth.
731 *
732 * Extension AMD_conservative_depth allows gl_FragDepth to be redeclared with
733 * a layout qualifier.
734 *
735 * \see enum ir_depth_layout
736 */
737 enum gl_frag_depth_layout
738 {
739 FRAG_DEPTH_LAYOUT_NONE, /**< No layout is specified. */
740 FRAG_DEPTH_LAYOUT_ANY,
741 FRAG_DEPTH_LAYOUT_GREATER,
742 FRAG_DEPTH_LAYOUT_LESS,
743 FRAG_DEPTH_LAYOUT_UNCHANGED
744 };
745
746 /**
747 * \brief Buffer access qualifiers
748 */
749 enum gl_access_qualifier
750 {
751 ACCESS_COHERENT = (1 << 0),
752 ACCESS_RESTRICT = (1 << 1),
753 ACCESS_VOLATILE = (1 << 2),
754 ACCESS_NON_READABLE = (1 << 3),
755 ACCESS_NON_WRITEABLE = (1 << 4),
756
757 /** The access may use a non-uniform buffer or image index */
758 ACCESS_NON_UNIFORM = (1 << 5),
759
760 /* This has the same semantics as NIR_INTRINSIC_CAN_REORDER, only to be
761 * used with loads. In other words, it means that the load can be
762 * arbitrarily reordered, or combined with other loads to the same address.
763 * It is implied by ACCESS_NON_WRITEABLE together with ACCESS_RESTRICT, and
764 * a lack of ACCESS_COHERENT and ACCESS_VOLATILE.
765 */
766 ACCESS_CAN_REORDER = (1 << 6),
767
768 /** Use as little cache space as possible. */
769 ACCESS_STREAM_CACHE_POLICY = (1 << 7),
770 };
771
772 /**
773 * \brief Blend support qualifiers
774 */
775 enum gl_advanced_blend_mode
776 {
777 BLEND_NONE = 0,
778 BLEND_MULTIPLY,
779 BLEND_SCREEN,
780 BLEND_OVERLAY,
781 BLEND_DARKEN,
782 BLEND_LIGHTEN,
783 BLEND_COLORDODGE,
784 BLEND_COLORBURN,
785 BLEND_HARDLIGHT,
786 BLEND_SOFTLIGHT,
787 BLEND_DIFFERENCE,
788 BLEND_EXCLUSION,
789 BLEND_HSL_HUE,
790 BLEND_HSL_SATURATION,
791 BLEND_HSL_COLOR,
792 BLEND_HSL_LUMINOSITY,
793 };
794
795 enum blend_func
796 {
797 BLEND_FUNC_ADD,
798 BLEND_FUNC_SUBTRACT,
799 BLEND_FUNC_REVERSE_SUBTRACT,
800 BLEND_FUNC_MIN,
801 BLEND_FUNC_MAX,
802 };
803
804 enum blend_factor
805 {
806 BLEND_FACTOR_ZERO,
807 BLEND_FACTOR_SRC_COLOR,
808 BLEND_FACTOR_SRC1_COLOR,
809 BLEND_FACTOR_DST_COLOR,
810 BLEND_FACTOR_SRC_ALPHA,
811 BLEND_FACTOR_SRC1_ALPHA,
812 BLEND_FACTOR_DST_ALPHA,
813 BLEND_FACTOR_CONSTANT_COLOR,
814 BLEND_FACTOR_CONSTANT_ALPHA,
815 BLEND_FACTOR_SRC_ALPHA_SATURATE,
816 };
817
818 enum gl_tess_spacing
819 {
820 TESS_SPACING_UNSPECIFIED,
821 TESS_SPACING_EQUAL,
822 TESS_SPACING_FRACTIONAL_ODD,
823 TESS_SPACING_FRACTIONAL_EVEN,
824 };
825
826 /**
827 * A compare function enum for use in compiler lowering passes. This is in
828 * the same order as GL's compare functions (shifted down by GL_NEVER), and is
829 * exactly the same as gallium's PIPE_FUNC_*.
830 */
831 enum compare_func
832 {
833 COMPARE_FUNC_NEVER,
834 COMPARE_FUNC_LESS,
835 COMPARE_FUNC_EQUAL,
836 COMPARE_FUNC_LEQUAL,
837 COMPARE_FUNC_GREATER,
838 COMPARE_FUNC_NOTEQUAL,
839 COMPARE_FUNC_GEQUAL,
840 COMPARE_FUNC_ALWAYS,
841 };
842
843 /**
844 * Arrangements for grouping invocations from NV_compute_shader_derivatives.
845 *
846 * The extension provides new layout qualifiers that support two different
847 * arrangements of compute shader invocations for the purpose of derivative
848 * computation. When specifying
849 *
850 * layout(derivative_group_quadsNV) in;
851 *
852 * compute shader invocations are grouped into 2x2x1 arrays whose four local
853 * invocation ID values follow the pattern:
854 *
855 * +-----------------+------------------+
856 * | (2x+0, 2y+0, z) | (2x+1, 2y+0, z) |
857 * +-----------------+------------------+
858 * | (2x+0, 2y+1, z) | (2x+1, 2y+1, z) |
859 * +-----------------+------------------+
860 *
861 * where Y increases from bottom to top. When specifying
862 *
863 * layout(derivative_group_linearNV) in;
864 *
865 * compute shader invocations are grouped into 2x2x1 arrays whose four local
866 * invocation index values follow the pattern:
867 *
868 * +------+------+
869 * | 4n+0 | 4n+1 |
870 * +------+------+
871 * | 4n+2 | 4n+3 |
872 * +------+------+
873 *
874 * If neither layout qualifier is specified, derivatives in compute shaders
875 * return zero, which is consistent with the handling of built-in texture
876 * functions like texture() in GLSL 4.50 compute shaders.
877 */
878 enum gl_derivative_group {
879 DERIVATIVE_GROUP_NONE = 0,
880 DERIVATIVE_GROUP_QUADS,
881 DERIVATIVE_GROUP_LINEAR,
882 };
883
884 enum float_controls
885 {
886 FLOAT_CONTROLS_DEFAULT_FLOAT_CONTROL_MODE = 0x0000,
887 FLOAT_CONTROLS_DENORM_PRESERVE_FP16 = 0x0001,
888 FLOAT_CONTROLS_DENORM_PRESERVE_FP32 = 0x0002,
889 FLOAT_CONTROLS_DENORM_PRESERVE_FP64 = 0x0004,
890 FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP16 = 0x0008,
891 FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP32 = 0x0010,
892 FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP64 = 0x0020,
893 FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP16 = 0x0040,
894 FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP32 = 0x0080,
895 FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP64 = 0x0100,
896 FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP16 = 0x0200,
897 FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP32 = 0x0400,
898 FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP64 = 0x0800,
899 FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP16 = 0x1000,
900 FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP32 = 0x2000,
901 FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP64 = 0x4000,
902 };
903
904 /**
905 * Enums to describe sampler properties used by OpenCL's inline constant samplers.
906 * These values match the meanings described in the SPIR-V spec.
907 */
908 enum cl_sampler_addressing_mode {
909 SAMPLER_ADDRESSING_MODE_NONE = 0,
910 SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE = 1,
911 SAMPLER_ADDRESSING_MODE_CLAMP = 2,
912 SAMPLER_ADDRESSING_MODE_REPEAT = 3,
913 SAMPLER_ADDRESSING_MODE_REPEAT_MIRRORED = 4,
914 };
915
916 enum cl_sampler_filter_mode {
917 SAMPLER_FILTER_MODE_NEAREST = 0,
918 SAMPLER_FILTER_MODE_LINEAR = 1,
919 };
920
921 #ifdef __cplusplus
922 } /* extern "C" */
923 #endif
924
925 #endif /* SHADER_ENUMS_H */