src/mesa/main/program.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  5.1
   4  *
   5  * Copyright (C) 1999-2003  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 #ifndef PROGRAM_H
  33 #define PROGRAM_H
  34
  35 #include "mtypes.h"
  36
  37
  38 /* for GL_ARB_v_p and GL_ARB_f_p SWZ instruction */
  39 #define SWIZZLE_ZERO 100
  40 #define SWIZZLE_ONE  101
  41
  42
  43 /*
  44  * Internal functions
  45  */
  46
  47 extern void
  48 _mesa_init_program(GLcontext *ctx);
  49
  50 extern void
  51 _mesa_set_program_error(GLcontext *ctx, GLint pos, const char *string);
  52
  53 extern const GLubyte *
  54 _mesa_find_line_column(const GLubyte *string, const GLubyte *pos,
  55                        GLint *line, GLint *col);
  56
  57 extern struct program *
  58 _mesa_alloc_program(GLcontext *ctx, GLenum target, GLuint id);
  59
  60 extern void
  61 _mesa_delete_program(GLcontext *ctx, struct program *prog);
  62
  63
  64
  65 /*
  66  * Used for describing GL state referenced from inside ARB vertex and
  67  * fragment programs.
  68  * A string such as "state.light[0].ambient" gets translated into a
  69  * sequence of tokens such as [ STATE_LIGHT, 0, STATE_AMBIENT ].
  70  */
  71 enum state_index {
  72    STATE_MATERIAL,
  73
  74    STATE_LIGHT,
  75    STATE_LIGHTMODEL_AMBIENT,
  76    STATE_LIGHTMODEL_SCENECOLOR,
  77    STATE_LIGHTPROD,
  78
  79    STATE_TEXGEN,
  80
  81    STATE_FOG_COLOR,
  82    STATE_FOG_PARAMS,
  83
  84    STATE_CLIPPLANE,
  85
  86    STATE_POINT_SIZE,
  87    STATE_POINT_ATTENUATION,
  88
  89    STATE_MATRIX,
  90    STATE_MODELVIEW,
  91    STATE_PROJECTION,
  92    STATE_MVP,
  93    STATE_TEXTURE,
  94    STATE_PROGRAM,
  95    STATE_MATRIX_INVERSE,
  96    STATE_MATRIX_TRANSPOSE,
  97    STATE_MATRIX_INVTRANS,
  98
  99    STATE_AMBIENT,
 100    STATE_DIFFUSE,
 101    STATE_SPECULAR,
 102    STATE_EMISSION,
 103    STATE_SHININESS,
 104
 105    STATE_POSITION,
 106    STATE_ATTENUATION,
 107    STATE_SPOT_DIRECTION,
 108
 109    STATE_TEXGEN_EYE_S,
 110    STATE_TEXGEN_EYE_T,
 111    STATE_TEXGEN_EYE_R,
 112    STATE_TEXGEN_EYE_Q,
 113    STATE_TEXGEN_OBJECT_S,
 114    STATE_TEXGEN_OBJECT_T,
 115    STATE_TEXGEN_OBJECT_R,
 116    STATE_TEXGEN_OBJECT_Q
 117 };
 118
 119
 120
 121 /*
 122  * Named program parameters
 123  * Used for NV_fragment_program "DEFINE"d constants and "DECLARE"d parameters,
 124  * and ARB_fragment_program global state references.  For the later, Name
 125  * might be "state.light[0].diffuse", for example.
 126  */
 127
 128 enum parameter_type
 129 {
 130    NAMED_PARAMETER,
 131    CONSTANT,
 132    STATE
 133 };
 134
 135
 136 struct program_parameter
 137 {
 138    const char *Name;                   /* Null-terminated */
 139    enum parameter_type Type;
 140    enum state_index StateIndexes[5];   /* Global state reference */
 141    GLfloat Values[4];
 142 };
 143
 144
 145 struct program_parameter_list
 146 {
 147    GLuint NumParameters;
 148    struct program_parameter *Parameters;
 149 };
 150
 151
 152 /*
 153  * Program parameter functions
 154  */
 155
 156 extern struct program_parameter_list *
 157 _mesa_new_parameter_list(void);
 158
 159 extern void
 160 _mesa_free_parameter_list(struct program_parameter_list *paramList);
 161
 162 extern void
 163 _mesa_free_parameters(struct program_parameter_list *paramList);
 164
 165 extern GLint
 166 _mesa_add_named_parameter(struct program_parameter_list *paramList,
 167                           const char *name, const GLfloat values[4]);
 168
 169 extern GLint
 170 _mesa_add_named_constant(struct program_parameter_list *paramList,
 171                          const char *name, const GLfloat values[4]);
 172
 173 extern GLint
 174 _mesa_add_unnamed_constant(struct program_parameter_list *paramList,
 175                            const GLfloat values[4]);
 176
 177 extern GLint
 178 _mesa_add_state_reference(struct program_parameter_list *paramList,
 179                           const char *stateString);
 180
 181 extern GLfloat *
 182 _mesa_lookup_parameter_value(struct program_parameter_list *paramList,
 183                              GLsizei nameLen, const char *name);
 184
 185 extern GLint
 186 _mesa_lookup_parameter_index(struct program_parameter_list *paramList,
 187                              GLsizei nameLen, const char *name);
 188
 189 extern void
 190 _mesa_load_state_parameters(GLcontext *ctx,
 191                             struct program_parameter_list *paramList);
 192
 193
 194 /*
 195  * API functions
 196  */
 197
 198 extern void
 199 _mesa_BindProgram(GLenum target, GLuint id);
 200
 201 extern void
 202 _mesa_DeletePrograms(GLsizei n, const GLuint *ids);
 203
 204 extern void
 205 _mesa_GenPrograms(GLsizei n, GLuint *ids);
 206
 207 extern GLboolean
 208 _mesa_IsProgram(GLuint id);
 209
 210
 211 #endif /* PROGRAM_H */