src/mesa/program/program.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2007  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 program.c
  27  * Vertex and fragment program support functions.
  28  * \author Brian Paul
  29  */
  30
  31
  32 /**
  33  * \mainpage Mesa vertex and fragment program module
  34  *
  35  * This module or directory contains most of the code for vertex and
  36  * fragment programs and shaders, including state management, parsers,
  37  * and (some) software routines for executing programs
  38  */
  39
  40 #ifndef PROGRAM_H
  41 #define PROGRAM_H
  42
  43 #include "main/compiler.h"
  44 #include "main/mtypes.h"
  45
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 extern struct gl_program _mesa_DummyProgram;
  52
  53
  54 extern void
  55 _mesa_init_program(struct gl_context *ctx);
  56
  57 extern void
  58 _mesa_free_program_data(struct gl_context *ctx);
  59
  60 extern void
  61 _mesa_update_default_objects_program(struct gl_context *ctx);
  62
  63 extern void
  64 _mesa_set_program_error(struct gl_context *ctx, GLint pos, const char *string);
  65
  66 extern struct gl_program *
  67 _mesa_init_gl_program(struct gl_program *prog, GLenum target, GLuint id);
  68
  69 extern struct gl_program *
  70 _mesa_new_program(struct gl_context *ctx, GLenum target, GLuint id);
  71
  72 extern void
  73 _mesa_delete_program(struct gl_context *ctx, struct gl_program *prog);
  74
  75 extern struct gl_program *
  76 _mesa_lookup_program(struct gl_context *ctx, GLuint id);
  77
  78 extern void
  79 _mesa_reference_program_(struct gl_context *ctx,
  80                          struct gl_program **ptr,
  81                          struct gl_program *prog);
  82
  83 static inline void
  84 _mesa_reference_program(struct gl_context *ctx,
  85                         struct gl_program **ptr,
  86                         struct gl_program *prog)
  87 {
  88    if (*ptr != prog)
  89       _mesa_reference_program_(ctx, ptr, prog);
  90 }
  91
  92 static inline void
  93 _mesa_reference_vertprog(struct gl_context *ctx,
  94                          struct gl_vertex_program **ptr,
  95                          struct gl_vertex_program *prog)
  96 {
  97    _mesa_reference_program(ctx, (struct gl_program **) ptr,
  98                            (struct gl_program *) prog);
  99 }
 100
 101 static inline void
 102 _mesa_reference_fragprog(struct gl_context *ctx,
 103                          struct gl_fragment_program **ptr,
 104                          struct gl_fragment_program *prog)
 105 {
 106    _mesa_reference_program(ctx, (struct gl_program **) ptr,
 107                            (struct gl_program *) prog);
 108 }
 109
 110 static inline void
 111 _mesa_reference_geomprog(struct gl_context *ctx,
 112                          struct gl_geometry_program **ptr,
 113                          struct gl_geometry_program *prog)
 114 {
 115    _mesa_reference_program(ctx, (struct gl_program **) ptr,
 116                            (struct gl_program *) prog);
 117 }
 118
 119 static inline void
 120 _mesa_reference_compprog(struct gl_context *ctx,
 121                          struct gl_compute_program **ptr,
 122                          struct gl_compute_program *prog)
 123 {
 124    _mesa_reference_program(ctx, (struct gl_program **) ptr,
 125                            (struct gl_program *) prog);
 126 }
 127
 128
 129 static inline void
 130 _mesa_reference_tesscprog(struct gl_context *ctx,
 131                          struct gl_tess_ctrl_program **ptr,
 132                          struct gl_tess_ctrl_program *prog)
 133 {
 134    _mesa_reference_program(ctx, (struct gl_program **) ptr,
 135                            (struct gl_program *) prog);
 136 }
 137
 138 static inline void
 139 _mesa_reference_tesseprog(struct gl_context *ctx,
 140                          struct gl_tess_eval_program **ptr,
 141                          struct gl_tess_eval_program *prog)
 142 {
 143    _mesa_reference_program(ctx, (struct gl_program **) ptr,
 144                            (struct gl_program *) prog);
 145 }
 146
 147 extern  GLboolean
 148 _mesa_insert_instructions(struct gl_program *prog, GLuint start, GLuint count);
 149
 150 extern  GLboolean
 151 _mesa_delete_instructions(struct gl_program *prog, GLuint start, GLuint count);
 152
 153 extern void
 154 _mesa_find_used_registers(const struct gl_program *prog,
 155                           gl_register_file file,
 156                           GLboolean used[], GLuint usedSize);
 157
 158 extern GLint
 159 _mesa_find_free_register(const GLboolean used[],
 160                          GLuint maxRegs, GLuint firstReg);
 161
 162 extern GLint
 163 _mesa_get_min_invocations_per_fragment(struct gl_context *ctx,
 164                                        const struct gl_fragment_program *prog,
 165                                        bool ignore_sample_qualifier);
 166
 167 static inline GLuint
 168 _mesa_program_enum_to_shader_stage(GLenum v)
 169 {
 170    switch (v) {
 171    case GL_VERTEX_PROGRAM_ARB:
 172       return MESA_SHADER_VERTEX;
 173    case GL_FRAGMENT_PROGRAM_ARB:
 174       return MESA_SHADER_FRAGMENT;
 175    case GL_GEOMETRY_PROGRAM_NV:
 176       return MESA_SHADER_GEOMETRY;
 177    case GL_TESS_CONTROL_PROGRAM_NV:
 178       return MESA_SHADER_TESS_CTRL;
 179    case GL_TESS_EVALUATION_PROGRAM_NV:
 180       return MESA_SHADER_TESS_EVAL;
 181    case GL_COMPUTE_PROGRAM_NV:
 182       return MESA_SHADER_COMPUTE;
 183    default:
 184       assert(0);
 185       return ~0;
 186    }
 187 }
 188
 189
 190 static inline GLenum
 191 _mesa_shader_stage_to_program(unsigned stage)
 192 {
 193    switch (stage) {
 194    case MESA_SHADER_VERTEX:
 195       return GL_VERTEX_PROGRAM_ARB;
 196    case MESA_SHADER_FRAGMENT:
 197       return GL_FRAGMENT_PROGRAM_ARB;
 198    case MESA_SHADER_GEOMETRY:
 199       return GL_GEOMETRY_PROGRAM_NV;
 200    case MESA_SHADER_TESS_CTRL:
 201       return GL_TESS_CONTROL_PROGRAM_NV;
 202    case MESA_SHADER_TESS_EVAL:
 203       return GL_TESS_EVALUATION_PROGRAM_NV;
 204    case MESA_SHADER_COMPUTE:
 205       return GL_COMPUTE_PROGRAM_NV;
 206    }
 207
 208    assert(!"Unexpected shader stage in _mesa_shader_stage_to_program");
 209    return GL_VERTEX_PROGRAM_ARB;
 210 }
 211
 212
 213 /* Cast wrappers from gl_program to derived program types.
 214  * (e.g. gl_vertex_program)
 215  */
 216
 217 static inline struct gl_fragment_program *
 218 gl_fragment_program(struct gl_program *prog)
 219 {
 220    return (struct gl_fragment_program *) prog;
 221 }
 222
 223 static inline const struct gl_fragment_program *
 224 gl_fragment_program_const(const struct gl_program *prog)
 225 {
 226    return (const struct gl_fragment_program *) prog;
 227 }
 228
 229
 230 static inline struct gl_vertex_program *
 231 gl_vertex_program(struct gl_program *prog)
 232 {
 233    return (struct gl_vertex_program *) prog;
 234 }
 235
 236 static inline const struct gl_vertex_program *
 237 gl_vertex_program_const(const struct gl_program *prog)
 238 {
 239    return (const struct gl_vertex_program *) prog;
 240 }
 241
 242
 243 static inline struct gl_geometry_program *
 244 gl_geometry_program(struct gl_program *prog)
 245 {
 246    return (struct gl_geometry_program *) prog;
 247 }
 248
 249 static inline const struct gl_geometry_program *
 250 gl_geometry_program_const(const struct gl_program *prog)
 251 {
 252    return (const struct gl_geometry_program *) prog;
 253 }
 254
 255
 256 static inline struct gl_compute_program *
 257 gl_compute_program(struct gl_program *prog)
 258 {
 259    return (struct gl_compute_program *) prog;
 260 }
 261
 262 static inline const struct gl_compute_program *
 263 gl_compute_program_const(const struct gl_program *prog)
 264 {
 265    return (const struct gl_compute_program *) prog;
 266 }
 267
 268 static inline struct gl_tess_ctrl_program *
 269 gl_tess_ctrl_program(struct gl_program *prog)
 270 {
 271    return (struct gl_tess_ctrl_program *) prog;
 272 }
 273
 274 static inline const struct gl_tess_ctrl_program *
 275 gl_tess_ctrl_program_const(const struct gl_program *prog)
 276 {
 277    return (const struct gl_tess_ctrl_program *) prog;
 278 }
 279
 280
 281 static inline struct gl_tess_eval_program *
 282 gl_tess_eval_program(struct gl_program *prog)
 283 {
 284    return (struct gl_tess_eval_program *) prog;
 285 }
 286
 287 static inline const struct gl_tess_eval_program *
 288 gl_tess_eval_program_const(const struct gl_program *prog)
 289 {
 290    return (const struct gl_tess_eval_program *) prog;
 291 }
 292
 293
 294 #ifdef __cplusplus
 295 } /* extern "C" */
 296 #endif
 297
 298 #endif /* PROGRAM_H */