src/mesa/shader/program.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.2
   4  *
   5  * Copyright (C) 1999-2006  Brian Paul   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  * 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.
  23  */
  24
  25 /**
  26  * \file program.c
  27  * Vertex and fragment program support functions.
  28  * \author Brian Paul
  29  */
  30
  31
  32 /**
  33  * \mainpage Mesa vertex and fragment program module
  34  *
  35  * This module or directory contains most of the code for vertex and
  36  * fragment programs and shaders, including state management, parsers,
  37  * and (some) software routines for executing programs
  38  */
  39
  40 #ifndef PROGRAM_H
  41 #define PROGRAM_H
  42
  43 #include "mtypes.h"
  44
  45
  46 /* for GL_ARB_v_p and GL_ARB_f_p SWZ instruction */
  47 #define SWIZZLE_X    0
  48 #define SWIZZLE_Y    1
  49 #define SWIZZLE_Z    2
  50 #define SWIZZLE_W    3
  51 #define SWIZZLE_ZERO 4          /* keep these values together: KW */
  52 #define SWIZZLE_ONE  5          /* keep these values together: KW */
  53
  54 #define MAKE_SWIZZLE4(a,b,c,d) (((a)<<0) | ((b)<<3) | ((c)<<6) | ((d)<<9))
  55 #define SWIZZLE_NOOP           MAKE_SWIZZLE4(0,1,2,3)
  56 #define GET_SWZ(swz, idx)      (((swz) >> ((idx)*3)) & 0x7)
  57 #define GET_BIT(msk, idx)      (((msk) >> (idx)) & 0x1)
  58
  59
  60 #define WRITEMASK_X     0x1
  61 #define WRITEMASK_Y     0x2
  62 #define WRITEMASK_XY    0x3
  63 #define WRITEMASK_Z     0x4
  64 #define WRITEMASK_XZ    0x5
  65 #define WRITEMASK_YZ    0x6
  66 #define WRITEMASK_XYZ   0x7
  67 #define WRITEMASK_W     0x8
  68 #define WRITEMASK_XW    0x9
  69 #define WRITEMASK_YW    0xa
  70 #define WRITEMASK_XYW   0xb
  71 #define WRITEMASK_ZW    0xc
  72 #define WRITEMASK_XZW   0xd
  73 #define WRITEMASK_YZW   0xe
  74 #define WRITEMASK_XYZW  0xf
  75
  76
  77 extern struct gl_program _mesa_DummyProgram;
  78
  79
  80 /*
  81  * Internal functions
  82  */
  83
  84 extern void
  85 _mesa_init_program(GLcontext *ctx);
  86
  87 extern void
  88 _mesa_free_program_data(GLcontext *ctx);
  89
  90 extern void
  91 _mesa_set_program_error(GLcontext *ctx, GLint pos, const char *string);
  92
  93 extern const GLubyte *
  94 _mesa_find_line_column(const GLubyte *string, const GLubyte *pos,
  95                        GLint *line, GLint *col);
  96
  97
  98 extern struct gl_program *
  99 _mesa_init_vertex_program(GLcontext *ctx,
 100                           struct gl_vertex_program *prog,
 101                           GLenum target, GLuint id);
 102
 103 extern struct gl_program *
 104 _mesa_init_fragment_program(GLcontext *ctx,
 105                             struct gl_fragment_program *prog,
 106                             GLenum target, GLuint id);
 107
 108 extern struct gl_program *
 109 _mesa_new_program(GLcontext *ctx, GLenum target, GLuint id);
 110
 111 extern void
 112 _mesa_delete_program(GLcontext *ctx, struct gl_program *prog);
 113
 114 extern struct gl_program *
 115 _mesa_lookup_program(GLcontext *ctx, GLuint id);
 116
 117 extern struct prog_instruction *
 118 _mesa_alloc_instructions(GLuint numInst);
 119
 120 extern struct prog_instruction *
 121 _mesa_realloc_instructions(struct prog_instruction *oldInst,
 122                            GLuint numOldInst, GLuint numNewInst);
 123
 124
 125 /**
 126  * Used for describing GL state referenced from inside ARB vertex and
 127  * fragment programs.
 128  * A string such as "state.light[0].ambient" gets translated into a
 129  * sequence of tokens such as [ STATE_LIGHT, 0, STATE_AMBIENT ].
 130  */
 131 enum state_index {
 132    STATE_MATERIAL,
 133
 134    STATE_LIGHT,
 135    STATE_LIGHTMODEL_AMBIENT,
 136    STATE_LIGHTMODEL_SCENECOLOR,
 137    STATE_LIGHTPROD,
 138
 139    STATE_TEXGEN,
 140
 141    STATE_FOG_COLOR,
 142    STATE_FOG_PARAMS,
 143
 144    STATE_CLIPPLANE,
 145
 146    STATE_POINT_SIZE,
 147    STATE_POINT_ATTENUATION,
 148
 149    STATE_MATRIX,
 150    STATE_MODELVIEW,
 151    STATE_PROJECTION,
 152    STATE_MVP,
 153    STATE_TEXTURE,
 154    STATE_PROGRAM,
 155    STATE_MATRIX_INVERSE,
 156    STATE_MATRIX_TRANSPOSE,
 157    STATE_MATRIX_INVTRANS,
 158
 159    STATE_AMBIENT,
 160    STATE_DIFFUSE,
 161    STATE_SPECULAR,
 162    STATE_EMISSION,
 163    STATE_SHININESS,
 164    STATE_HALF,
 165
 166    STATE_POSITION,
 167    STATE_ATTENUATION,
 168    STATE_SPOT_DIRECTION,
 169
 170    STATE_TEXGEN_EYE_S,
 171    STATE_TEXGEN_EYE_T,
 172    STATE_TEXGEN_EYE_R,
 173    STATE_TEXGEN_EYE_Q,
 174    STATE_TEXGEN_OBJECT_S,
 175    STATE_TEXGEN_OBJECT_T,
 176    STATE_TEXGEN_OBJECT_R,
 177    STATE_TEXGEN_OBJECT_Q,
 178
 179    STATE_TEXENV_COLOR,
 180
 181    STATE_DEPTH_RANGE,
 182
 183    STATE_VERTEX_PROGRAM,
 184    STATE_FRAGMENT_PROGRAM,
 185
 186    STATE_ENV,
 187    STATE_LOCAL,
 188
 189    STATE_INTERNAL,              /* Mesa additions */
 190    STATE_NORMAL_SCALE,
 191    STATE_TEXRECT_SCALE,
 192    STATE_POSITION_NORMALIZED,   /* normalized light position */
 193    STATE_INTERNAL_DRIVER        /* first available state index for drivers (must be last) */
 194 };
 195
 196
 197
 198 /**
 199  * Named program parameters
 200  * Used for NV_fragment_program "DEFINE"d constants and "DECLARE"d parameters,
 201  * and ARB_fragment_program global state references.  For the later, Name
 202  * might be "state.light[0].diffuse", for example.
 203  */
 204 struct gl_program_parameter
 205 {
 206    const char *Name;          /**< Null-terminated string */
 207    enum register_file Type; /**< PROGRAM_NAMED_PARAM, CONSTANT or STATE_VAR */
 208    enum state_index StateIndexes[6];   /**< Global state reference */
 209 };
 210
 211
 212 /**
 213  * A list of the above program_parameter instances.
 214  */
 215 struct gl_program_parameter_list
 216 {
 217    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
 218    GLuint NumParameters;  /**< number of parameters in arrays */
 219    struct gl_program_parameter *Parameters; /**< Array [Size] */
 220    GLfloat (*ParameterValues)[4];        /**< Array [Size] of GLfloat[4] */
 221    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
 222                                might invalidate ParameterValues[] */
 223 };
 224
 225
 226 /*
 227  * Program parameter functions
 228  */
 229
 230 extern struct gl_program_parameter_list *
 231 _mesa_new_parameter_list(void);
 232
 233 extern void
 234 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
 235
 236 extern GLint
 237 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 238                           const char *name, const GLfloat values[4]);
 239
 240 extern GLint
 241 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 242                          const char *name, const GLfloat values[4],
 243                          GLuint size);
 244
 245 extern GLint
 246 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 247                            const GLfloat values[4], GLuint size);
 248
 249 extern GLint
 250 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 251                           const GLint *stateTokens);
 252
 253 extern GLfloat *
 254 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 255                              GLsizei nameLen, const char *name);
 256
 257 extern GLint
 258 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 259                              GLsizei nameLen, const char *name);
 260
 261 extern GLboolean
 262 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *paramList,
 263                                 const GLfloat v[], GLsizei vSize,
 264                                 GLuint *posOut, GLuint *swizzleOut);
 265
 266 extern void
 267 _mesa_load_state_parameters(GLcontext *ctx,
 268                             struct gl_program_parameter_list *paramList);
 269
 270 extern void
 271 _mesa_print_instruction(const struct prog_instruction *inst);
 272
 273 void
 274 _mesa_print_alu_instruction(const struct prog_instruction *inst,
 275                             const char *opcode_string,
 276                             GLuint numRegs);
 277
 278 extern void
 279 _mesa_print_program(const struct gl_program *prog);
 280
 281 extern void
 282 _mesa_print_program_parameters(GLcontext *ctx, const struct gl_program *prog);
 283
 284
 285 /*
 286  * API functions common to ARB/NV_vertex/fragment_program
 287  */
 288
 289 extern void GLAPIENTRY
 290 _mesa_BindProgram(GLenum target, GLuint id);
 291
 292 extern void GLAPIENTRY
 293 _mesa_DeletePrograms(GLsizei n, const GLuint *ids);
 294
 295 extern void GLAPIENTRY
 296 _mesa_GenPrograms(GLsizei n, GLuint *ids);
 297
 298
 299
 300 /*
 301  * GL_MESA_program_debug
 302  */
 303
 304 extern void
 305 _mesa_ProgramCallbackMESA(GLenum target, GLprogramcallbackMESA callback,
 306                           GLvoid *data);
 307
 308 extern void
 309 _mesa_GetProgramRegisterfvMESA(GLenum target, GLsizei len,
 310                                const GLubyte *registerName, GLfloat *v);
 311
 312
 313 #endif /* PROGRAM_H */