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
  51 /**
  52  * Program parameter.
  53  * Used by shaders/programs for uniforms, constants, varying vars, etc.
  54  */
  55 struct gl_program_parameter
  56 {
  57    const char *Name;        /**< Null-terminated string */
  58    gl_register_file Type;   /**< PROGRAM_NAMED_PARAM, CONSTANT or STATE_VAR */
  59    GLenum DataType;         /**< GL_FLOAT, GL_FLOAT_VEC2, etc */
  60    /**
  61     * Number of components (1..4), or more.
  62     * If the number of components is greater than 4,
  63     * this parameter is part of a larger uniform like a GLSL matrix or array.
  64     * The next program parameter's Size will be Size-4 of this parameter.
  65     */
  66    GLuint Size;
  67    GLboolean Used;          /**< Helper flag for GLSL uniform tracking */
  68    GLboolean Initialized;   /**< Has the ParameterValue[] been set? */
  69    GLbitfield Flags;        /**< Bitmask of PROG_PARAM_*_BIT */
  70    /**
  71     * A sequence of STATE_* tokens and integers to identify GL state.
  72     */
  73    gl_state_index StateIndexes[STATE_LENGTH];
  74 };
  75
  76
  77 /**
  78  * List of gl_program_parameter instances.
  79  */
  80 struct gl_program_parameter_list
  81 {
  82    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
  83    GLuint NumParameters;  /**< number of parameters in arrays */
  84    struct gl_program_parameter *Parameters; /**< Array [Size] */
  85    GLfloat (*ParameterValues)[4];        /**< Array [Size] of GLfloat[4] */
  86    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
  87                                might invalidate ParameterValues[] */
  88 };
  89
  90
  91 extern struct gl_program_parameter_list *
  92 _mesa_new_parameter_list(void);
  93
  94 extern struct gl_program_parameter_list *
  95 _mesa_new_parameter_list_sized(unsigned size);
  96
  97 extern void
  98 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
  99
 100 extern struct gl_program_parameter_list *
 101 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list);
 102
 103 extern struct gl_program_parameter_list *
 104 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *a,
 105                               const struct gl_program_parameter_list *b);
 106
 107 static INLINE GLuint
 108 _mesa_num_parameters(const struct gl_program_parameter_list *list)
 109 {
 110    return list ? list->NumParameters : 0;
 111 }
 112
 113 extern GLint
 114 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
 115                     gl_register_file type, const char *name,
 116                     GLuint size, GLenum datatype, const GLfloat *values,
 117                     const gl_state_index state[STATE_LENGTH],
 118                     GLbitfield flags);
 119
 120 extern GLint
 121 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 122                           const char *name, const GLfloat values[4]);
 123
 124 extern GLint
 125 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 126                          const char *name, const GLfloat values[4],
 127                          GLuint size);
 128
 129 extern GLint
 130 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 131                            const GLfloat values[4], GLuint size,
 132                            GLuint *swizzleOut);
 133
 134 extern GLint
 135 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
 136                   const char *name, GLuint size, GLenum datatype,
 137                   const GLfloat *values);
 138
 139 extern void
 140 _mesa_use_uniform(struct gl_program_parameter_list *paramList,
 141                   const char *name);
 142
 143 extern GLint
 144 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
 145                   const char *name, GLenum datatype, int array_length);
 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 GLfloat *
 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 GLfloat 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 */