1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * Copyright 2009-2010 VMware, Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
22 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
23 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 **************************************************************************/
29 #ifndef P_SHADER_TOKENS_H
30 #define P_SHADER_TOKENS_H
39 unsigned HeaderSize
: 8;
40 unsigned BodySize
: 24;
43 #define TGSI_PROCESSOR_FRAGMENT 0
44 #define TGSI_PROCESSOR_VERTEX 1
45 #define TGSI_PROCESSOR_GEOMETRY 2
49 unsigned Processor
: 4; /* TGSI_PROCESSOR_ */
50 unsigned Padding
: 28;
53 #define TGSI_TOKEN_TYPE_DECLARATION 0
54 #define TGSI_TOKEN_TYPE_IMMEDIATE 1
55 #define TGSI_TOKEN_TYPE_INSTRUCTION 2
56 #define TGSI_TOKEN_TYPE_PROPERTY 3
60 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_x */
61 unsigned NrTokens
: 8; /**< UINT */
62 unsigned Padding
: 20;
67 TGSI_FILE_CONSTANT
=1,
70 TGSI_FILE_TEMPORARY
=4,
73 TGSI_FILE_IMMEDIATE
=7,
74 TGSI_FILE_PREDICATE
=8,
75 TGSI_FILE_SYSTEM_VALUE
=9,
76 TGSI_FILE_IMMEDIATE_ARRAY
=10,
77 TGSI_FILE_TEMPORARY_ARRAY
=11,
78 TGSI_FILE_RESOURCE
=12,
79 TGSI_FILE_COUNT
/**< how many TGSI_FILE_ types */
83 #define TGSI_WRITEMASK_NONE 0x00
84 #define TGSI_WRITEMASK_X 0x01
85 #define TGSI_WRITEMASK_Y 0x02
86 #define TGSI_WRITEMASK_XY 0x03
87 #define TGSI_WRITEMASK_Z 0x04
88 #define TGSI_WRITEMASK_XZ 0x05
89 #define TGSI_WRITEMASK_YZ 0x06
90 #define TGSI_WRITEMASK_XYZ 0x07
91 #define TGSI_WRITEMASK_W 0x08
92 #define TGSI_WRITEMASK_XW 0x09
93 #define TGSI_WRITEMASK_YW 0x0A
94 #define TGSI_WRITEMASK_XYW 0x0B
95 #define TGSI_WRITEMASK_ZW 0x0C
96 #define TGSI_WRITEMASK_XZW 0x0D
97 #define TGSI_WRITEMASK_YZW 0x0E
98 #define TGSI_WRITEMASK_XYZW 0x0F
100 #define TGSI_INTERPOLATE_CONSTANT 0
101 #define TGSI_INTERPOLATE_LINEAR 1
102 #define TGSI_INTERPOLATE_PERSPECTIVE 2
103 #define TGSI_INTERPOLATE_COLOR 3 /* special color case for smooth/flat */
104 #define TGSI_INTERPOLATE_COUNT 4
106 #define TGSI_CYLINDRICAL_WRAP_X (1 << 0)
107 #define TGSI_CYLINDRICAL_WRAP_Y (1 << 1)
108 #define TGSI_CYLINDRICAL_WRAP_Z (1 << 2)
109 #define TGSI_CYLINDRICAL_WRAP_W (1 << 3)
111 struct tgsi_declaration
113 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_DECLARATION */
114 unsigned NrTokens
: 8; /**< UINT */
115 unsigned File
: 4; /**< one of TGSI_FILE_x */
116 unsigned UsageMask
: 4; /**< bitmask of TGSI_WRITEMASK_x flags */
117 unsigned Interpolate
: 4; /**< one of TGSI_INTERPOLATE_x */
118 unsigned Dimension
: 1; /**< any extra dimension info? */
119 unsigned Semantic
: 1; /**< BOOL, any semantic info? */
120 unsigned Centroid
: 1; /**< centroid sampling? */
121 unsigned Invariant
: 1; /**< invariant optimization? */
122 unsigned CylindricalWrap
:4; /**< TGSI_CYLINDRICAL_WRAP_x flags */
125 struct tgsi_declaration_range
127 unsigned First
: 16; /**< UINT */
128 unsigned Last
: 16; /**< UINT */
131 struct tgsi_declaration_dimension
133 unsigned Index2D
:16; /**< UINT */
137 #define TGSI_SEMANTIC_POSITION 0
138 #define TGSI_SEMANTIC_COLOR 1
139 #define TGSI_SEMANTIC_BCOLOR 2 /**< back-face color */
140 #define TGSI_SEMANTIC_FOG 3
141 #define TGSI_SEMANTIC_PSIZE 4
142 #define TGSI_SEMANTIC_GENERIC 5
143 #define TGSI_SEMANTIC_NORMAL 6
144 #define TGSI_SEMANTIC_FACE 7
145 #define TGSI_SEMANTIC_EDGEFLAG 8
146 #define TGSI_SEMANTIC_PRIMID 9
147 #define TGSI_SEMANTIC_INSTANCEID 10
148 #define TGSI_SEMANTIC_VERTEXID 11
149 #define TGSI_SEMANTIC_STENCIL 12
150 #define TGSI_SEMANTIC_CLIPDIST 13
151 #define TGSI_SEMANTIC_CLIPVERTEX 14
152 #define TGSI_SEMANTIC_COUNT 15 /**< number of semantic values */
154 struct tgsi_declaration_semantic
156 unsigned Name
: 8; /**< one of TGSI_SEMANTIC_x */
157 unsigned Index
: 16; /**< UINT */
158 unsigned Padding
: 8;
161 struct tgsi_declaration_resource
{
162 unsigned Resource
: 8; /**< one of TGSI_TEXTURE_ */
163 unsigned ReturnTypeX
: 6; /**< one of enum pipe_type */
164 unsigned ReturnTypeY
: 6; /**< one of enum pipe_type */
165 unsigned ReturnTypeZ
: 6; /**< one of enum pipe_type */
166 unsigned ReturnTypeW
: 6; /**< one of enum pipe_type */
169 #define TGSI_IMM_FLOAT32 0
170 #define TGSI_IMM_UINT32 1
171 #define TGSI_IMM_INT32 2
173 struct tgsi_immediate
175 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_IMMEDIATE */
176 unsigned NrTokens
: 14; /**< UINT */
177 unsigned DataType
: 4; /**< one of TGSI_IMM_x */
178 unsigned Padding
: 10;
181 union tgsi_immediate_data
188 #define TGSI_PROPERTY_GS_INPUT_PRIM 0
189 #define TGSI_PROPERTY_GS_OUTPUT_PRIM 1
190 #define TGSI_PROPERTY_GS_MAX_OUTPUT_VERTICES 2
191 #define TGSI_PROPERTY_FS_COORD_ORIGIN 3
192 #define TGSI_PROPERTY_FS_COORD_PIXEL_CENTER 4
193 #define TGSI_PROPERTY_FS_COLOR0_WRITES_ALL_CBUFS 5
194 #define TGSI_PROPERTY_FS_DEPTH_LAYOUT 6
195 #define TGSI_PROPERTY_VS_PROHIBIT_UCPS 7
196 #define TGSI_PROPERTY_COUNT 8
198 struct tgsi_property
{
199 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_PROPERTY */
200 unsigned NrTokens
: 8; /**< UINT */
201 unsigned PropertyName
: 8; /**< one of TGSI_PROPERTY */
202 unsigned Padding
: 12;
205 #define TGSI_FS_COORD_ORIGIN_UPPER_LEFT 0
206 #define TGSI_FS_COORD_ORIGIN_LOWER_LEFT 1
208 #define TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER 0
209 #define TGSI_FS_COORD_PIXEL_CENTER_INTEGER 1
211 #define TGSI_FS_DEPTH_LAYOUT_NONE 0
212 #define TGSI_FS_DEPTH_LAYOUT_ANY 1
213 #define TGSI_FS_DEPTH_LAYOUT_GREATER 2
214 #define TGSI_FS_DEPTH_LAYOUT_LESS 3
215 #define TGSI_FS_DEPTH_LAYOUT_UNCHANGED 4
218 struct tgsi_property_data
{
224 * For more information on semantics of opcodes and
225 * which APIs are known to use which opcodes, see
226 * gallium/docs/source/tgsi.rst
228 #define TGSI_OPCODE_ARL 0
229 #define TGSI_OPCODE_MOV 1
230 #define TGSI_OPCODE_LIT 2
231 #define TGSI_OPCODE_RCP 3
232 #define TGSI_OPCODE_RSQ 4
233 #define TGSI_OPCODE_EXP 5
234 #define TGSI_OPCODE_LOG 6
235 #define TGSI_OPCODE_MUL 7
236 #define TGSI_OPCODE_ADD 8
237 #define TGSI_OPCODE_DP3 9
238 #define TGSI_OPCODE_DP4 10
239 #define TGSI_OPCODE_DST 11
240 #define TGSI_OPCODE_MIN 12
241 #define TGSI_OPCODE_MAX 13
242 #define TGSI_OPCODE_SLT 14
243 #define TGSI_OPCODE_SGE 15
244 #define TGSI_OPCODE_MAD 16
245 #define TGSI_OPCODE_SUB 17
246 #define TGSI_OPCODE_LRP 18
247 #define TGSI_OPCODE_CND 19
249 #define TGSI_OPCODE_DP2A 21
251 #define TGSI_OPCODE_FRC 24
252 #define TGSI_OPCODE_CLAMP 25
253 #define TGSI_OPCODE_FLR 26
254 #define TGSI_OPCODE_ROUND 27
255 #define TGSI_OPCODE_EX2 28
256 #define TGSI_OPCODE_LG2 29
257 #define TGSI_OPCODE_POW 30
258 #define TGSI_OPCODE_XPD 31
260 #define TGSI_OPCODE_ABS 33
261 #define TGSI_OPCODE_RCC 34
262 #define TGSI_OPCODE_DPH 35
263 #define TGSI_OPCODE_COS 36
264 #define TGSI_OPCODE_DDX 37
265 #define TGSI_OPCODE_DDY 38
266 #define TGSI_OPCODE_KILP 39 /* predicated kill */
267 #define TGSI_OPCODE_PK2H 40
268 #define TGSI_OPCODE_PK2US 41
269 #define TGSI_OPCODE_PK4B 42
270 #define TGSI_OPCODE_PK4UB 43
271 #define TGSI_OPCODE_RFL 44
272 #define TGSI_OPCODE_SEQ 45
273 #define TGSI_OPCODE_SFL 46
274 #define TGSI_OPCODE_SGT 47
275 #define TGSI_OPCODE_SIN 48
276 #define TGSI_OPCODE_SLE 49
277 #define TGSI_OPCODE_SNE 50
278 #define TGSI_OPCODE_STR 51
279 #define TGSI_OPCODE_TEX 52
280 #define TGSI_OPCODE_TXD 53
281 #define TGSI_OPCODE_TXP 54
282 #define TGSI_OPCODE_UP2H 55
283 #define TGSI_OPCODE_UP2US 56
284 #define TGSI_OPCODE_UP4B 57
285 #define TGSI_OPCODE_UP4UB 58
286 #define TGSI_OPCODE_X2D 59
287 #define TGSI_OPCODE_ARA 60
288 #define TGSI_OPCODE_ARR 61
289 #define TGSI_OPCODE_BRA 62
290 #define TGSI_OPCODE_CAL 63
291 #define TGSI_OPCODE_RET 64
292 #define TGSI_OPCODE_SSG 65 /* SGN */
293 #define TGSI_OPCODE_CMP 66
294 #define TGSI_OPCODE_SCS 67
295 #define TGSI_OPCODE_TXB 68
296 #define TGSI_OPCODE_NRM 69
297 #define TGSI_OPCODE_DIV 70
298 #define TGSI_OPCODE_DP2 71
299 #define TGSI_OPCODE_TXL 72
300 #define TGSI_OPCODE_BRK 73
301 #define TGSI_OPCODE_IF 74
303 #define TGSI_OPCODE_ELSE 77
304 #define TGSI_OPCODE_ENDIF 78
306 #define TGSI_OPCODE_PUSHA 81
307 #define TGSI_OPCODE_POPA 82
308 #define TGSI_OPCODE_CEIL 83
309 #define TGSI_OPCODE_I2F 84
310 #define TGSI_OPCODE_NOT 85
311 #define TGSI_OPCODE_TRUNC 86
312 #define TGSI_OPCODE_SHL 87
314 #define TGSI_OPCODE_AND 89
315 #define TGSI_OPCODE_OR 90
316 #define TGSI_OPCODE_MOD 91
317 #define TGSI_OPCODE_XOR 92
318 #define TGSI_OPCODE_SAD 93
319 #define TGSI_OPCODE_TXF 94
320 #define TGSI_OPCODE_TXQ 95
321 #define TGSI_OPCODE_CONT 96
322 #define TGSI_OPCODE_EMIT 97
323 #define TGSI_OPCODE_ENDPRIM 98
324 #define TGSI_OPCODE_BGNLOOP 99
325 #define TGSI_OPCODE_BGNSUB 100
326 #define TGSI_OPCODE_ENDLOOP 101
327 #define TGSI_OPCODE_ENDSUB 102
329 #define TGSI_OPCODE_NOP 107
331 #define TGSI_OPCODE_NRM4 112
332 #define TGSI_OPCODE_CALLNZ 113
333 #define TGSI_OPCODE_IFC 114
334 #define TGSI_OPCODE_BREAKC 115
335 #define TGSI_OPCODE_KIL 116 /* conditional kill */
336 #define TGSI_OPCODE_END 117 /* aka HALT */
338 #define TGSI_OPCODE_F2I 119
339 #define TGSI_OPCODE_IDIV 120
340 #define TGSI_OPCODE_IMAX 121
341 #define TGSI_OPCODE_IMIN 122
342 #define TGSI_OPCODE_INEG 123
343 #define TGSI_OPCODE_ISGE 124
344 #define TGSI_OPCODE_ISHR 125
345 #define TGSI_OPCODE_ISLT 126
346 #define TGSI_OPCODE_F2U 127
347 #define TGSI_OPCODE_U2F 128
348 #define TGSI_OPCODE_UADD 129
349 #define TGSI_OPCODE_UDIV 130
350 #define TGSI_OPCODE_UMAD 131
351 #define TGSI_OPCODE_UMAX 132
352 #define TGSI_OPCODE_UMIN 133
353 #define TGSI_OPCODE_UMOD 134
354 #define TGSI_OPCODE_UMUL 135
355 #define TGSI_OPCODE_USEQ 136
356 #define TGSI_OPCODE_USGE 137
357 #define TGSI_OPCODE_USHR 138
358 #define TGSI_OPCODE_USLT 139
359 #define TGSI_OPCODE_USNE 140
360 #define TGSI_OPCODE_SWITCH 141
361 #define TGSI_OPCODE_CASE 142
362 #define TGSI_OPCODE_DEFAULT 143
363 #define TGSI_OPCODE_ENDSWITCH 144
365 /* resource related opcodes */
366 #define TGSI_OPCODE_LOAD 145
367 #define TGSI_OPCODE_LOAD_MS 146
368 #define TGSI_OPCODE_SAMPLE 147
369 #define TGSI_OPCODE_SAMPLE_B 148
370 #define TGSI_OPCODE_SAMPLE_C 149
371 #define TGSI_OPCODE_SAMPLE_C_LZ 150
372 #define TGSI_OPCODE_SAMPLE_D 151
373 #define TGSI_OPCODE_SAMPLE_L 152
374 #define TGSI_OPCODE_GATHER4 153
375 #define TGSI_OPCODE_RESINFO 154
376 #define TGSI_OPCODE_SAMPLE_POS 155
377 #define TGSI_OPCODE_SAMPLE_INFO 156
379 #define TGSI_OPCODE_UARL 157
380 #define TGSI_OPCODE_UCMP 158
381 #define TGSI_OPCODE_IABS 159
382 #define TGSI_OPCODE_ISSG 160
384 #define TGSI_OPCODE_LAST 161
386 #define TGSI_SAT_NONE 0 /* do not saturate */
387 #define TGSI_SAT_ZERO_ONE 1 /* clamp to [0,1] */
388 #define TGSI_SAT_MINUS_PLUS_ONE 2 /* clamp to [-1,1] */
391 * Opcode is the operation code to execute. A given operation defines the
392 * semantics how the source registers (if any) are interpreted and what is
393 * written to the destination registers (if any) as a result of execution.
395 * NumDstRegs and NumSrcRegs is the number of destination and source registers,
396 * respectively. For a given operation code, those numbers are fixed and are
397 * present here only for convenience.
399 * If Predicate is TRUE, tgsi_instruction_predicate token immediately follows.
401 * Saturate controls how are final results in destination registers modified.
404 struct tgsi_instruction
406 unsigned Type
: 4; /* TGSI_TOKEN_TYPE_INSTRUCTION */
407 unsigned NrTokens
: 8; /* UINT */
408 unsigned Opcode
: 8; /* TGSI_OPCODE_ */
409 unsigned Saturate
: 2; /* TGSI_SAT_ */
410 unsigned NumDstRegs
: 2; /* UINT */
411 unsigned NumSrcRegs
: 4; /* UINT */
412 unsigned Predicate
: 1; /* BOOL */
414 unsigned Texture
: 1;
415 unsigned Padding
: 1;
419 * If tgsi_instruction::Label is TRUE, tgsi_instruction_label follows.
421 * If tgsi_instruction::Texture is TRUE, tgsi_instruction_texture follows.
422 * if texture instruction has a number of offsets,
423 * then tgsi_instruction::Texture::NumOffset of tgsi_texture_offset follow.
425 * Then, tgsi_instruction::NumDstRegs of tgsi_dst_register follow.
427 * Then, tgsi_instruction::NumSrcRegs of tgsi_src_register follow.
429 * tgsi_instruction::NrTokens contains the total number of words that make the
430 * instruction, including the instruction word.
433 #define TGSI_SWIZZLE_X 0
434 #define TGSI_SWIZZLE_Y 1
435 #define TGSI_SWIZZLE_Z 2
436 #define TGSI_SWIZZLE_W 3
438 struct tgsi_instruction_label
440 unsigned Label
: 24; /* UINT */
441 unsigned Padding
: 8;
444 #define TGSI_TEXTURE_UNKNOWN 0
445 #define TGSI_TEXTURE_1D 1
446 #define TGSI_TEXTURE_2D 2
447 #define TGSI_TEXTURE_3D 3
448 #define TGSI_TEXTURE_CUBE 4
449 #define TGSI_TEXTURE_RECT 5
450 #define TGSI_TEXTURE_SHADOW1D 6
451 #define TGSI_TEXTURE_SHADOW2D 7
452 #define TGSI_TEXTURE_SHADOWRECT 8
453 #define TGSI_TEXTURE_1D_ARRAY 9
454 #define TGSI_TEXTURE_2D_ARRAY 10
455 #define TGSI_TEXTURE_SHADOW1D_ARRAY 11
456 #define TGSI_TEXTURE_SHADOW2D_ARRAY 12
457 #define TGSI_TEXTURE_SHADOWCUBE 13
458 #define TGSI_TEXTURE_COUNT 14
460 struct tgsi_instruction_texture
462 unsigned Texture
: 8; /* TGSI_TEXTURE_ */
463 unsigned NumOffsets
: 4;
464 unsigned Padding
: 20;
467 /* for texture offsets in GLSL and DirectX.
468 * Generally these always come from TGSI_FILE_IMMEDIATE,
469 * however DX11 appears to have the capability to do
470 * non-constant texture offsets.
472 struct tgsi_texture_offset
475 unsigned File
: 4; /**< one of TGSI_FILE_x */
476 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_x */
477 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_x */
478 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_x */
479 unsigned Padding
: 6;
483 * For SM3, the following constraint applies.
484 * - Swizzle is either set to identity or replicate.
486 struct tgsi_instruction_predicate
488 int Index
: 16; /* SINT */
489 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_x */
490 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_x */
491 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_x */
492 unsigned SwizzleW
: 2; /* TGSI_SWIZZLE_x */
493 unsigned Negate
: 1; /* BOOL */
494 unsigned Padding
: 7;
498 * File specifies the register array to access.
500 * Index specifies the element number of a register in the register file.
502 * If Indirect is TRUE, Index should be offset by the X component of a source
503 * register that follows. The register can be now fetched into local storage
504 * for further processing.
506 * If Negate is TRUE, all components of the fetched register are negated.
508 * The fetched register components are swizzled according to SwizzleX, SwizzleY,
509 * SwizzleZ and SwizzleW.
513 struct tgsi_src_register
515 unsigned File
: 4; /* TGSI_FILE_ */
516 unsigned Indirect
: 1; /* BOOL */
517 unsigned Dimension
: 1; /* BOOL */
518 int Index
: 16; /* SINT */
519 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_ */
520 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_ */
521 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_ */
522 unsigned SwizzleW
: 2; /* TGSI_SWIZZLE_ */
523 unsigned Absolute
: 1; /* BOOL */
524 unsigned Negate
: 1; /* BOOL */
528 * If tgsi_src_register::Modifier is TRUE, tgsi_src_register_modifier follows.
530 * Then, if tgsi_src_register::Indirect is TRUE, another tgsi_src_register
533 * Then, if tgsi_src_register::Dimension is TRUE, tgsi_dimension follows.
537 struct tgsi_dimension
539 unsigned Indirect
: 1; /* BOOL */
540 unsigned Dimension
: 1; /* BOOL */
541 unsigned Padding
: 14;
542 int Index
: 16; /* SINT */
545 struct tgsi_dst_register
547 unsigned File
: 4; /* TGSI_FILE_ */
548 unsigned WriteMask
: 4; /* TGSI_WRITEMASK_ */
549 unsigned Indirect
: 1; /* BOOL */
550 unsigned Dimension
: 1; /* BOOL */
551 int Index
: 16; /* SINT */
552 unsigned Padding
: 6;
560 #endif /* P_SHADER_TOKENS_H */