src/mesa/shader/prog_parameter.h

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