src/mesa/program/prog_parameter.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * 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    /**
  73     * A sequence of STATE_* tokens and integers to identify GL state.
  74     */
  75    gl_state_index StateIndexes[STATE_LENGTH];
  76 };
  77
  78
  79 /**
  80  * List of gl_program_parameter instances.
  81  */
  82 struct gl_program_parameter_list
  83 {
  84    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
  85    GLuint NumParameters;  /**< number of parameters in arrays */
  86    struct gl_program_parameter *Parameters; /**< Array [Size] */
  87    gl_constant_value (*ParameterValues)[4]; /**< Array [Size] of constant[4] */
  88    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
  89                                might invalidate ParameterValues[] */
  90 };
  91
  92
  93 extern struct gl_program_parameter_list *
  94 _mesa_new_parameter_list(void);
  95
  96 extern struct gl_program_parameter_list *
  97 _mesa_new_parameter_list_sized(unsigned size);
  98
  99 extern void
 100 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
 101
 102 extern struct gl_program_parameter_list *
 103 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list);
 104
 105 extern struct gl_program_parameter_list *
 106 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *a,
 107                               const struct gl_program_parameter_list *b);
 108
 109 static inline GLuint
 110 _mesa_num_parameters(const struct gl_program_parameter_list *list)
 111 {
 112    return list ? list->NumParameters : 0;
 113 }
 114
 115 extern void
 116 _mesa_reserve_parameter_storage(struct gl_program_parameter_list *paramList,
 117                                 unsigned reserve_slots);
 118
 119 extern GLint
 120 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
 121                     gl_register_file type, const char *name,
 122                     GLuint size, GLenum datatype,
 123                     const gl_constant_value *values,
 124                     const gl_state_index state[STATE_LENGTH]);
 125
 126 extern GLint
 127 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
 128                            const gl_constant_value values[4], GLuint size,
 129                            GLenum datatype, GLuint *swizzleOut);
 130
 131 extern GLint
 132 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
 133                            const gl_constant_value values[4], GLuint size,
 134                            GLuint *swizzleOut);
 135
 136 extern GLint
 137 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 138                           const gl_state_index stateTokens[STATE_LENGTH]);
 139
 140 extern GLint
 141 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 142                              GLsizei nameLen, const char *name);
 143
 144 extern GLboolean
 145 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 146                                 const gl_constant_value v[], GLuint vSize,
 147                                 GLint *posOut, GLuint *swizzleOut);
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif /* PROG_PARAMETER_H */