src/glsl/ir_uniform.h

   1 /*
   2  * Copyright © 2011 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 IR_UNIFORM_H
  26 #define IR_UNIFORM_H
  27
  28
  29 /* stdbool.h is necessary because this file is included in both C and C++ code.
  30  */
  31 #include <stdbool.h>
  32
  33 #include "program/prog_parameter.h"  /* For union gl_constant_value. */
  34
  35 /**
  36  * Used by GL_ARB_explicit_uniform_location extension code in the linker
  37  * and glUniform* functions to identify inactive explicit uniform locations.
  38  */
  39 #define INACTIVE_UNIFORM_EXPLICIT_LOCATION ((gl_uniform_storage *) -1)
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 enum PACKED gl_uniform_driver_format {
  46    uniform_native = 0,          /**< Store data in the native format. */
  47    uniform_int_float,           /**< Store integer data as floats. */
  48    uniform_bool_float,          /**< Store boolean data as floats. */
  49
  50    /**
  51     * Store boolean data as integer using 1 for \c true.
  52     */
  53    uniform_bool_int_0_1,
  54
  55    /**
  56     * Store boolean data as integer using ~0 for \c true.
  57     */
  58    uniform_bool_int_0_not0
  59 };
  60
  61 struct gl_uniform_driver_storage {
  62    /**
  63     * Number of bytes from one array element to the next.
  64     */
  65    uint8_t element_stride;
  66
  67    /**
  68     * Number of bytes from one vector in a matrix to the next.
  69     */
  70    uint8_t vector_stride;
  71
  72    /**
  73     * Base format of the stored data.
  74     */
  75    enum gl_uniform_driver_format format;
  76
  77    /**
  78     * Pointer to the base of the data.
  79     */
  80    void *data;
  81 };
  82
  83 struct gl_opaque_uniform_index {
  84    /**
  85     * Base opaque uniform index
  86     *
  87     * If \c gl_uniform_storage::base_type is an opaque type, this
  88     * represents its uniform index.  If \c
  89     * gl_uniform_storage::array_elements is not zero, the array will
  90     * use opaque uniform indices \c index through \c index + \c
  91     * gl_uniform_storage::array_elements - 1, inclusive.
  92     *
  93     * Note that the index may be different in each shader stage.
  94     */
  95    uint8_t index;
  96
  97    /**
  98     * Whether this opaque uniform is used in this shader stage.
  99     */
 100    bool active;
 101 };
 102
 103 struct gl_uniform_storage {
 104    char *name;
 105    /** Type of this uniform data stored.
 106     *
 107     * In the case of an array, it's the type of a single array element.
 108     */
 109    const struct glsl_type *type;
 110
 111    /**
 112     * The number of elements in this uniform.
 113     *
 114     * For non-arrays, this is always 0.  For arrays, the value is the size of
 115     * the array.
 116     */
 117    unsigned array_elements;
 118
 119    /**
 120     * Has this uniform ever been set?
 121     */
 122    bool initialized;
 123
 124    struct gl_opaque_uniform_index sampler[MESA_SHADER_STAGES];
 125
 126    struct gl_opaque_uniform_index image[MESA_SHADER_STAGES];
 127
 128    /**
 129     * Storage used by the driver for the uniform
 130     */
 131    unsigned num_driver_storage;
 132    struct gl_uniform_driver_storage *driver_storage;
 133
 134    /**
 135     * Storage used by Mesa for the uniform
 136     *
 137     * This form of the uniform is used by Mesa's implementation of \c
 138     * glGetUniform.  It can also be used by drivers to obtain the value of the
 139     * uniform if the \c ::driver_storage interface is not used.
 140     */
 141    union gl_constant_value *storage;
 142
 143    /** Fields for GL_ARB_uniform_buffer_object
 144     * @{
 145     */
 146
 147    /**
 148     * GL_UNIFORM_BLOCK_INDEX: index of the uniform block containing
 149     * the uniform, or -1 for the default uniform block.  Note that the
 150     * index is into the linked program's UniformBlocks[] array, not
 151     * the linked shader's.
 152     */
 153    int block_index;
 154
 155    /** GL_UNIFORM_OFFSET: byte offset within the uniform block, or -1. */
 156    int offset;
 157
 158    /**
 159     * GL_UNIFORM_MATRIX_STRIDE: byte stride between columns or rows of
 160     * a matrix.  Set to 0 for non-matrices in UBOs, or -1 for uniforms
 161     * in the default uniform block.
 162     */
 163    int matrix_stride;
 164
 165    /**
 166     * GL_UNIFORM_ARRAY_STRIDE: byte stride between elements of the
 167     * array.  Set to zero for non-arrays in UBOs, or -1 for uniforms
 168     * in the default uniform block.
 169     */
 170    int array_stride;
 171
 172    /** GL_UNIFORM_ROW_MAJOR: true iff it's a row-major matrix in a UBO */
 173    bool row_major;
 174
 175    /** @} */
 176
 177    /**
 178     * Index within gl_shader_program::AtomicBuffers[] of the atomic
 179     * counter buffer this uniform is stored in, or -1 if this is not
 180     * an atomic counter.
 181     */
 182    int atomic_buffer_index;
 183
 184    /**
 185     * The 'base location' for this uniform in the uniform remap table. For
 186     * arrays this is the first element in the array.
 187     */
 188    unsigned remap_location;
 189 };
 190
 191 #ifdef __cplusplus
 192 }
 193 #endif
 194
 195 #endif /* IR_UNIFORM_H */