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 "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    GLuint Size;             /**< Number of components (1..4) */
  50    /**
  51     * A sequence of STATE_* tokens and integers to identify GL state.
  52     */
  53    gl_state_index StateIndexes[STATE_LENGTH];
  54 };
  55
  56
  57 /**
  58  * List of gl_program_parameter instances.
  59  */
  60 struct gl_program_parameter_list
  61 {
  62    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
  63    GLuint NumParameters;  /**< number of parameters in arrays */
  64    struct gl_program_parameter *Parameters; /**< Array [Size] */
  65    GLfloat (*ParameterValues)[4];        /**< Array [Size] of GLfloat[4] */
  66    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
  67                                might invalidate ParameterValues[] */
  68 };
  69
  70
  71 extern struct gl_program_parameter_list *
  72 _mesa_new_parameter_list(void);
  73
  74 extern void
  75 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
  76
  77 extern struct gl_program_parameter_list *
  78 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list);
  79
  80 extern GLint
  81 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
  82                     enum register_file type, const char *name,
  83                     GLuint size, const GLfloat *values,
  84                     const gl_state_index state[STATE_LENGTH]);
  85
  86 extern GLint
  87 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
  88                           const char *name, const GLfloat values[4]);
  89
  90 extern GLint
  91 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
  92                          const char *name, const GLfloat values[4],
  93                          GLuint size);
  94
  95 extern GLint
  96 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
  97                            const GLfloat values[4], GLuint size,
  98                            GLuint *swizzleOut);
  99
 100 extern GLint
 101 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
 102                   const char *name, GLuint size);
 103
 104 extern GLint
 105 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
 106                   const char *name);
 107
 108 extern GLint
 109 _mesa_add_varying(struct gl_program_parameter_list *paramList,
 110                   const char *name, GLuint size);
 111
 112 extern GLint
 113 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
 114                     const char *name, GLint size, GLint attrib);
 115
 116 extern GLint
 117 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
 118                           const gl_state_index stateTokens[STATE_LENGTH]);
 119
 120 extern GLfloat *
 121 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
 122                              GLsizei nameLen, const char *name);
 123
 124 extern GLint
 125 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
 126                              GLsizei nameLen, const char *name);
 127
 128 extern GLboolean
 129 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
 130                                 const GLfloat v[], GLuint vSize,
 131                                 GLint *posOut, GLuint *swizzleOut);
 132
 133 extern GLuint
 134 _mesa_parameter_longest_name(const struct gl_program_parameter_list *list);
 135
 136 #endif /* PROG_PARAMETER_H */