src/mesa/program/prog_parameter.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.3
   4  *
   5  * Copyright (C) 1999-2008  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 prog_parameter.c
  27  * Program parameter lists and functions.
  28  * \author Brian Paul
  29  */
  30
  31 #ifndef PROG_PARAMETER_H
  32 #define PROG_PARAMETER_H
  33
  34 #include "main/mtypes.h"
  35 #include "prog_statevars.h"
  36
  37
  38 /**
  39  * Program parameter flags
  40  */
  41 /*@{*/
  42 #define PROG_PARAM_BIT_CENTROID   0x1  /**< for varying vars (GLSL 1.20) */
  43 #define PROG_PARAM_BIT_INVARIANT  0x2  /**< for varying vars (GLSL 1.20) */
  44 #define PROG_PARAM_BIT_FLAT       0x4  /**< for varying vars (GLSL 1.30) */
  45 #define PROG_PARAM_BIT_LINEAR     0x8  /**< for varying vars (GLSL 1.30) */
  46 #define PROG_PARAM_BIT_CYL_WRAP  0x10  /**< XXX gallium debug */
  47 /*@}*/
  48
  49 /**
  50  * Actual data for constant values of parameters.
  51  */
  52 typedef union gl_constant_value {
  53         GLfloat f;
  54         GLboolean b;
  55         GLint i;
  56         GLuint u;
  57 } gl_constant_value;
  58
  59 /**
  60  * Program parameter.
  61  * Used by shaders/programs for uniforms, constants, varying vars, etc.
  62  */
  63 struct gl_program_parameter
  64 {
  65    const char *Name;        /**< Null-terminated string */
  66    gl_register_file Type;   /**< PROGRAM_NAMED_PARAM, CONSTANT or STATE_VAR */
  67    GLenum DataType;         /**< GL_FLOAT, GL_FLOAT_VEC2, etc */
  68    /**
  69     * Number of components (1..4), or more.
  70     * If the number of components is greater than 4,
  71     * this parameter is part of a larger uniform like a GLSL matrix or array.
  72     * The next program parameter's Size will be Size-4 of this parameter.
  73     */
  74    GLuint Size;
  75    GLboolean Initialized;   /**< debug: Has the ParameterValue[] been set? */
  76    GLbitfield Flags;        /**< Bitmask of PROG_PARAM_*_BIT */
  77    /**
  78     * A sequence of STATE_* tokens and integers to identify GL state.
  79     */
  80    gl_state_index StateIndexes[STATE_LENGTH];
  81 };
  82
  83
  84 /**
  85  * List of gl_program_parameter instances.
  86  */
  87 struct gl_program_parameter_list
  88 {
  89    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
  90    GLuint NumParameters;  /**< number of parameters in arrays */
  91    struct gl_program_parameter *Parameters; /**< Array [Size] */
  92    gl_constant_value (*ParameterValues)[4]; /**< Array [Size] of constant[4] */
  93    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
  94                                might invalidate ParameterValues[] */
  95 };
  96
  97
  98 extern struct gl_program_parameter_list *
  99 _mesa_new_parameter_list(void);
 100
 101 extern struct gl_program_parameter_list *
 102 _mesa_new_parameter_list_sized(unsigned size);
 103
 104 extern void
 105 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
 106
 107 extern struct gl_program_parameter_list *
 108 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list);
 109
 110 extern struct gl_program_parameter_list *
 111 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *a,
 112                               const struct gl_program_parameter_list *b);
 113
 114 static INLINE GLuint
 115 _mesa_num_parameters(const struct gl_program_parameter_list *list)
 116 {
 117    return list ? list->NumParameters : 0;
 118 }
 119
 120 extern GLint
 121 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
 122                     gl_register_file type, const char *name,
 123                     GLuint size, GLenum datatype,
 124                     const gl_constant_value *values,
 125                     const gl_state_index state[STATE_LENGTH],
 126                     GLbitfield flags);
 127
 128 extern GLint
 129 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 130                           const char *name, const gl_constant_value values[4]);
 131
 132 extern GLint
 133 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 134                          const char *name, const gl_constant_value values[4],
 135                          GLuint size);
 136
 137 extern GLint
 138 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
 139                            const gl_constant_value values[4], GLuint size,
 140                            GLenum datatype, GLuint *swizzleOut);
 141
 142 extern GLint
 143 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 144                            const gl_constant_value values[4], GLuint size,
 145                            GLuint *swizzleOut);
 146
 147 extern GLint
 148 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 149                   const char *name, GLuint size, GLenum datatype,
 150                   GLbitfield flags);
 151
 152 extern GLint
 153 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 154                     const char *name, GLint size, GLenum datatype, GLint attrib);
 155
 156 extern GLint
 157 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 158                           const gl_state_index stateTokens[STATE_LENGTH]);
 159
 160 extern gl_constant_value *
 161 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 162                              GLsizei nameLen, const char *name);
 163
 164 extern GLint
 165 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 166                              GLsizei nameLen, const char *name);
 167
 168 extern GLboolean
 169 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 170                                 const gl_constant_value v[], GLuint vSize,
 171                                 GLint *posOut, GLuint *swizzleOut);
 172
 173 extern GLuint
 174 _mesa_longest_parameter_name(const struct gl_program_parameter_list *list,
 175                              gl_register_file type);
 176
 177 extern GLuint
 178 _mesa_num_parameters_of_type(const struct gl_program_parameter_list *list,
 179                              gl_register_file type);
 180
 181
 182 #endif /* PROG_PARAMETER_H */