src/mesa/main/uniforms.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 2010  VMware, Inc.  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 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  20  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24
  25 #ifndef UNIFORMS_H
  26 #define UNIFORMS_H
  27
  28 #include "glheader.h"
  29 #include "program/prog_parameter.h"
  30 #include "../glsl/ir_uniform.h"
  31
  32 struct gl_program;
  33 struct _glapi_table;
  34
  35 extern void GLAPIENTRY
  36 _mesa_Uniform1fARB(GLint, GLfloat);
  37
  38 extern void GLAPIENTRY
  39 _mesa_Uniform2fARB(GLint, GLfloat, GLfloat);
  40
  41 extern void GLAPIENTRY
  42 _mesa_Uniform3fARB(GLint, GLfloat, GLfloat, GLfloat);
  43
  44 extern void GLAPIENTRY
  45 _mesa_Uniform4fARB(GLint, GLfloat, GLfloat, GLfloat, GLfloat);
  46
  47 extern void GLAPIENTRY
  48 _mesa_Uniform1iARB(GLint, GLint);
  49
  50 extern void GLAPIENTRY
  51 _mesa_Uniform2iARB(GLint, GLint, GLint);
  52
  53 extern void GLAPIENTRY
  54 _mesa_Uniform3iARB(GLint, GLint, GLint, GLint);
  55
  56 extern void GLAPIENTRY
  57 _mesa_Uniform4iARB(GLint, GLint, GLint, GLint, GLint);
  58
  59 extern void GLAPIENTRY
  60 _mesa_Uniform1fvARB(GLint, GLsizei, const GLfloat *);
  61
  62 extern void GLAPIENTRY
  63 _mesa_Uniform2fvARB(GLint, GLsizei, const GLfloat *);
  64
  65 extern void GLAPIENTRY
  66 _mesa_Uniform3fvARB(GLint, GLsizei, const GLfloat *);
  67
  68 extern void GLAPIENTRY
  69 _mesa_Uniform4fvARB(GLint, GLsizei, const GLfloat *);
  70
  71 extern void GLAPIENTRY
  72 _mesa_Uniform1ivARB(GLint, GLsizei, const GLint *);
  73
  74 extern void GLAPIENTRY
  75 _mesa_Uniform2ivARB(GLint, GLsizei, const GLint *);
  76
  77 extern void GLAPIENTRY
  78 _mesa_Uniform3ivARB(GLint, GLsizei, const GLint *);
  79
  80 extern void GLAPIENTRY
  81 _mesa_Uniform4ivARB(GLint, GLsizei, const GLint *);
  82
  83 extern void GLAPIENTRY
  84 _mesa_Uniform1ui(GLint location, GLuint v0);
  85
  86 extern void GLAPIENTRY
  87 _mesa_Uniform2ui(GLint location, GLuint v0, GLuint v1);
  88
  89 extern void GLAPIENTRY
  90 _mesa_Uniform3ui(GLint location, GLuint v0, GLuint v1, GLuint v2);
  91
  92 extern void GLAPIENTRY
  93 _mesa_Uniform4ui(GLint location, GLuint v0, GLuint v1, GLuint v2, GLuint v3);
  94
  95 extern void GLAPIENTRY
  96 _mesa_Uniform1uiv(GLint location, GLsizei count, const GLuint *value);
  97
  98 extern void GLAPIENTRY
  99 _mesa_Uniform2uiv(GLint location, GLsizei count, const GLuint *value);
 100
 101 extern void GLAPIENTRY
 102 _mesa_Uniform3uiv(GLint location, GLsizei count, const GLuint *value);
 103
 104 extern void GLAPIENTRY
 105 _mesa_Uniform4uiv(GLint location, GLsizei count, const GLuint *value);
 106
 107
 108 extern void GLAPIENTRY
 109 _mesa_UniformMatrix2fvARB(GLint, GLsizei, GLboolean, const GLfloat *);
 110
 111 extern void GLAPIENTRY
 112 _mesa_UniformMatrix3fvARB(GLint, GLsizei, GLboolean, const GLfloat *);
 113
 114 extern void GLAPIENTRY
 115 _mesa_UniformMatrix4fvARB(GLint, GLsizei, GLboolean, const GLfloat *);
 116
 117 extern void GLAPIENTRY
 118 _mesa_UniformMatrix2x3fv(GLint location, GLsizei count, GLboolean transpose,
 119                          const GLfloat *value);
 120
 121 extern void GLAPIENTRY
 122 _mesa_UniformMatrix3x2fv(GLint location, GLsizei count, GLboolean transpose,
 123                          const GLfloat *value);
 124
 125 extern void GLAPIENTRY
 126 _mesa_UniformMatrix2x4fv(GLint location, GLsizei count, GLboolean transpose,
 127                          const GLfloat *value);
 128
 129 extern void GLAPIENTRY
 130 _mesa_UniformMatrix4x2fv(GLint location, GLsizei count, GLboolean transpose,
 131                          const GLfloat *value);
 132
 133 extern void GLAPIENTRY
 134 _mesa_UniformMatrix3x4fv(GLint location, GLsizei count, GLboolean transpose,
 135                          const GLfloat *value);
 136
 137 extern void GLAPIENTRY
 138 _mesa_UniformMatrix4x3fv(GLint location, GLsizei count, GLboolean transpose,
 139                          const GLfloat *value);
 140
 141
 142 extern void GLAPIENTRY
 143 _mesa_GetActiveUniformARB(GLhandleARB, GLuint, GLsizei, GLsizei *,
 144                           GLint *, GLenum *, GLcharARB *);
 145
 146 extern void GLAPIENTRY
 147 _mesa_GetUniformfvARB(GLhandleARB, GLint, GLfloat *);
 148
 149 extern void GLAPIENTRY
 150 _mesa_GetnUniformfvARB(GLhandleARB, GLint, GLsizei, GLfloat *);
 151
 152 extern void GLAPIENTRY
 153 _mesa_GetUniformivARB(GLhandleARB, GLint, GLint *);
 154
 155 extern void GLAPIENTRY
 156 _mesa_GetnUniformivARB(GLhandleARB, GLint, GLsizei, GLint *);
 157
 158 extern void GLAPIENTRY
 159 _mesa_GetUniformuiv(GLhandleARB, GLint, GLuint *);
 160
 161 extern void GLAPIENTRY
 162 _mesa_GetnUniformuivARB(GLhandleARB, GLint, GLsizei, GLuint *);
 163
 164 extern void GLAPIENTRY
 165 _mesa_GetUniformdv(GLhandleARB, GLint, GLdouble *);
 166
 167 extern void GLAPIENTRY
 168 _mesa_GetnUniformdvARB(GLhandleARB, GLint, GLsizei, GLdouble *);
 169
 170 extern GLint GLAPIENTRY
 171 _mesa_GetUniformLocationARB(GLhandleARB, const GLcharARB *);
 172
 173 GLint
 174 _mesa_get_uniform_location(struct gl_context *ctx, struct gl_shader_program *shProg,
 175                            const GLchar *name);
 176
 177 void
 178 _mesa_uniform(struct gl_context *ctx, struct gl_shader_program *shader_program,
 179               GLint location, GLsizei count,
 180               const GLvoid *values, GLenum type);
 181
 182 void
 183 _mesa_uniform_matrix(struct gl_context *ctx, struct gl_shader_program *shProg,
 184                      GLint cols, GLint rows,
 185                      GLint location, GLsizei count,
 186                      GLboolean transpose, const GLfloat *values);
 187
 188 void
 189 _mesa_get_uniform(struct gl_context *ctx, GLuint program, GLint location,
 190                   GLsizei bufSize, GLenum returnType, GLvoid *paramsOut);
 191
 192 extern void
 193 _mesa_uniform_attach_driver_storage(struct gl_uniform_storage *,
 194                                     unsigned element_stride,
 195                                     unsigned vector_stride,
 196                                     enum gl_uniform_driver_format format,
 197                                     void *data);
 198
 199 extern void
 200 _mesa_uniform_detach_all_driver_storage(struct gl_uniform_storage *uni);
 201
 202 extern void
 203 _mesa_propagate_uniforms_to_driver_storage(struct gl_uniform_storage *uni,
 204                                            unsigned array_index,
 205                                            unsigned count);
 206
 207 extern void
 208 _mesa_update_shader_textures_used(struct gl_program *prog);
 209
 210
 211 extern void
 212 _mesa_init_shader_uniform_dispatch(struct _glapi_table *exec);
 213
 214 extern const struct gl_program_parameter *
 215 get_uniform_parameter(struct gl_shader_program *shProg, GLint index);
 216
 217 struct gl_builtin_uniform_element {
 218    const char *field;
 219    int tokens[STATE_LENGTH];
 220    int swizzle;
 221 };
 222
 223 struct gl_builtin_uniform_desc {
 224    const char *name;
 225    struct gl_builtin_uniform_element *elements;
 226    unsigned int num_elements;
 227 };
 228
 229 extern const struct gl_builtin_uniform_desc _mesa_builtin_uniform_desc[];
 230
 231 /**
 232  * \name GLSL uniform arrays and structs require special handling.
 233  *
 234  * The GL_ARB_shader_objects spec says that if you use
 235  * glGetUniformLocation to get the location of an array, you CANNOT
 236  * access other elements of the array by adding an offset to the
 237  * returned location.  For example, you must call
 238  * glGetUniformLocation("foo[16]") if you want to set the 16th element
 239  * of the array with glUniform().
 240  *
 241  * HOWEVER, some other OpenGL drivers allow accessing array elements
 242  * by adding an offset to the returned array location.  And some apps
 243  * seem to depend on that behaviour.
 244  *
 245  * Mesa's gl_uniform_list doesn't directly support this since each
 246  * entry in the list describes one uniform variable, not one uniform
 247  * element.  We could insert dummy entries in the list for each array
 248  * element after [0] but that causes complications elsewhere.
 249  *
 250  * We solve this problem by encoding two values in the location that's
 251  * returned by glGetUniformLocation():
 252  *  a) index into gl_uniform_list::Uniforms[] for the uniform
 253  *  b) an array/field offset (0 for simple types)
 254  *
 255  * These two values are encoded in the high and low halves of a GLint.
 256  * By putting the uniform number in the high part and the offset in the
 257  * low part, we can support the unofficial ability to index into arrays
 258  * by adding offsets to the location value.
 259  */
 260 /*@{*/
 261 /**
 262  * Combine the uniform's base location and the offset
 263  */
 264 static inline GLint
 265 _mesa_uniform_merge_location_offset(unsigned base_location, unsigned offset)
 266 {
 267    return (base_location << 16) | offset;
 268 }
 269
 270 /**
 271  * Separate the uniform base location and parameter offset
 272  */
 273 static inline void
 274 _mesa_uniform_split_location_offset(GLint location, unsigned *base_location,
 275                                     unsigned *offset)
 276 {
 277    *offset = location & 0xffff;
 278    *base_location = location >> 16;
 279 }
 280 /*@}*/
 281
 282 #endif /* UNIFORMS_H */