gallium: Fix doxygen comments.
[mesa.git] / src / gallium / include / pipe / p_shader_tokens.h
1 /**************************************************************************
2 *
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 #ifndef TGSI_TOKEN_H
29 #define TGSI_TOKEN_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "p_compiler.h"
36
37 struct tgsi_version
38 {
39 unsigned MajorVersion : 8;
40 unsigned MinorVersion : 8;
41 unsigned Padding : 16;
42 };
43
44 struct tgsi_header
45 {
46 unsigned HeaderSize : 8;
47 unsigned BodySize : 24;
48 };
49
50 #define TGSI_PROCESSOR_FRAGMENT 0
51 #define TGSI_PROCESSOR_VERTEX 1
52 #define TGSI_PROCESSOR_GEOMETRY 2
53
54 struct tgsi_processor
55 {
56 unsigned Processor : 4; /* TGSI_PROCESSOR_ */
57 unsigned Padding : 28;
58 };
59
60 #define TGSI_TOKEN_TYPE_DECLARATION 0
61 #define TGSI_TOKEN_TYPE_IMMEDIATE 1
62 #define TGSI_TOKEN_TYPE_INSTRUCTION 2
63
64 struct tgsi_token
65 {
66 unsigned Type : 4; /* TGSI_TOKEN_TYPE_ */
67 unsigned Size : 8; /* UINT */
68 unsigned Padding : 19;
69 unsigned Extended : 1; /* BOOL */
70 };
71
72 enum tgsi_file_type {
73 TGSI_FILE_NULL =0,
74 TGSI_FILE_CONSTANT =1,
75 TGSI_FILE_INPUT =2,
76 TGSI_FILE_OUTPUT =3,
77 TGSI_FILE_TEMPORARY =4,
78 TGSI_FILE_SAMPLER =5,
79 TGSI_FILE_ADDRESS =6,
80 TGSI_FILE_IMMEDIATE =7,
81 TGSI_FILE_COUNT /**< how many TGSI_FILE_ types */
82 };
83
84
85 #define TGSI_WRITEMASK_NONE 0x00
86 #define TGSI_WRITEMASK_X 0x01
87 #define TGSI_WRITEMASK_Y 0x02
88 #define TGSI_WRITEMASK_XY 0x03
89 #define TGSI_WRITEMASK_Z 0x04
90 #define TGSI_WRITEMASK_XZ 0x05
91 #define TGSI_WRITEMASK_YZ 0x06
92 #define TGSI_WRITEMASK_XYZ 0x07
93 #define TGSI_WRITEMASK_W 0x08
94 #define TGSI_WRITEMASK_XW 0x09
95 #define TGSI_WRITEMASK_YW 0x0A
96 #define TGSI_WRITEMASK_XYW 0x0B
97 #define TGSI_WRITEMASK_ZW 0x0C
98 #define TGSI_WRITEMASK_XZW 0x0D
99 #define TGSI_WRITEMASK_YZW 0x0E
100 #define TGSI_WRITEMASK_XYZW 0x0F
101
102 #define TGSI_INTERPOLATE_CONSTANT 0
103 #define TGSI_INTERPOLATE_LINEAR 1
104 #define TGSI_INTERPOLATE_PERSPECTIVE 2
105 #define TGSI_INTERPOLATE_COUNT 3
106
107 struct tgsi_declaration
108 {
109 unsigned Type : 4; /* TGSI_TOKEN_TYPE_DECLARATION */
110 unsigned Size : 8; /* UINT */
111 unsigned File : 4; /* one of TGSI_FILE_x */
112 unsigned UsageMask : 4; /* bitmask of TGSI_WRITEMASK_x flags */
113 unsigned Interpolate : 4; /* TGSI_INTERPOLATE_ */
114 unsigned Semantic : 1; /* BOOL, any semantic info? */
115 unsigned Padding : 6;
116 unsigned Extended : 1; /* BOOL */
117 };
118
119 struct tgsi_declaration_range
120 {
121 unsigned First : 16; /* UINT */
122 unsigned Last : 16; /* UINT */
123 };
124
125 #define TGSI_SEMANTIC_POSITION 0
126 #define TGSI_SEMANTIC_COLOR 1
127 #define TGSI_SEMANTIC_BCOLOR 2 /**< back-face color */
128 #define TGSI_SEMANTIC_FOG 3
129 #define TGSI_SEMANTIC_PSIZE 4
130 #define TGSI_SEMANTIC_GENERIC 5
131 #define TGSI_SEMANTIC_NORMAL 6
132 #define TGSI_SEMANTIC_COUNT 7 /**< number of semantic values */
133
134 struct tgsi_declaration_semantic
135 {
136 unsigned SemanticName : 8; /* one of TGSI_SEMANTIC_ */
137 unsigned SemanticIndex : 16; /* UINT */
138 unsigned Padding : 8;
139 };
140
141 #define TGSI_IMM_FLOAT32 0
142
143 struct tgsi_immediate
144 {
145 unsigned Type : 4; /* TGSI_TOKEN_TYPE_IMMEDIATE */
146 unsigned Size : 8; /* UINT */
147 unsigned DataType : 4; /* TGSI_IMM_ */
148 unsigned Padding : 15;
149 unsigned Extended : 1; /* BOOL */
150 };
151
152 struct tgsi_immediate_float32
153 {
154 float Float;
155 };
156
157 /*
158 * GL_NV_vertex_program
159 */
160 #define TGSI_OPCODE_ARL 0
161 #define TGSI_OPCODE_MOV 1
162 #define TGSI_OPCODE_LIT 2
163 #define TGSI_OPCODE_RCP 3
164 #define TGSI_OPCODE_RSQ 4
165 #define TGSI_OPCODE_EXP 5
166 #define TGSI_OPCODE_LOG 6
167 #define TGSI_OPCODE_MUL 7
168 #define TGSI_OPCODE_ADD 8
169 #define TGSI_OPCODE_DP3 9
170 #define TGSI_OPCODE_DP4 10
171 #define TGSI_OPCODE_DST 11
172 #define TGSI_OPCODE_MIN 12
173 #define TGSI_OPCODE_MAX 13
174 #define TGSI_OPCODE_SLT 14
175 #define TGSI_OPCODE_SGE 15
176 #define TGSI_OPCODE_MAD 16
177
178 /*
179 * GL_ATI_fragment_shader
180 */
181 #define TGSI_OPCODE_SUB 17
182 #define TGSI_OPCODE_DOT3 TGSI_OPCODE_DP3
183 #define TGSI_OPCODE_DOT4 TGSI_OPCODE_DP4
184 #define TGSI_OPCODE_LERP 18
185 #define TGSI_OPCODE_CND 19
186 #define TGSI_OPCODE_CND0 20
187 #define TGSI_OPCODE_DOT2ADD 21
188
189 /*
190 * GL_EXT_vertex_shader
191 */
192 #define TGSI_OPCODE_INDEX 22
193 #define TGSI_OPCODE_NEGATE 23
194 #define TGSI_OPCODE_MADD TGSI_OPCODE_MAD
195 #define TGSI_OPCODE_FRAC 24
196 #define TGSI_OPCODE_SETGE TGSI_OPCODE_SGE
197 #define TGSI_OPCODE_SETLT TGSI_OPCODE_SLT
198 #define TGSI_OPCODE_CLAMP 25
199 #define TGSI_OPCODE_FLOOR 26
200 #define TGSI_OPCODE_ROUND 27
201 #define TGSI_OPCODE_EXPBASE2 28
202 #define TGSI_OPCODE_LOGBASE2 29
203 #define TGSI_OPCODE_POWER 30
204 #define TGSI_OPCODE_RECIP TGSI_OPCODE_RCP
205 #define TGSI_OPCODE_RECIPSQRT TGSI_OPCODE_RSQ
206 #define TGSI_OPCODE_CROSSPRODUCT 31
207 #define TGSI_OPCODE_MULTIPLYMATRIX 32
208
209 /*
210 * GL_NV_vertex_program1_1
211 */
212 #define TGSI_OPCODE_ABS 33
213 #define TGSI_OPCODE_RCC 34
214 #define TGSI_OPCODE_DPH 35
215
216 /*
217 * GL_NV_fragment_program
218 */
219 #define TGSI_OPCODE_COS 36
220 #define TGSI_OPCODE_DDX 37
221 #define TGSI_OPCODE_DDY 38
222 #define TGSI_OPCODE_EX2 TGSI_OPCODE_EXPBASE2
223 #define TGSI_OPCODE_FLR TGSI_OPCODE_FLOOR
224 #define TGSI_OPCODE_FRC TGSI_OPCODE_FRAC
225 #define TGSI_OPCODE_KILP 39 /* predicated kill */
226 #define TGSI_OPCODE_LG2 TGSI_OPCODE_LOGBASE2
227 #define TGSI_OPCODE_LRP TGSI_OPCODE_LERP
228 #define TGSI_OPCODE_PK2H 40
229 #define TGSI_OPCODE_PK2US 41
230 #define TGSI_OPCODE_PK4B 42
231 #define TGSI_OPCODE_PK4UB 43
232 #define TGSI_OPCODE_POW TGSI_OPCODE_POWER
233 #define TGSI_OPCODE_RFL 44
234 #define TGSI_OPCODE_SEQ 45
235 #define TGSI_OPCODE_SFL 46
236 #define TGSI_OPCODE_SGT 47
237 #define TGSI_OPCODE_SIN 48
238 #define TGSI_OPCODE_SLE 49
239 #define TGSI_OPCODE_SNE 50
240 #define TGSI_OPCODE_STR 51
241 #define TGSI_OPCODE_TEX 52
242 #define TGSI_OPCODE_TXD 53
243 #define TGSI_OPCODE_TXP 54
244 #define TGSI_OPCODE_UP2H 55
245 #define TGSI_OPCODE_UP2US 56
246 #define TGSI_OPCODE_UP4B 57
247 #define TGSI_OPCODE_UP4UB 58
248 #define TGSI_OPCODE_X2D 59
249
250 /*
251 * GL_NV_vertex_program2
252 */
253 #define TGSI_OPCODE_ARA 60
254 #define TGSI_OPCODE_ARR 61
255 #define TGSI_OPCODE_BRA 62
256 #define TGSI_OPCODE_CAL 63
257 #define TGSI_OPCODE_RET 64
258 #define TGSI_OPCODE_SSG 65
259
260 /*
261 * GL_ARB_vertex_program
262 */
263 #define TGSI_OPCODE_SWZ 118
264 #define TGSI_OPCODE_XPD TGSI_OPCODE_CROSSPRODUCT
265
266 /*
267 * GL_ARB_fragment_program
268 */
269 #define TGSI_OPCODE_CMP 66
270 #define TGSI_OPCODE_KIL 116 /* conditional kill */
271 #define TGSI_OPCODE_SCS 67
272 #define TGSI_OPCODE_TXB 68
273
274 /*
275 * GL_NV_fragment_program_option
276 */
277 /* No new opcode */
278
279 /*
280 * GL_NV_fragment_program2
281 */
282 #define TGSI_OPCODE_NRM 69
283 #define TGSI_OPCODE_DIV 70
284 #define TGSI_OPCODE_DP2 71
285 #define TGSI_OPCODE_DP2A TGSI_OPCODE_DOT2ADD
286 #define TGSI_OPCODE_TXL 72
287 #define TGSI_OPCODE_BRK 73
288 #define TGSI_OPCODE_IF 74
289 #define TGSI_OPCODE_LOOP 75
290 #define TGSI_OPCODE_REP 76
291 #define TGSI_OPCODE_ELSE 77
292 #define TGSI_OPCODE_ENDIF 78
293 #define TGSI_OPCODE_ENDLOOP 79
294 #define TGSI_OPCODE_ENDREP 80
295
296 /*
297 * GL_NV_vertex_program2_option
298 */
299
300 /*
301 * GL_NV_vertex_program3
302 */
303 #define TGSI_OPCODE_PUSHA 81
304 #define TGSI_OPCODE_POPA 82
305
306 /*
307 * GL_NV_gpu_program4
308 */
309 #define TGSI_OPCODE_CEIL 83
310 #define TGSI_OPCODE_I2F 84
311 #define TGSI_OPCODE_NOT 85
312 #define TGSI_OPCODE_TRUNC 86
313 #define TGSI_OPCODE_SHL 87
314 #define TGSI_OPCODE_SHR 88
315 #define TGSI_OPCODE_AND 89
316 #define TGSI_OPCODE_OR 90
317 #define TGSI_OPCODE_MOD 91
318 #define TGSI_OPCODE_XOR 92
319 #define TGSI_OPCODE_SAD 93
320 #define TGSI_OPCODE_TXF 94
321 #define TGSI_OPCODE_TXQ 95
322 #define TGSI_OPCODE_CONT 96
323
324 /*
325 * GL_NV_vertex_program4
326 */
327 /* Same as GL_NV_gpu_program4 */
328
329 /*
330 * GL_NV_fragment_program4
331 */
332 /* Same as GL_NV_gpu_program4 */
333
334 /*
335 * GL_NV_geometry_program4
336 */
337 /* Same as GL_NV_gpu_program4 */
338 #define TGSI_OPCODE_EMIT 97
339 #define TGSI_OPCODE_ENDPRIM 98
340
341 /*
342 * GLSL
343 */
344 #define TGSI_OPCODE_BGNLOOP2 99
345 #define TGSI_OPCODE_BGNSUB 100
346 #define TGSI_OPCODE_ENDLOOP2 101
347 #define TGSI_OPCODE_ENDSUB 102
348 #define TGSI_OPCODE_INT TGSI_OPCODE_TRUNC
349 #define TGSI_OPCODE_NOISE1 103
350 #define TGSI_OPCODE_NOISE2 104
351 #define TGSI_OPCODE_NOISE3 105
352 #define TGSI_OPCODE_NOISE4 106
353 #define TGSI_OPCODE_NOP 107
354
355 /*
356 * ps_1_1
357 */
358 #define TGSI_OPCODE_TEXKILL TGSI_OPCODE_KIL
359
360 /*
361 * ps_1_2
362 */
363 /* CMP - use TGSI_OPCODE_CND0 */
364
365 /*
366 * ps_1_3
367 */
368 /* CMP - use TGSI_OPCODE_CND0 */
369
370 /*
371 * ps_1_4
372 */
373 #define TGSI_OPCODE_TEXLD TGSI_OPCODE_TEX
374
375 /*
376 * ps_2_0
377 */
378 #define TGSI_OPCODE_M4X4 TGSI_OPCODE_MULTIPLYMATRIX
379 #define TGSI_OPCODE_M4X3 108
380 #define TGSI_OPCODE_M3X4 109
381 #define TGSI_OPCODE_M3X3 110
382 #define TGSI_OPCODE_M3X2 111
383 #define TGSI_OPCODE_CRS TGSI_OPCODE_XPD
384 #define TGSI_OPCODE_NRM4 112
385 #define TGSI_OPCODE_SINCOS TGSI_OPCODE_SCS
386 #define TGSI_OPCODE_TEXLDB TGSI_OPCODE_TXB
387 #define TGSI_OPCODE_DP2ADD TGSI_OPCODE_DP2A
388
389 /*
390 * ps_2_x
391 */
392 #define TGSI_OPCODE_CALL TGSI_OPCODE_CAL
393 #define TGSI_OPCODE_CALLNZ 113
394 #define TGSI_OPCODE_IFC 114
395 #define TGSI_OPCODE_BREAK TGSI_OPCODE_BRK
396 #define TGSI_OPCODE_BREAKC 115
397 #define TGSI_OPCODE_DSX TGSI_OPCODE_DDX
398 #define TGSI_OPCODE_DSY TGSI_OPCODE_DDY
399 #define TGSI_OPCODE_TEXLDD TGSI_OPCODE_TXD
400
401 /*
402 * vs_1_1
403 */
404 #define TGSI_OPCODE_EXPP TGSI_OPCODE_EXP
405 #define TGSI_OPCODE_LOGP TGSI_OPCODE_LG2
406
407 /*
408 * vs_2_0
409 */
410 #define TGSI_OPCODE_SGN TGSI_OPCODE_SSG
411 #define TGSI_OPCODE_MOVA TGSI_OPCODE_ARR
412 /* EXPP - use TGSI_OPCODE_EX2 */
413
414 /*
415 * vs_2_x
416 */
417
418 #define TGSI_OPCODE_END 117 /* aka HALT */
419
420 #define TGSI_OPCODE_LAST 119
421
422 #define TGSI_SAT_NONE 0 /* do not saturate */
423 #define TGSI_SAT_ZERO_ONE 1 /* clamp to [0,1] */
424 #define TGSI_SAT_MINUS_PLUS_ONE 2 /* clamp to [-1,1] */
425
426 /**
427 * Opcode is the operation code to execute. A given operation defines the
428 * semantics how the source registers (if any) are interpreted and what is
429 * written to the destination registers (if any) as a result of execution.
430 *
431 * NumDstRegs and NumSrcRegs is the number of destination and source registers,
432 * respectively. For a given operation code, those numbers are fixed and are
433 * present here only for convenience.
434 *
435 * If Extended is TRUE, it is now executed.
436 *
437 * Saturate controls how are final results in destination registers modified.
438 */
439
440 struct tgsi_instruction
441 {
442 unsigned Type : 4; /* TGSI_TOKEN_TYPE_INSTRUCTION */
443 unsigned Size : 8; /* UINT */
444 unsigned Opcode : 8; /* TGSI_OPCODE_ */
445 unsigned Saturate : 2; /* TGSI_SAT_ */
446 unsigned NumDstRegs : 2; /* UINT */
447 unsigned NumSrcRegs : 4; /* UINT */
448 unsigned Padding : 3;
449 unsigned Extended : 1; /* BOOL */
450 };
451
452 /*
453 * If tgsi_instruction::Extended is TRUE, tgsi_instruction_ext follows.
454 *
455 * Then, tgsi_instruction::NumDstRegs of tgsi_dst_register follow.
456 *
457 * Then, tgsi_instruction::NumSrcRegs of tgsi_src_register follow.
458 *
459 * tgsi_instruction::Size contains the total number of words that make the
460 * instruction, including the instruction word.
461 */
462
463 #define TGSI_INSTRUCTION_EXT_TYPE_NV 0
464 #define TGSI_INSTRUCTION_EXT_TYPE_LABEL 1
465 #define TGSI_INSTRUCTION_EXT_TYPE_TEXTURE 2
466 #define TGSI_INSTRUCTION_EXT_TYPE_PREDICATE 3
467
468 struct tgsi_instruction_ext
469 {
470 unsigned Type : 4; /* TGSI_INSTRUCTION_EXT_TYPE_ */
471 unsigned Padding : 27;
472 unsigned Extended : 1; /* BOOL */
473 };
474
475 /*
476 * If tgsi_instruction_ext::Type is TGSI_INSTRUCTION_EXT_TYPE_NV, it should
477 * be cast to tgsi_instruction_ext_nv.
478 *
479 * If tgsi_instruction_ext::Type is TGSI_INSTRUCTION_EXT_TYPE_LABEL, it
480 * should be cast to tgsi_instruction_ext_label.
481 *
482 * If tgsi_instruction_ext::Type is TGSI_INSTRUCTION_EXT_TYPE_TEXTURE, it
483 * should be cast to tgsi_instruction_ext_texture.
484 *
485 * If tgsi_instruction_ext::Type is TGSI_INSTRUCTION_EXT_TYPE_PREDICATE, it
486 * should be cast to tgsi_instruction_ext_predicate.
487 *
488 * If tgsi_instruction_ext::Extended is TRUE, another tgsi_instruction_ext
489 * follows.
490 */
491
492 #define TGSI_PRECISION_DEFAULT 0
493 #define TGSI_PRECISION_FLOAT32 1
494 #define TGSI_PRECISION_FLOAT16 2
495 #define TGSI_PRECISION_FIXED12 3
496
497 #define TGSI_CC_GT 0
498 #define TGSI_CC_EQ 1
499 #define TGSI_CC_LT 2
500 #define TGSI_CC_GE 3
501 #define TGSI_CC_LE 4
502 #define TGSI_CC_NE 5
503 #define TGSI_CC_TR 6
504 #define TGSI_CC_FL 7
505
506 #define TGSI_SWIZZLE_X 0
507 #define TGSI_SWIZZLE_Y 1
508 #define TGSI_SWIZZLE_Z 2
509 #define TGSI_SWIZZLE_W 3
510
511 /**
512 * Precision controls the precision at which the operation should be executed.
513 *
514 * CondDstUpdate enables condition code register writes. When this field is
515 * TRUE, CondDstIndex specifies the index of the condition code register to
516 * update.
517 *
518 * CondFlowEnable enables conditional execution of the operation. When this
519 * field is TRUE, CondFlowIndex specifies the index of the condition code
520 * register to test against CondMask with component swizzle controled by
521 * CondSwizzleX, CondSwizzleY, CondSwizzleZ and CondSwizzleW. If the test fails,
522 * the operation is not executed.
523 */
524
525 struct tgsi_instruction_ext_nv
526 {
527 unsigned Type : 4; /* TGSI_INSTRUCTION_EXT_TYPE_NV */
528 unsigned Precision : 4; /* TGSI_PRECISION_ */
529 unsigned CondDstIndex : 4; /* UINT */
530 unsigned CondFlowIndex : 4; /* UINT */
531 unsigned CondMask : 4; /* TGSI_CC_ */
532 unsigned CondSwizzleX : 2; /* TGSI_SWIZZLE_ */
533 unsigned CondSwizzleY : 2; /* TGSI_SWIZZLE_ */
534 unsigned CondSwizzleZ : 2; /* TGSI_SWIZZLE_ */
535 unsigned CondSwizzleW : 2; /* TGSI_SWIZZLE_ */
536 unsigned CondDstUpdate : 1; /* BOOL */
537 unsigned CondFlowEnable : 1; /* BOOL */
538 unsigned Padding : 1;
539 unsigned Extended : 1; /* BOOL */
540 };
541
542 struct tgsi_instruction_ext_label
543 {
544 unsigned Type : 4; /* TGSI_INSTRUCTION_EXT_TYPE_LABEL */
545 unsigned Label : 24; /* UINT */
546 unsigned Padding : 3;
547 unsigned Extended : 1; /* BOOL */
548 };
549
550 #define TGSI_TEXTURE_UNKNOWN 0
551 #define TGSI_TEXTURE_1D 1
552 #define TGSI_TEXTURE_2D 2
553 #define TGSI_TEXTURE_3D 3
554 #define TGSI_TEXTURE_CUBE 4
555 #define TGSI_TEXTURE_RECT 5
556 #define TGSI_TEXTURE_SHADOW1D 6
557 #define TGSI_TEXTURE_SHADOW2D 7
558 #define TGSI_TEXTURE_SHADOWRECT 8
559 #define TGSI_TEXTURE_COUNT 9
560
561 struct tgsi_instruction_ext_texture
562 {
563 unsigned Type : 4; /* TGSI_INSTRUCTION_EXT_TYPE_TEXTURE */
564 unsigned Texture : 8; /* TGSI_TEXTURE_ */
565 unsigned Padding : 19;
566 unsigned Extended : 1; /* BOOL */
567 };
568
569 struct tgsi_instruction_ext_predicate
570 {
571 unsigned Type : 4; /* TGSI_INSTRUCTION_EXT_TYPE_PREDICATE */
572 unsigned PredDstIndex : 4; /* UINT */
573 unsigned PredWriteMask : 4; /* TGSI_WRITEMASK_ */
574 unsigned Padding : 19;
575 unsigned Extended : 1; /* BOOL */
576 };
577
578 /**
579 * File specifies the register array to access.
580 *
581 * Index specifies the element number of a register in the register file.
582 *
583 * If Indirect is TRUE, Index should be offset by the X component of a source
584 * register that follows. The register can be now fetched into local storage
585 * for further processing.
586 *
587 * If Negate is TRUE, all components of the fetched register are negated.
588 *
589 * The fetched register components are swizzled according to SwizzleX, SwizzleY,
590 * SwizzleZ and SwizzleW.
591 *
592 * If Extended is TRUE, any further modifications to the source register are
593 * made to this temporary storage.
594 */
595
596 struct tgsi_src_register
597 {
598 unsigned File : 4; /* TGSI_FILE_ */
599 unsigned SwizzleX : 2; /* TGSI_SWIZZLE_ */
600 unsigned SwizzleY : 2; /* TGSI_SWIZZLE_ */
601 unsigned SwizzleZ : 2; /* TGSI_SWIZZLE_ */
602 unsigned SwizzleW : 2; /* TGSI_SWIZZLE_ */
603 unsigned Negate : 1; /* BOOL */
604 unsigned Indirect : 1; /* BOOL */
605 unsigned Dimension : 1; /* BOOL */
606 int Index : 16; /* SINT */
607 unsigned Extended : 1; /* BOOL */
608 };
609
610 /**
611 * If tgsi_src_register::Extended is TRUE, tgsi_src_register_ext follows.
612 *
613 * Then, if tgsi_src_register::Indirect is TRUE, another tgsi_src_register
614 * follows.
615 *
616 * Then, if tgsi_src_register::Dimension is TRUE, tgsi_dimension follows.
617 */
618
619 #define TGSI_SRC_REGISTER_EXT_TYPE_SWZ 0
620 #define TGSI_SRC_REGISTER_EXT_TYPE_MOD 1
621
622 struct tgsi_src_register_ext
623 {
624 unsigned Type : 4; /* TGSI_SRC_REGISTER_EXT_TYPE_ */
625 unsigned Padding : 27;
626 unsigned Extended : 1; /* BOOL */
627 };
628
629 /**
630 * If tgsi_src_register_ext::Type is TGSI_SRC_REGISTER_EXT_TYPE_SWZ,
631 * it should be cast to tgsi_src_register_ext_swz.
632 *
633 * If tgsi_src_register_ext::Type is TGSI_SRC_REGISTER_EXT_TYPE_MOD,
634 * it should be cast to tgsi_src_register_ext_mod.
635 *
636 * If tgsi_dst_register_ext::Extended is TRUE, another tgsi_dst_register_ext
637 * follows.
638 */
639
640 #define TGSI_EXTSWIZZLE_X TGSI_SWIZZLE_X
641 #define TGSI_EXTSWIZZLE_Y TGSI_SWIZZLE_Y
642 #define TGSI_EXTSWIZZLE_Z TGSI_SWIZZLE_Z
643 #define TGSI_EXTSWIZZLE_W TGSI_SWIZZLE_W
644 #define TGSI_EXTSWIZZLE_ZERO 4
645 #define TGSI_EXTSWIZZLE_ONE 5
646
647 /**
648 * ExtSwizzleX, ExtSwizzleY, ExtSwizzleZ and ExtSwizzleW swizzle the source
649 * register in an extended manner.
650 *
651 * NegateX, NegateY, NegateZ and NegateW negate individual components of the
652 * source register.
653 *
654 * NOTE: To simplify matter, if this token is present, the corresponding Swizzle
655 * and Negate fields in tgsi_src_register should be set to X,Y,Z,W
656 * and FALSE, respectively.
657 */
658
659 struct tgsi_src_register_ext_swz
660 {
661 unsigned Type : 4; /* TGSI_SRC_REGISTER_EXT_TYPE_SWZ */
662 unsigned ExtSwizzleX : 4; /* TGSI_EXTSWIZZLE_ */
663 unsigned ExtSwizzleY : 4; /* TGSI_EXTSWIZZLE_ */
664 unsigned ExtSwizzleZ : 4; /* TGSI_EXTSWIZZLE_ */
665 unsigned ExtSwizzleW : 4; /* TGSI_EXTSWIZZLE_ */
666 unsigned NegateX : 1; /* BOOL */
667 unsigned NegateY : 1; /* BOOL */
668 unsigned NegateZ : 1; /* BOOL */
669 unsigned NegateW : 1; /* BOOL */
670 unsigned Padding : 7;
671 unsigned Extended : 1; /* BOOL */
672 };
673
674 /**
675 * Extra src register modifiers
676 *
677 * If Complement is TRUE, the source register is modified by subtracting it
678 * from 1.0.
679 *
680 * If Bias is TRUE, the source register is modified by subtracting 0.5 from it.
681 *
682 * If Scale2X is TRUE, the source register is modified by multiplying it by 2.0.
683 *
684 * If Absolute is TRUE, the source register is modified by removing the sign.
685 *
686 * If Negate is TRUE, the source register is modified by negating it.
687 */
688
689 struct tgsi_src_register_ext_mod
690 {
691 unsigned Type : 4; /* TGSI_SRC_REGISTER_EXT_TYPE_MOD */
692 unsigned Complement : 1; /* BOOL */
693 unsigned Bias : 1; /* BOOL */
694 unsigned Scale2X : 1; /* BOOL */
695 unsigned Absolute : 1; /* BOOL */
696 unsigned Negate : 1; /* BOOL */
697 unsigned Padding : 22;
698 unsigned Extended : 1; /* BOOL */
699 };
700
701 struct tgsi_dimension
702 {
703 unsigned Indirect : 1; /* BOOL */
704 unsigned Dimension : 1; /* BOOL */
705 unsigned Padding : 13;
706 int Index : 16; /* SINT */
707 unsigned Extended : 1; /* BOOL */
708 };
709
710 struct tgsi_dst_register
711 {
712 unsigned File : 4; /* TGSI_FILE_ */
713 unsigned WriteMask : 4; /* TGSI_WRITEMASK_ */
714 unsigned Indirect : 1; /* BOOL */
715 unsigned Dimension : 1; /* BOOL */
716 int Index : 16; /* SINT */
717 unsigned Padding : 5;
718 unsigned Extended : 1; /* BOOL */
719 };
720
721 /*
722 * If tgsi_dst_register::Extended is TRUE, tgsi_dst_register_ext follows.
723 *
724 * Then, if tgsi_dst_register::Indirect is TRUE, tgsi_src_register follows.
725 */
726
727 #define TGSI_DST_REGISTER_EXT_TYPE_CONDCODE 0
728 #define TGSI_DST_REGISTER_EXT_TYPE_MODULATE 1
729 #define TGSI_DST_REGISTER_EXT_TYPE_PREDICATE 2
730
731 struct tgsi_dst_register_ext
732 {
733 unsigned Type : 4; /* TGSI_DST_REGISTER_EXT_TYPE_ */
734 unsigned Padding : 27;
735 unsigned Extended : 1; /* BOOL */
736 };
737
738 /**
739 * Extra destination register modifiers
740 *
741 * If tgsi_dst_register_ext::Type is TGSI_DST_REGISTER_EXT_TYPE_CONDCODE,
742 * it should be cast to tgsi_dst_register_ext_condcode.
743 *
744 * If tgsi_dst_register_ext::Type is TGSI_DST_REGISTER_EXT_TYPE_MODULATE,
745 * it should be cast to tgsi_dst_register_ext_modulate.
746 *
747 * If tgsi_dst_register_ext::Type is TGSI_DST_REGISTER_EXT_TYPE_PREDICATE,
748 * it should be cast to tgsi_dst_register_ext_predicate.
749 *
750 * If tgsi_dst_register_ext::Extended is TRUE, another tgsi_dst_register_ext
751 * follows.
752 */
753 struct tgsi_dst_register_ext_concode
754 {
755 unsigned Type : 4; /* TGSI_DST_REGISTER_EXT_TYPE_CONDCODE */
756 unsigned CondMask : 4; /* TGSI_CC_ */
757 unsigned CondSwizzleX : 2; /* TGSI_SWIZZLE_ */
758 unsigned CondSwizzleY : 2; /* TGSI_SWIZZLE_ */
759 unsigned CondSwizzleZ : 2; /* TGSI_SWIZZLE_ */
760 unsigned CondSwizzleW : 2; /* TGSI_SWIZZLE_ */
761 unsigned CondSrcIndex : 4; /* UINT */
762 unsigned Padding : 11;
763 unsigned Extended : 1; /* BOOL */
764 };
765
766 #define TGSI_MODULATE_1X 0
767 #define TGSI_MODULATE_2X 1
768 #define TGSI_MODULATE_4X 2
769 #define TGSI_MODULATE_8X 3
770 #define TGSI_MODULATE_HALF 4
771 #define TGSI_MODULATE_QUARTER 5
772 #define TGSI_MODULATE_EIGHTH 6
773 #define TGSI_MODULATE_COUNT 7
774
775 struct tgsi_dst_register_ext_modulate
776 {
777 unsigned Type : 4; /* TGSI_DST_REGISTER_EXT_TYPE_MODULATE */
778 unsigned Modulate : 4; /* TGSI_MODULATE_ */
779 unsigned Padding : 23;
780 unsigned Extended : 1; /* BOOL */
781 };
782
783 /*
784 * Currently, the following constraints apply.
785 *
786 * - PredSwizzleXYZW is either set to identity or replicate.
787 * - PredSrcIndex is 0.
788 */
789
790 struct tgsi_dst_register_ext_predicate
791 {
792 unsigned Type : 4; /* TGSI_DST_REGISTER_EXT_TYPE_PREDICATE */
793 unsigned PredSwizzleX : 2; /* TGSI_SWIZZLE_ */
794 unsigned PredSwizzleY : 2; /* TGSI_SWIZZLE_ */
795 unsigned PredSwizzleZ : 2; /* TGSI_SWIZZLE_ */
796 unsigned PredSwizzleW : 2; /* TGSI_SWIZZLE_ */
797 unsigned PredSrcIndex : 4; /* UINT */
798 unsigned Negate : 1; /* BOOL */
799 unsigned Padding : 14;
800 unsigned Extended : 1; /* BOOL */
801 };
802
803
804 #ifdef __cplusplus
805 }
806 #endif
807
808 #endif /* TGSI_TOKEN_H */
809