2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 * \file prog_instruction.h
29 * Vertex/fragment program instruction datatypes and constants.
32 * \author Keith Whitwell
33 * \author Ian Romanick <idr@us.ibm.com>
37 #ifndef PROG_INSTRUCTION_H
38 #define PROG_INSTRUCTION_H
50 #define SWIZZLE_ZERO 4 /**< For SWZ instruction only */
51 #define SWIZZLE_ONE 5 /**< For SWZ instruction only */
52 #define SWIZZLE_NIL 7 /**< used during shader code gen (undefined value) */
55 #define MAKE_SWIZZLE4(a,b,c,d) (((a)<<0) | ((b)<<3) | ((c)<<6) | ((d)<<9))
56 #define SWIZZLE_NOOP MAKE_SWIZZLE4(0,1,2,3)
57 #define GET_SWZ(swz, idx) (((swz) >> ((idx)*3)) & 0x7)
58 #define GET_BIT(msk, idx) (((msk) >> (idx)) & 0x1)
60 #define SWIZZLE_XYZW MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_W)
61 #define SWIZZLE_XXXX MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_X, SWIZZLE_X, SWIZZLE_X)
62 #define SWIZZLE_YYYY MAKE_SWIZZLE4(SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y)
63 #define SWIZZLE_ZZZZ MAKE_SWIZZLE4(SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z)
64 #define SWIZZLE_WWWW MAKE_SWIZZLE4(SWIZZLE_W, SWIZZLE_W, SWIZZLE_W, SWIZZLE_W)
68 * Writemask values, 1 bit per component.
71 #define WRITEMASK_X 0x1
72 #define WRITEMASK_Y 0x2
73 #define WRITEMASK_XY 0x3
74 #define WRITEMASK_Z 0x4
75 #define WRITEMASK_XZ 0x5
76 #define WRITEMASK_YZ 0x6
77 #define WRITEMASK_XYZ 0x7
78 #define WRITEMASK_W 0x8
79 #define WRITEMASK_XW 0x9
80 #define WRITEMASK_YW 0xa
81 #define WRITEMASK_XYW 0xb
82 #define WRITEMASK_ZW 0xc
83 #define WRITEMASK_XZW 0xd
84 #define WRITEMASK_YZW 0xe
85 #define WRITEMASK_XYZW 0xf
93 #define COND_GT 1 /**< greater than zero */
94 #define COND_EQ 2 /**< equal to zero */
95 #define COND_LT 3 /**< less than zero */
96 #define COND_UN 4 /**< unordered (NaN) */
97 #define COND_GE 5 /**< greater then or equal to zero */
98 #define COND_LE 6 /**< less then or equal to zero */
99 #define COND_NE 7 /**< not equal to zero */
100 #define COND_TR 8 /**< always true */
101 #define COND_FL 9 /**< always false */
106 * Instruction precision for GL_NV_fragment_program
116 * Saturation modes when storing values.
119 #define SATURATE_OFF 0
120 #define SATURATE_ZERO_ONE 1
121 #define SATURATE_PLUS_MINUS_ONE 2
126 * Per-component negation masks
133 #define NEGATE_XYZW 0xf
134 #define NEGATE_NONE 0x0
139 * Program instruction opcodes, for both vertex and fragment programs.
140 * \note changes to this opcode list must be reflected in t_vb_arbprogram.c
142 typedef enum prog_opcode
{
143 /* ARB_vp ARB_fp NV_vp NV_fp GLSL */
144 /*------------------------------------------*/
145 OPCODE_NOP
= 0, /* X */
146 OPCODE_ABS
, /* X X 1.1 X */
147 OPCODE_ADD
, /* X X X X X */
150 OPCODE_ARL
, /* X X */
151 OPCODE_ARL_NV
, /* 2 */
153 OPCODE_BGNLOOP
, /* opt */
154 OPCODE_BGNSUB
, /* opt */
155 OPCODE_BRA
, /* 2 X */
156 OPCODE_BRK
, /* 2 opt */
157 OPCODE_CAL
, /* 2 2 */
159 OPCODE_CONT
, /* opt */
160 OPCODE_COS
, /* X 2 X X */
161 OPCODE_DDX
, /* X X */
162 OPCODE_DDY
, /* X X */
165 OPCODE_DP3
, /* X X X X X */
166 OPCODE_DP4
, /* X X X X X */
167 OPCODE_DPH
, /* X X 1.1 */
168 OPCODE_DST
, /* X X X X */
170 OPCODE_END
, /* X X X X opt */
171 OPCODE_ENDIF
, /* opt */
172 OPCODE_ENDLOOP
, /* opt */
173 OPCODE_ENDSUB
, /* opt */
174 OPCODE_EX2
, /* X X 2 X X */
175 OPCODE_EXP
, /* X X X */
176 OPCODE_FLR
, /* X X 2 X X */
177 OPCODE_FRC
, /* X X 2 X X */
180 OPCODE_KIL_NV
, /* X X */
181 OPCODE_LG2
, /* X X 2 X X */
182 OPCODE_LIT
, /* X X X X */
183 OPCODE_LOG
, /* X X X */
184 OPCODE_LRP
, /* X X */
185 OPCODE_MAD
, /* X X X X X */
186 OPCODE_MAX
, /* X X X X X */
187 OPCODE_MIN
, /* X X X X X */
188 OPCODE_MOV
, /* X X X X X */
189 OPCODE_MUL
, /* X X X X X */
190 OPCODE_NOISE1
, /* X */
191 OPCODE_NOISE2
, /* X */
192 OPCODE_NOISE3
, /* X */
193 OPCODE_NOISE4
, /* X */
199 OPCODE_PK2US
, /* X */
201 OPCODE_PK4UB
, /* X */
202 OPCODE_POW
, /* X X X X */
204 OPCODE_PRINT
, /* X X */
205 OPCODE_PUSHA
, /* 3 */
206 OPCODE_RCC
, /* 1.1 */
207 OPCODE_RCP
, /* X X X X X */
208 OPCODE_RET
, /* 2 2 */
209 OPCODE_RFL
, /* X X */
210 OPCODE_RSQ
, /* X X X X X */
212 OPCODE_SEQ
, /* 2 X X */
213 OPCODE_SFL
, /* 2 X */
214 OPCODE_SGE
, /* X X X X X */
215 OPCODE_SGT
, /* 2 X X */
216 OPCODE_SIN
, /* X 2 X X */
217 OPCODE_SLE
, /* 2 X X */
218 OPCODE_SLT
, /* X X X X X */
219 OPCODE_SNE
, /* 2 X X */
221 OPCODE_STR
, /* 2 X */
222 OPCODE_SUB
, /* X X 1.1 X X */
223 OPCODE_SWZ
, /* X X */
224 OPCODE_TEX
, /* X 3 X X */
225 OPCODE_TXB
, /* X 3 X */
226 OPCODE_TXD
, /* X X */
227 OPCODE_TXL
, /* 3 2 X */
228 OPCODE_TXP
, /* X X */
229 OPCODE_TXP_NV
, /* 3 X */
230 OPCODE_TRUNC
, /* X */
232 OPCODE_UP2US
, /* X */
234 OPCODE_UP4UB
, /* X */
237 OPCODE_XPD
, /* X X X */
243 * Instruction source register.
245 struct prog_src_register
247 GLuint File
:4; /**< One of the PROGRAM_* register file values. */
248 GLint Index
:9; /**< May be negative for relative addressing. */
253 * \name Source register "sign" control.
255 * The ARB and NV extensions allow varrying degrees of control over the
256 * sign of the source vector components. These values allow enough control
257 * for all flavors of the extensions.
261 * Per-component negation for the SWZ instruction. For non-SWZ
262 * instructions the only possible values are NEGATE_XYZW and NEGATE_NONE.
265 * ARB_vertex_program, ARB_fragment_program
270 * Take the component-wise absolute value.
273 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
274 * NV_vertex_program2_option.
279 * Post-absolute value negation (all components).
287 * Instruction destination register.
289 struct prog_dst_register
291 GLuint File
:4; /**< One of the PROGRAM_* register file values */
297 * \name Conditional destination update control.
300 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
301 * NV_vertex_program2_option.
305 * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
306 * NE, TR, or UN). Dest reg is only written to if the matching
307 * (swizzled) condition code value passes. When a conditional update mask
308 * is not specified, this will be \c COND_TR.
313 * Condition code swizzle value.
315 GLuint CondSwizzle
:12;
318 * Selects the condition code register to use for conditional destination
319 * update masking. In NV_fragmnet_program or NV_vertex_program2 mode, only
320 * condition code register 0 is available. In NV_vertex_program3 mode,
321 * condition code registers 0 and 1 are available.
331 * Vertex/fragment program instruction.
333 struct prog_instruction
335 gl_inst_opcode Opcode
;
336 #if FEATURE_MESA_program_debug
340 * Arbitrary data. Used for the PRINT, CAL, and BRA instructions.
344 struct prog_src_register SrcReg
[3];
345 struct prog_dst_register DstReg
;
348 * Indicates that the instruction should update the condition code
352 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
353 * NV_vertex_program2_option.
358 * If prog_instruction::CondUpdate is \c GL_TRUE, this value selects the
359 * condition code register that is to be updated.
361 * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
362 * code register 0 is available. In GL_NV_vertex_program3 mode, condition
363 * code registers 0 and 1 are available.
366 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
367 * NV_vertex_program2_option.
372 * Saturate each value of the vectored result to the range [0,1] or the
373 * range [-1,1]. \c SSAT mode (i.e., saturation to the range [-1,1]) is
374 * only available in NV_fragment_program2 mode.
375 * Value is one of the SATURATE_* tokens.
378 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program3.
380 GLuint SaturateMode
:2;
383 * Per-instruction selectable precision.
386 * NV_fragment_program, NV_fragment_program_option.
391 * \name Texture source controls.
393 * The texture source controls are only used with the \c TEX, \c TXD,
394 * \c TXL, and \c TXP instructions.
397 * ARB_fragment_program, NV_fragment_program, NV_vertex_program3.
401 * Source texture unit. OpenGL supports a maximum of 32 texture
407 * Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX.
409 GLuint TexSrcTarget
:3;
413 * For BRA and CAL instructions, the location to jump to.
414 * For BGNLOOP, points to ENDLOOP (and vice-versa).
415 * For BRK, points to BGNLOOP (which points to ENDLOOP).
416 * For IF, points to else or endif.
417 * For ELSE, points to endif.
422 * For TEX instructions in shaders, the sampler to use for the
432 _mesa_init_instructions(struct prog_instruction
*inst
, GLuint count
);
434 extern struct prog_instruction
*
435 _mesa_alloc_instructions(GLuint numInst
);
437 extern struct prog_instruction
*
438 _mesa_realloc_instructions(struct prog_instruction
*oldInst
,
439 GLuint numOldInst
, GLuint numNewInst
);
441 extern struct prog_instruction
*
442 _mesa_copy_instructions(struct prog_instruction
*dest
,
443 const struct prog_instruction
*src
, GLuint n
);
446 _mesa_free_instructions(struct prog_instruction
*inst
, GLuint count
);
449 _mesa_num_inst_src_regs(gl_inst_opcode opcode
);
452 _mesa_num_inst_dst_regs(gl_inst_opcode opcode
);
455 _mesa_is_tex_instruction(gl_inst_opcode opcode
);
458 _mesa_opcode_string(gl_inst_opcode opcode
);
461 #endif /* PROG_INSTRUCTION_H */