src/glsl/link_varyings.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #pragma once
  25 #ifndef GLSL_LINK_VARYINGS_H
  26 #define GLSL_LINK_VARYINGS_H
  27
  28 /**
  29  * \file link_varyings.h
  30  *
  31  * Linker functions related specifically to linking varyings between shader
  32  * stages.
  33  */
  34
  35
  36 #include "main/glheader.h"
  37
  38
  39 struct gl_shader_program;
  40 struct gl_shader;
  41 class ir_variable;
  42
  43
  44 /**
  45  * Data structure describing a varying which is available for use in transform
  46  * feedback.
  47  *
  48  * For example, if the vertex shader contains:
  49  *
  50  *     struct S {
  51  *       vec4 foo;
  52  *       float[3] bar;
  53  *     };
  54  *
  55  *     varying S[2] v;
  56  *
  57  * Then there would be tfeedback_candidate objects corresponding to the
  58  * following varyings:
  59  *
  60  *     v[0].foo
  61  *     v[0].bar
  62  *     v[1].foo
  63  *     v[1].bar
  64  */
  65 struct tfeedback_candidate
  66 {
  67    /**
  68     * Toplevel variable containing this varying.  In the above example, this
  69     * would point to the declaration of the varying v.
  70     */
  71    ir_variable *toplevel_var;
  72
  73    /**
  74     * Type of this varying.  In the above example, this would point to the
  75     * glsl_type for "vec4" or "float[3]".
  76     */
  77    const glsl_type *type;
  78
  79    /**
  80     * Offset within the toplevel variable where this varying occurs (counted
  81     * in multiples of the size of a float).
  82     */
  83    unsigned offset;
  84 };
  85
  86
  87 /**
  88  * Data structure tracking information about a transform feedback declaration
  89  * during linking.
  90  */
  91 class tfeedback_decl
  92 {
  93 public:
  94    void init(struct gl_context *ctx, const void *mem_ctx, const char *input);
  95    static bool is_same(const tfeedback_decl &x, const tfeedback_decl &y);
  96    bool assign_location(struct gl_context *ctx,
  97                         struct gl_shader_program *prog);
  98    unsigned get_num_outputs() const;
  99    bool store(struct gl_context *ctx, struct gl_shader_program *prog,
 100               struct gl_transform_feedback_info *info, unsigned buffer,
 101               const unsigned max_outputs) const;
 102    const tfeedback_candidate *find_candidate(gl_shader_program *prog,
 103                                              hash_table *tfeedback_candidates);
 104
 105    bool is_next_buffer_separator() const
 106    {
 107       return this->next_buffer_separator;
 108    }
 109
 110    bool is_varying() const
 111    {
 112       return !this->next_buffer_separator && !this->skip_components;
 113    }
 114
 115    /**
 116     * The total number of varying components taken up by this variable.  Only
 117     * valid if assign_location() has been called.
 118     */
 119    unsigned num_components() const
 120    {
 121       if (this->is_clip_distance_mesa)
 122          return this->size;
 123       else
 124          return this->vector_elements * this->matrix_columns * this->size;
 125    }
 126
 127    unsigned get_location() const {
 128       return this->location;
 129    }
 130
 131 private:
 132    /**
 133     * The name that was supplied to glTransformFeedbackVaryings.  Used for
 134     * error reporting and glGetTransformFeedbackVarying().
 135     */
 136    const char *orig_name;
 137
 138    /**
 139     * The name of the variable, parsed from orig_name.
 140     */
 141    const char *var_name;
 142
 143    /**
 144     * True if the declaration in orig_name represents an array.
 145     */
 146    bool is_subscripted;
 147
 148    /**
 149     * If is_subscripted is true, the subscript that was specified in orig_name.
 150     */
 151    unsigned array_subscript;
 152
 153    /**
 154     * True if the variable is gl_ClipDistance and the driver lowers
 155     * gl_ClipDistance to gl_ClipDistanceMESA.
 156     */
 157    bool is_clip_distance_mesa;
 158
 159    /**
 160     * The vertex shader output location that the linker assigned for this
 161     * variable.  -1 if a location hasn't been assigned yet.
 162     */
 163    int location;
 164
 165    /**
 166     * If non-zero, then this variable may be packed along with other variables
 167     * into a single varying slot, so this offset should be applied when
 168     * accessing components.  For example, an offset of 1 means that the x
 169     * component of this variable is actually stored in component y of the
 170     * location specified by \c location.
 171     *
 172     * Only valid if location != -1.
 173     */
 174    unsigned location_frac;
 175
 176    /**
 177     * If location != -1, the number of vector elements in this variable, or 1
 178     * if this variable is a scalar.
 179     */
 180    unsigned vector_elements;
 181
 182    /**
 183     * If location != -1, the number of matrix columns in this variable, or 1
 184     * if this variable is not a matrix.
 185     */
 186    unsigned matrix_columns;
 187
 188    /** Type of the varying returned by glGetTransformFeedbackVarying() */
 189    GLenum type;
 190
 191    /**
 192     * If location != -1, the size that should be returned by
 193     * glGetTransformFeedbackVarying().
 194     */
 195    unsigned size;
 196
 197    /**
 198     * How many components to skip. If non-zero, this is
 199     * gl_SkipComponents{1,2,3,4} from ARB_transform_feedback3.
 200     */
 201    unsigned skip_components;
 202
 203    /**
 204     * Whether this is gl_NextBuffer from ARB_transform_feedback3.
 205     */
 206    bool next_buffer_separator;
 207
 208    /**
 209     * If find_candidate() has been called, pointer to the tfeedback_candidate
 210     * data structure that was found.  Otherwise NULL.
 211     */
 212    const tfeedback_candidate *matched_candidate;
 213 };
 214
 215
 216 void
 217 cross_validate_outputs_to_inputs(struct gl_shader_program *prog,
 218                                  gl_shader *producer, gl_shader *consumer);
 219
 220 bool
 221 parse_tfeedback_decls(struct gl_context *ctx, struct gl_shader_program *prog,
 222                       const void *mem_ctx, unsigned num_names,
 223                       char **varying_names, tfeedback_decl *decls);
 224
 225 bool
 226 store_tfeedback_info(struct gl_context *ctx, struct gl_shader_program *prog,
 227                      unsigned num_tfeedback_decls,
 228                      tfeedback_decl *tfeedback_decls);
 229
 230 bool
 231 assign_varying_locations(struct gl_context *ctx,
 232                          void *mem_ctx,
 233                          struct gl_shader_program *prog,
 234                          gl_shader *producer, gl_shader *consumer,
 235                          unsigned num_tfeedback_decls,
 236                          tfeedback_decl *tfeedback_decls,
 237                          unsigned gs_input_vertices);
 238
 239 bool
 240 check_against_output_limit(struct gl_context *ctx,
 241                            struct gl_shader_program *prog,
 242                            gl_shader *producer);
 243
 244 bool
 245 check_against_input_limit(struct gl_context *ctx,
 246                           struct gl_shader_program *prog,
 247                           gl_shader *consumer);
 248
 249 #endif /* GLSL_LINK_VARYINGS_H */