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_COUNT 3
105 #define TGSI_CYLINDRICAL_WRAP_X (1 << 0)
106 #define TGSI_CYLINDRICAL_WRAP_Y (1 << 1)
107 #define TGSI_CYLINDRICAL_WRAP_Z (1 << 2)
108 #define TGSI_CYLINDRICAL_WRAP_W (1 << 3)
110 struct tgsi_declaration
112 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_DECLARATION */
113 unsigned NrTokens
: 8; /**< UINT */
114 unsigned File
: 4; /**< one of TGSI_FILE_x */
115 unsigned UsageMask
: 4; /**< bitmask of TGSI_WRITEMASK_x flags */
116 unsigned Interpolate
: 4; /**< one of TGSI_INTERPOLATE_x */
117 unsigned Dimension
: 1; /**< any extra dimension info? */
118 unsigned Semantic
: 1; /**< BOOL, any semantic info? */
119 unsigned Centroid
: 1; /**< centroid sampling? */
120 unsigned Invariant
: 1; /**< invariant optimization? */
121 unsigned CylindricalWrap
:4; /**< TGSI_CYLINDRICAL_WRAP_x flags */
124 struct tgsi_declaration_range
126 unsigned First
: 16; /**< UINT */
127 unsigned Last
: 16; /**< UINT */
130 struct tgsi_declaration_dimension
132 unsigned Index2D
:16; /**< UINT */
136 #define TGSI_SEMANTIC_POSITION 0
137 #define TGSI_SEMANTIC_COLOR 1
138 #define TGSI_SEMANTIC_BCOLOR 2 /**< back-face color */
139 #define TGSI_SEMANTIC_FOG 3
140 #define TGSI_SEMANTIC_PSIZE 4
141 #define TGSI_SEMANTIC_GENERIC 5
142 #define TGSI_SEMANTIC_NORMAL 6
143 #define TGSI_SEMANTIC_FACE 7
144 #define TGSI_SEMANTIC_EDGEFLAG 8
145 #define TGSI_SEMANTIC_PRIMID 9
146 #define TGSI_SEMANTIC_INSTANCEID 10
147 #define TGSI_SEMANTIC_VERTEXID 11
148 #define TGSI_SEMANTIC_STENCIL 12
149 #define TGSI_SEMANTIC_CLIPDIST 13
150 #define TGSI_SEMANTIC_CLIPVERTEX 14
151 #define TGSI_SEMANTIC_COUNT 15 /**< number of semantic values */
153 struct tgsi_declaration_semantic
155 unsigned Name
: 8; /**< one of TGSI_SEMANTIC_x */
156 unsigned Index
: 16; /**< UINT */
157 unsigned Padding
: 8;
160 struct tgsi_declaration_resource
{
161 unsigned Resource
: 8; /**< one of TGSI_TEXTURE_ */
162 unsigned ReturnTypeX
: 6; /**< one of enum pipe_type */
163 unsigned ReturnTypeY
: 6; /**< one of enum pipe_type */
164 unsigned ReturnTypeZ
: 6; /**< one of enum pipe_type */
165 unsigned ReturnTypeW
: 6; /**< one of enum pipe_type */
168 #define TGSI_IMM_FLOAT32 0
169 #define TGSI_IMM_UINT32 1
170 #define TGSI_IMM_INT32 2
172 struct tgsi_immediate
174 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_IMMEDIATE */
175 unsigned NrTokens
: 14; /**< UINT */
176 unsigned DataType
: 4; /**< one of TGSI_IMM_x */
177 unsigned Padding
: 10;
180 union tgsi_immediate_data
187 #define TGSI_PROPERTY_GS_INPUT_PRIM 0
188 #define TGSI_PROPERTY_GS_OUTPUT_PRIM 1
189 #define TGSI_PROPERTY_GS_MAX_OUTPUT_VERTICES 2
190 #define TGSI_PROPERTY_FS_COORD_ORIGIN 3
191 #define TGSI_PROPERTY_FS_COORD_PIXEL_CENTER 4
192 #define TGSI_PROPERTY_FS_COLOR0_WRITES_ALL_CBUFS 5
193 #define TGSI_PROPERTY_FS_DEPTH_LAYOUT 6
194 #define TGSI_PROPERTY_VS_PROHIBIT_UCPS 7
195 #define TGSI_PROPERTY_COUNT 8
197 struct tgsi_property
{
198 unsigned Type
: 4; /**< TGSI_TOKEN_TYPE_PROPERTY */
199 unsigned NrTokens
: 8; /**< UINT */
200 unsigned PropertyName
: 8; /**< one of TGSI_PROPERTY */
201 unsigned Padding
: 12;
204 #define TGSI_FS_COORD_ORIGIN_UPPER_LEFT 0
205 #define TGSI_FS_COORD_ORIGIN_LOWER_LEFT 1
207 #define TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER 0
208 #define TGSI_FS_COORD_PIXEL_CENTER_INTEGER 1
210 #define TGSI_FS_DEPTH_LAYOUT_NONE 0
211 #define TGSI_FS_DEPTH_LAYOUT_ANY 1
212 #define TGSI_FS_DEPTH_LAYOUT_GREATER 2
213 #define TGSI_FS_DEPTH_LAYOUT_LESS 3
214 #define TGSI_FS_DEPTH_LAYOUT_UNCHANGED 4
217 struct tgsi_property_data
{
223 * For more information on semantics of opcodes and
224 * which APIs are known to use which opcodes, see
225 * gallium/docs/source/tgsi.rst
227 #define TGSI_OPCODE_ARL 0
228 #define TGSI_OPCODE_MOV 1
229 #define TGSI_OPCODE_LIT 2
230 #define TGSI_OPCODE_RCP 3
231 #define TGSI_OPCODE_RSQ 4
232 #define TGSI_OPCODE_EXP 5
233 #define TGSI_OPCODE_LOG 6
234 #define TGSI_OPCODE_MUL 7
235 #define TGSI_OPCODE_ADD 8
236 #define TGSI_OPCODE_DP3 9
237 #define TGSI_OPCODE_DP4 10
238 #define TGSI_OPCODE_DST 11
239 #define TGSI_OPCODE_MIN 12
240 #define TGSI_OPCODE_MAX 13
241 #define TGSI_OPCODE_SLT 14
242 #define TGSI_OPCODE_SGE 15
243 #define TGSI_OPCODE_MAD 16
244 #define TGSI_OPCODE_SUB 17
245 #define TGSI_OPCODE_LRP 18
246 #define TGSI_OPCODE_CND 19
248 #define TGSI_OPCODE_DP2A 21
250 #define TGSI_OPCODE_FRC 24
251 #define TGSI_OPCODE_CLAMP 25
252 #define TGSI_OPCODE_FLR 26
253 #define TGSI_OPCODE_ROUND 27
254 #define TGSI_OPCODE_EX2 28
255 #define TGSI_OPCODE_LG2 29
256 #define TGSI_OPCODE_POW 30
257 #define TGSI_OPCODE_XPD 31
259 #define TGSI_OPCODE_ABS 33
260 #define TGSI_OPCODE_RCC 34
261 #define TGSI_OPCODE_DPH 35
262 #define TGSI_OPCODE_COS 36
263 #define TGSI_OPCODE_DDX 37
264 #define TGSI_OPCODE_DDY 38
265 #define TGSI_OPCODE_KILP 39 /* predicated kill */
266 #define TGSI_OPCODE_PK2H 40
267 #define TGSI_OPCODE_PK2US 41
268 #define TGSI_OPCODE_PK4B 42
269 #define TGSI_OPCODE_PK4UB 43
270 #define TGSI_OPCODE_RFL 44
271 #define TGSI_OPCODE_SEQ 45
272 #define TGSI_OPCODE_SFL 46
273 #define TGSI_OPCODE_SGT 47
274 #define TGSI_OPCODE_SIN 48
275 #define TGSI_OPCODE_SLE 49
276 #define TGSI_OPCODE_SNE 50
277 #define TGSI_OPCODE_STR 51
278 #define TGSI_OPCODE_TEX 52
279 #define TGSI_OPCODE_TXD 53
280 #define TGSI_OPCODE_TXP 54
281 #define TGSI_OPCODE_UP2H 55
282 #define TGSI_OPCODE_UP2US 56
283 #define TGSI_OPCODE_UP4B 57
284 #define TGSI_OPCODE_UP4UB 58
285 #define TGSI_OPCODE_X2D 59
286 #define TGSI_OPCODE_ARA 60
287 #define TGSI_OPCODE_ARR 61
288 #define TGSI_OPCODE_BRA 62
289 #define TGSI_OPCODE_CAL 63
290 #define TGSI_OPCODE_RET 64
291 #define TGSI_OPCODE_SSG 65 /* SGN */
292 #define TGSI_OPCODE_CMP 66
293 #define TGSI_OPCODE_SCS 67
294 #define TGSI_OPCODE_TXB 68
295 #define TGSI_OPCODE_NRM 69
296 #define TGSI_OPCODE_DIV 70
297 #define TGSI_OPCODE_DP2 71
298 #define TGSI_OPCODE_TXL 72
299 #define TGSI_OPCODE_BRK 73
300 #define TGSI_OPCODE_IF 74
302 #define TGSI_OPCODE_ELSE 77
303 #define TGSI_OPCODE_ENDIF 78
305 #define TGSI_OPCODE_PUSHA 81
306 #define TGSI_OPCODE_POPA 82
307 #define TGSI_OPCODE_CEIL 83
308 #define TGSI_OPCODE_I2F 84
309 #define TGSI_OPCODE_NOT 85
310 #define TGSI_OPCODE_TRUNC 86
311 #define TGSI_OPCODE_SHL 87
313 #define TGSI_OPCODE_AND 89
314 #define TGSI_OPCODE_OR 90
315 #define TGSI_OPCODE_MOD 91
316 #define TGSI_OPCODE_XOR 92
317 #define TGSI_OPCODE_SAD 93
318 #define TGSI_OPCODE_TXF 94
319 #define TGSI_OPCODE_TXQ 95
320 #define TGSI_OPCODE_CONT 96
321 #define TGSI_OPCODE_EMIT 97
322 #define TGSI_OPCODE_ENDPRIM 98
323 #define TGSI_OPCODE_BGNLOOP 99
324 #define TGSI_OPCODE_BGNSUB 100
325 #define TGSI_OPCODE_ENDLOOP 101
326 #define TGSI_OPCODE_ENDSUB 102
328 #define TGSI_OPCODE_NOP 107
330 #define TGSI_OPCODE_NRM4 112
331 #define TGSI_OPCODE_CALLNZ 113
332 #define TGSI_OPCODE_IFC 114
333 #define TGSI_OPCODE_BREAKC 115
334 #define TGSI_OPCODE_KIL 116 /* conditional kill */
335 #define TGSI_OPCODE_END 117 /* aka HALT */
337 #define TGSI_OPCODE_F2I 119
338 #define TGSI_OPCODE_IDIV 120
339 #define TGSI_OPCODE_IMAX 121
340 #define TGSI_OPCODE_IMIN 122
341 #define TGSI_OPCODE_INEG 123
342 #define TGSI_OPCODE_ISGE 124
343 #define TGSI_OPCODE_ISHR 125
344 #define TGSI_OPCODE_ISLT 126
345 #define TGSI_OPCODE_F2U 127
346 #define TGSI_OPCODE_U2F 128
347 #define TGSI_OPCODE_UADD 129
348 #define TGSI_OPCODE_UDIV 130
349 #define TGSI_OPCODE_UMAD 131
350 #define TGSI_OPCODE_UMAX 132
351 #define TGSI_OPCODE_UMIN 133
352 #define TGSI_OPCODE_UMOD 134
353 #define TGSI_OPCODE_UMUL 135
354 #define TGSI_OPCODE_USEQ 136
355 #define TGSI_OPCODE_USGE 137
356 #define TGSI_OPCODE_USHR 138
357 #define TGSI_OPCODE_USLT 139
358 #define TGSI_OPCODE_USNE 140
359 #define TGSI_OPCODE_SWITCH 141
360 #define TGSI_OPCODE_CASE 142
361 #define TGSI_OPCODE_DEFAULT 143
362 #define TGSI_OPCODE_ENDSWITCH 144
364 /* resource related opcodes */
365 #define TGSI_OPCODE_LOAD 145
366 #define TGSI_OPCODE_LOAD_MS 146
367 #define TGSI_OPCODE_SAMPLE 147
368 #define TGSI_OPCODE_SAMPLE_B 148
369 #define TGSI_OPCODE_SAMPLE_C 149
370 #define TGSI_OPCODE_SAMPLE_C_LZ 150
371 #define TGSI_OPCODE_SAMPLE_D 151
372 #define TGSI_OPCODE_SAMPLE_L 152
373 #define TGSI_OPCODE_GATHER4 153
374 #define TGSI_OPCODE_RESINFO 154
375 #define TGSI_OPCODE_SAMPLE_POS 155
376 #define TGSI_OPCODE_SAMPLE_INFO 156
378 #define TGSI_OPCODE_UARL 157
379 #define TGSI_OPCODE_UCMP 158
380 #define TGSI_OPCODE_IABS 159
382 #define TGSI_OPCODE_LAST 160
384 #define TGSI_SAT_NONE 0 /* do not saturate */
385 #define TGSI_SAT_ZERO_ONE 1 /* clamp to [0,1] */
386 #define TGSI_SAT_MINUS_PLUS_ONE 2 /* clamp to [-1,1] */
389 * Opcode is the operation code to execute. A given operation defines the
390 * semantics how the source registers (if any) are interpreted and what is
391 * written to the destination registers (if any) as a result of execution.
393 * NumDstRegs and NumSrcRegs is the number of destination and source registers,
394 * respectively. For a given operation code, those numbers are fixed and are
395 * present here only for convenience.
397 * If Predicate is TRUE, tgsi_instruction_predicate token immediately follows.
399 * Saturate controls how are final results in destination registers modified.
402 struct tgsi_instruction
404 unsigned Type
: 4; /* TGSI_TOKEN_TYPE_INSTRUCTION */
405 unsigned NrTokens
: 8; /* UINT */
406 unsigned Opcode
: 8; /* TGSI_OPCODE_ */
407 unsigned Saturate
: 2; /* TGSI_SAT_ */
408 unsigned NumDstRegs
: 2; /* UINT */
409 unsigned NumSrcRegs
: 4; /* UINT */
410 unsigned Predicate
: 1; /* BOOL */
412 unsigned Texture
: 1;
413 unsigned Padding
: 1;
417 * If tgsi_instruction::Label is TRUE, tgsi_instruction_label follows.
419 * If tgsi_instruction::Texture is TRUE, tgsi_instruction_texture follows.
420 * if texture instruction has a number of offsets,
421 * then tgsi_instruction::Texture::NumOffset of tgsi_texture_offset follow.
423 * Then, tgsi_instruction::NumDstRegs of tgsi_dst_register follow.
425 * Then, tgsi_instruction::NumSrcRegs of tgsi_src_register follow.
427 * tgsi_instruction::NrTokens contains the total number of words that make the
428 * instruction, including the instruction word.
431 #define TGSI_SWIZZLE_X 0
432 #define TGSI_SWIZZLE_Y 1
433 #define TGSI_SWIZZLE_Z 2
434 #define TGSI_SWIZZLE_W 3
436 struct tgsi_instruction_label
438 unsigned Label
: 24; /* UINT */
439 unsigned Padding
: 8;
442 #define TGSI_TEXTURE_UNKNOWN 0
443 #define TGSI_TEXTURE_1D 1
444 #define TGSI_TEXTURE_2D 2
445 #define TGSI_TEXTURE_3D 3
446 #define TGSI_TEXTURE_CUBE 4
447 #define TGSI_TEXTURE_RECT 5
448 #define TGSI_TEXTURE_SHADOW1D 6
449 #define TGSI_TEXTURE_SHADOW2D 7
450 #define TGSI_TEXTURE_SHADOWRECT 8
451 #define TGSI_TEXTURE_1D_ARRAY 9
452 #define TGSI_TEXTURE_2D_ARRAY 10
453 #define TGSI_TEXTURE_SHADOW1D_ARRAY 11
454 #define TGSI_TEXTURE_SHADOW2D_ARRAY 12
455 #define TGSI_TEXTURE_COUNT 13
457 struct tgsi_instruction_texture
459 unsigned Texture
: 8; /* TGSI_TEXTURE_ */
460 unsigned NumOffsets
: 4;
461 unsigned Padding
: 20;
464 /* for texture offsets in GLSL and DirectX.
465 * Generally these always come from TGSI_FILE_IMMEDIATE,
466 * however DX11 appears to have the capability to do
467 * non-constant texture offsets.
469 struct tgsi_texture_offset
472 unsigned File
: 4; /**< one of TGSI_FILE_x */
473 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_x */
474 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_x */
475 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_x */
476 unsigned Padding
: 6;
480 * For SM3, the following constraint applies.
481 * - Swizzle is either set to identity or replicate.
483 struct tgsi_instruction_predicate
485 int Index
: 16; /* SINT */
486 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_x */
487 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_x */
488 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_x */
489 unsigned SwizzleW
: 2; /* TGSI_SWIZZLE_x */
490 unsigned Negate
: 1; /* BOOL */
491 unsigned Padding
: 7;
495 * File specifies the register array to access.
497 * Index specifies the element number of a register in the register file.
499 * If Indirect is TRUE, Index should be offset by the X component of a source
500 * register that follows. The register can be now fetched into local storage
501 * for further processing.
503 * If Negate is TRUE, all components of the fetched register are negated.
505 * The fetched register components are swizzled according to SwizzleX, SwizzleY,
506 * SwizzleZ and SwizzleW.
510 struct tgsi_src_register
512 unsigned File
: 4; /* TGSI_FILE_ */
513 unsigned Indirect
: 1; /* BOOL */
514 unsigned Dimension
: 1; /* BOOL */
515 int Index
: 16; /* SINT */
516 unsigned SwizzleX
: 2; /* TGSI_SWIZZLE_ */
517 unsigned SwizzleY
: 2; /* TGSI_SWIZZLE_ */
518 unsigned SwizzleZ
: 2; /* TGSI_SWIZZLE_ */
519 unsigned SwizzleW
: 2; /* TGSI_SWIZZLE_ */
520 unsigned Absolute
: 1; /* BOOL */
521 unsigned Negate
: 1; /* BOOL */
525 * If tgsi_src_register::Modifier is TRUE, tgsi_src_register_modifier follows.
527 * Then, if tgsi_src_register::Indirect is TRUE, another tgsi_src_register
530 * Then, if tgsi_src_register::Dimension is TRUE, tgsi_dimension follows.
534 struct tgsi_dimension
536 unsigned Indirect
: 1; /* BOOL */
537 unsigned Dimension
: 1; /* BOOL */
538 unsigned Padding
: 14;
539 int Index
: 16; /* SINT */
542 struct tgsi_dst_register
544 unsigned File
: 4; /* TGSI_FILE_ */
545 unsigned WriteMask
: 4; /* TGSI_WRITEMASK_ */
546 unsigned Indirect
: 1; /* BOOL */
547 unsigned Dimension
: 1; /* BOOL */
548 int Index
: 16; /* SINT */
549 unsigned Padding
: 6;
557 #endif /* P_SHADER_TOKENS_H */