src/mesa/shader/program.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 1999-2005  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 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 program *
  99 _mesa_init_vertex_program(GLcontext *ctx,
 100                           struct vertex_program *prog,
 101                           GLenum target, GLuint id);
 102
 103 extern struct program *
 104 _mesa_init_fragment_program(GLcontext *ctx,
 105                             struct fragment_program *prog,
 106                             GLenum target, GLuint id);
 107
 108 extern struct program *
 109 _mesa_new_program(GLcontext *ctx, GLenum target, GLuint id);
 110
 111 extern void
 112 _mesa_delete_program(GLcontext *ctx, struct program *prog);
 113
 114
 115
 116 /**
 117  * Used for describing GL state referenced from inside ARB vertex and
 118  * fragment programs.
 119  * A string such as "state.light[0].ambient" gets translated into a
 120  * sequence of tokens such as [ STATE_LIGHT, 0, STATE_AMBIENT ].
 121  */
 122 enum state_index {
 123    STATE_MATERIAL,
 124
 125    STATE_LIGHT,
 126    STATE_LIGHTMODEL_AMBIENT,
 127    STATE_LIGHTMODEL_SCENECOLOR,
 128    STATE_LIGHTPROD,
 129
 130    STATE_TEXGEN,
 131
 132    STATE_FOG_COLOR,
 133    STATE_FOG_PARAMS,
 134
 135    STATE_CLIPPLANE,
 136
 137    STATE_POINT_SIZE,
 138    STATE_POINT_ATTENUATION,
 139
 140    STATE_MATRIX,
 141    STATE_MODELVIEW,
 142    STATE_PROJECTION,
 143    STATE_MVP,
 144    STATE_TEXTURE,
 145    STATE_PROGRAM,
 146    STATE_MATRIX_INVERSE,
 147    STATE_MATRIX_TRANSPOSE,
 148    STATE_MATRIX_INVTRANS,
 149
 150    STATE_AMBIENT,
 151    STATE_DIFFUSE,
 152    STATE_SPECULAR,
 153    STATE_EMISSION,
 154    STATE_SHININESS,
 155    STATE_HALF,
 156
 157    STATE_POSITION,
 158    STATE_ATTENUATION,
 159    STATE_SPOT_DIRECTION,
 160
 161    STATE_TEXGEN_EYE_S,
 162    STATE_TEXGEN_EYE_T,
 163    STATE_TEXGEN_EYE_R,
 164    STATE_TEXGEN_EYE_Q,
 165    STATE_TEXGEN_OBJECT_S,
 166    STATE_TEXGEN_OBJECT_T,
 167    STATE_TEXGEN_OBJECT_R,
 168    STATE_TEXGEN_OBJECT_Q,
 169
 170    STATE_TEXENV_COLOR,
 171
 172    STATE_DEPTH_RANGE,
 173
 174    STATE_VERTEX_PROGRAM,
 175    STATE_FRAGMENT_PROGRAM,
 176
 177    STATE_ENV,
 178    STATE_LOCAL,
 179
 180    STATE_INTERNAL,              /* Mesa additions */
 181    STATE_NORMAL_SCALE,
 182    STATE_POSITION_NORMALIZED    /* normalized light position */
 183 };
 184
 185
 186
 187 /**
 188  * Named program parameters
 189  * Used for NV_fragment_program "DEFINE"d constants and "DECLARE"d parameters,
 190  * and ARB_fragment_program global state references.  For the later, Name
 191  * might be "state.light[0].diffuse", for example.
 192  */
 193 struct program_parameter
 194 {
 195    const char *Name;                   /* Null-terminated */
 196    enum register_file Type; /** PROGRAM_NAMED_PARAM, CONSTANT or STATE_VAR */
 197    enum state_index StateIndexes[6];   /* Global state reference */
 198 };
 199
 200
 201 struct program_parameter_list
 202 {
 203    GLuint Size;           /** allocated size of Parameters, ParameterValues */
 204    GLuint NumParameters;  /** number of parameters in arrays */
 205    struct program_parameter *Parameters; /** Array [Size] */
 206    GLfloat (*ParameterValues)[4];        /** Array [Size] */
 207    GLuint StateFlags;           /** _NEW_* flags indicating which
 208                                     statechanges might invalidate
 209                                     ParameterValues[]  */
 210 };
 211
 212
 213 /*
 214  * Program parameter functions
 215  */
 216
 217 extern struct program_parameter_list *
 218 _mesa_new_parameter_list(void);
 219
 220 extern void
 221 _mesa_free_parameter_list(struct program_parameter_list *paramList);
 222
 223 extern void
 224 _mesa_free_parameters(struct program_parameter_list *paramList);
 225
 226 extern GLint
 227 _mesa_add_named_parameter(struct program_parameter_list *paramList,
 228                           const char *name, const GLfloat values[4]);
 229
 230 extern GLint
 231 _mesa_add_named_constant(struct program_parameter_list *paramList,
 232                          const char *name, const GLfloat values[4]);
 233
 234 extern GLint
 235 _mesa_add_unnamed_constant(struct program_parameter_list *paramList,
 236                            const GLfloat values[4]);
 237
 238 extern GLint
 239 _mesa_add_state_reference(struct program_parameter_list *paramList,
 240                           const GLint *stateTokens);
 241
 242 extern GLfloat *
 243 _mesa_lookup_parameter_value(struct program_parameter_list *paramList,
 244                              GLsizei nameLen, const char *name);
 245
 246 extern GLint
 247 _mesa_lookup_parameter_index(struct program_parameter_list *paramList,
 248                              GLsizei nameLen, const char *name);
 249
 250 extern void
 251 _mesa_load_state_parameters(GLcontext *ctx,
 252                             struct program_parameter_list *paramList);
 253
 254
 255
 256 extern void
 257 _mesa_print_instruction(const struct prog_instruction *inst);
 258
 259 extern void
 260 _mesa_print_program(const struct program *prog);
 261
 262 extern void
 263 _mesa_print_program_parameters(GLcontext *ctx, const struct program *prog);
 264
 265
 266 /*
 267  * API functions common to ARB/NV_vertex/fragment_program
 268  */
 269
 270 extern void GLAPIENTRY
 271 _mesa_BindProgram(GLenum target, GLuint id);
 272
 273 extern void GLAPIENTRY
 274 _mesa_DeletePrograms(GLsizei n, const GLuint *ids);
 275
 276 extern void GLAPIENTRY
 277 _mesa_GenPrograms(GLsizei n, GLuint *ids);
 278
 279 extern GLboolean GLAPIENTRY
 280 _mesa_IsProgram(GLuint id);
 281
 282
 283
 284 /*
 285  * GL_MESA_program_debug
 286  */
 287
 288 extern void
 289 _mesa_ProgramCallbackMESA(GLenum target, GLprogramcallbackMESA callback,
 290                           GLvoid *data);
 291
 292 extern void
 293 _mesa_GetProgramRegisterfvMESA(GLenum target, GLsizei len,
 294                                const GLubyte *registerName, GLfloat *v);
 295
 296
 297 #endif /* PROGRAM_H */