src/mesa/shader/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 /*@}*/
  47
  48
  49
  50 /**
  51  * Program parameter.
  52  * Used by shaders/programs for uniforms, constants, varying vars, etc.
  53  */
  54 struct gl_program_parameter
  55 {
  56    const char *Name;        /**< Null-terminated string */
  57    enum register_file Type; /**< PROGRAM_NAMED_PARAM, CONSTANT or STATE_VAR */
  58    GLenum DataType;         /**< GL_FLOAT, GL_FLOAT_VEC2, etc */
  59    GLuint Size;             /**< Number of components (1..4) */
  60    GLboolean Used;          /**< Helper flag for GLSL uniform tracking */
  61    GLboolean Initialized;   /**< Has the ParameterValue[] been set? */
  62    GLbitfield Flags;        /**< Bitmask of PROG_PARAM_*_BIT */
  63    /**
  64     * A sequence of STATE_* tokens and integers to identify GL state.
  65     */
  66    gl_state_index StateIndexes[STATE_LENGTH];
  67 };
  68
  69
  70 /**
  71  * List of gl_program_parameter instances.
  72  */
  73 struct gl_program_parameter_list
  74 {
  75    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
  76    GLuint NumParameters;  /**< number of parameters in arrays */
  77    struct gl_program_parameter *Parameters; /**< Array [Size] */
  78    GLfloat (*ParameterValues)[4];        /**< Array [Size] of GLfloat[4] */
  79    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
  80                                might invalidate ParameterValues[] */
  81 };
  82
  83
  84 extern struct gl_program_parameter_list *
  85 _mesa_new_parameter_list(void);
  86
  87 extern void
  88 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
  89
  90 extern struct gl_program_parameter_list *
  91 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list);
  92
  93 extern struct gl_program_parameter_list *
  94 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *a,
  95                               const struct gl_program_parameter_list *b);
  96
  97 static INLINE GLuint
  98 _mesa_num_parameters(const struct gl_program_parameter_list *list)
  99 {
 100    return list ? list->NumParameters : 0;
 101 }
 102
 103 extern GLint
 104 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
 105                     enum register_file type, const char *name,
 106                     GLuint size, GLenum datatype, const GLfloat *values,
 107                     const gl_state_index state[STATE_LENGTH],
 108                     GLbitfield flags);
 109
 110 extern GLint
 111 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
 112                           const char *name, const GLfloat values[4]);
 113
 114 extern GLint
 115 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
 116                          const char *name, const GLfloat values[4],
 117                          GLuint size);
 118
 119 extern GLint
 120 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 121                            const GLfloat values[4], GLuint size,
 122                            GLuint *swizzleOut);
 123
 124 extern GLint
 125 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
 126                   const char *name, GLuint size, GLenum datatype,
 127                   const GLfloat *values);
 128
 129 extern void
 130 _mesa_use_uniform(struct gl_program_parameter_list *paramList,
 131                   const char *name);
 132
 133 extern GLint
 134 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
 135                   const char *name, GLenum datatype);
 136
 137 extern GLint
 138 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 139                   const char *name, GLuint size, GLbitfield flags);
 140
 141 extern GLint
 142 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 143                     const char *name, GLint size, GLenum datatype, GLint attrib);
 144
 145 extern GLint
 146 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 147                           const gl_state_index stateTokens[STATE_LENGTH]);
 148
 149 extern GLfloat *
 150 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 151                              GLsizei nameLen, const char *name);
 152
 153 extern GLint
 154 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 155                              GLsizei nameLen, const char *name);
 156
 157 extern GLboolean
 158 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 159                                 const GLfloat v[], GLuint vSize,
 160                                 GLint *posOut, GLuint *swizzleOut);
 161
 162 extern GLuint
 163 _mesa_longest_parameter_name(const struct gl_program_parameter_list *list,
 164                              enum register_file type);
 165
 166 extern GLuint
 167 _mesa_num_parameters_of_type(const struct gl_program_parameter_list *list,
 168                              enum register_file type);
 169
 170
 171 #endif /* PROG_PARAMETER_H */