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