3 * Copyright © 2009 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * 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 OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
31 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
37 struct _mesa_glsl_parse_state
;
38 struct glsl_symbol_table
;
41 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
44 _mesa_glsl_release_types(void);
57 GLSL_TYPE_ATOMIC_UINT
,
65 enum glsl_sampler_dim
{
66 GLSL_SAMPLER_DIM_1D
= 0,
69 GLSL_SAMPLER_DIM_CUBE
,
70 GLSL_SAMPLER_DIM_RECT
,
72 GLSL_SAMPLER_DIM_EXTERNAL
,
76 enum glsl_interface_packing
{
77 GLSL_INTERFACE_PACKING_STD140
,
78 GLSL_INTERFACE_PACKING_SHARED
,
79 GLSL_INTERFACE_PACKING_PACKED
88 glsl_base_type base_type
;
90 unsigned sampler_dimensionality
:3; /**< \see glsl_sampler_dim */
91 unsigned sampler_shadow
:1;
92 unsigned sampler_array
:1;
93 unsigned sampler_type
:2; /**< Type of data returned using this
94 * sampler or image. Only \c
95 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
96 * and \c GLSL_TYPE_UINT are valid.
98 unsigned interface_packing
:2;
100 /* Callers of this ralloc-based new need not call delete. It's
101 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
102 static void* operator new(size_t size
)
104 if (glsl_type::mem_ctx
== NULL
) {
105 glsl_type::mem_ctx
= ralloc_context(NULL
);
106 assert(glsl_type::mem_ctx
!= NULL
);
111 type
= ralloc_size(glsl_type::mem_ctx
, size
);
112 assert(type
!= NULL
);
117 /* If the user *does* call delete, that's OK, we will just
118 * ralloc_free in that case. */
119 static void operator delete(void *type
)
125 * \name Vector and matrix element counts
127 * For scalars, each of these values will be 1. For non-numeric types
131 unsigned vector_elements
:3; /**< 1, 2, 3, or 4 vector elements. */
132 unsigned matrix_columns
:3; /**< 1, 2, 3, or 4 matrix columns. */
136 * Name of the data type
138 * Will never be \c NULL.
143 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
144 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
145 * elements in the structure and the number of values pointed to by
146 * \c fields.structure (below).
151 * Subtype of composite data types.
154 const struct glsl_type
*array
; /**< Type of array elements. */
155 const struct glsl_type
*parameters
; /**< Parameters to function. */
156 struct glsl_struct_field
*structure
; /**< List of struct fields. */
160 * \name Pointers to various public type singletons
164 #define DECL_TYPE(NAME, ...) \
165 static const glsl_type *const NAME##_type;
167 #define STRUCT_TYPE(NAME) \
168 static const glsl_type *const struct_##NAME##_type;
169 #include "builtin_type_macros.h"
173 * Convenience accessors for vector types (shorter than get_instance()).
176 static const glsl_type
*vec(unsigned components
);
177 static const glsl_type
*ivec(unsigned components
);
178 static const glsl_type
*uvec(unsigned components
);
179 static const glsl_type
*bvec(unsigned components
);
183 * For numeric and boolean derrived types returns the basic scalar type
185 * If the type is a numeric or boolean scalar, vector, or matrix type,
186 * this function gets the scalar type of the individual components. For
187 * all other types, including arrays of numeric or boolean types, the
188 * error type is returned.
190 const glsl_type
*get_base_type() const;
193 * Get the basic scalar type which this type aggregates.
195 * If the type is a numeric or boolean scalar, vector, or matrix, or an
196 * array of any of those, this function gets the scalar type of the
197 * individual components. For structs and arrays of structs, this function
198 * returns the struct type. For samplers and arrays of samplers, this
199 * function returns the sampler type.
201 const glsl_type
*get_scalar_type() const;
204 * Query the type of elements in an array
207 * Pointer to the type of elements in the array for array types, or \c NULL
208 * for non-array types.
210 const glsl_type
*element_type() const
212 return is_array() ? fields
.array
: NULL
;
216 * Get the instance of a built-in scalar, vector, or matrix type
218 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
222 * Get the instance of an array type
224 static const glsl_type
*get_array_instance(const glsl_type
*base
,
228 * Get the instance of a record type
230 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
235 * Get the instance of an interface block type
237 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
239 enum glsl_interface_packing packing
,
240 const char *block_name
);
243 * Query the total number of scalars that make up a scalar, vector or matrix
245 unsigned components() const
247 return vector_elements
* matrix_columns
;
251 * Calculate the number of components slots required to hold this type
253 * This is used to determine how many uniform or varying locations a type
256 unsigned component_slots() const;
259 * Calculate the number of attribute slots required to hold this type
261 * This implements the language rules of GLSL 1.50 for counting the number
262 * of slots used by a vertex attribute. It also determines the number of
263 * varying slots the type will use up in the absence of varying packing
264 * (and thus, it can be used to measure the number of varying slots used by
265 * the varyings that are generated by lower_packed_varyings).
267 unsigned count_attribute_slots() const;
271 * Alignment in bytes of the start of this type in a std140 uniform
274 unsigned std140_base_alignment(bool row_major
) const;
276 /** Size in bytes of this type in a std140 uniform block.
278 * Note that this is not GL_UNIFORM_SIZE (which is the number of
279 * elements in the array)
281 unsigned std140_size(bool row_major
) const;
284 * \brief Can this type be implicitly converted to another?
286 * \return True if the types are identical or if this type can be converted
287 * to \c desired according to Section 4.1.10 of the GLSL spec.
290 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
291 * Implicit Conversions:
293 * In some situations, an expression and its type will be implicitly
294 * converted to a different type. The following table shows all allowed
295 * implicit conversions:
297 * Type of expression | Can be implicitly converted to
298 * --------------------------------------------------
311 * There are no implicit array or structure conversions. For example,
312 * an array of int cannot be implicitly converted to an array of float.
313 * There are no implicit conversions between signed and unsigned
317 bool can_implicitly_convert_to(const glsl_type
*desired
) const;
320 * Query whether or not a type is a scalar (non-vector and non-matrix).
322 bool is_scalar() const
324 return (vector_elements
== 1)
325 && (base_type
>= GLSL_TYPE_UINT
)
326 && (base_type
<= GLSL_TYPE_BOOL
);
330 * Query whether or not a type is a vector
332 bool is_vector() const
334 return (vector_elements
> 1)
335 && (matrix_columns
== 1)
336 && (base_type
>= GLSL_TYPE_UINT
)
337 && (base_type
<= GLSL_TYPE_BOOL
);
341 * Query whether or not a type is a matrix
343 bool is_matrix() const
345 /* GLSL only has float matrices. */
346 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
);
350 * Query whether or not a type is a non-array numeric type
352 bool is_numeric() const
354 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_FLOAT
);
358 * Query whether or not a type is an integral type
360 bool is_integer() const
362 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
366 * Query whether or not type is an integral type, or for struct and array
367 * types, contains an integral type.
369 bool contains_integer() const;
372 * Query whether or not a type is a float type
374 bool is_float() const
376 return base_type
== GLSL_TYPE_FLOAT
;
380 * Query whether or not a type is a non-array boolean type
382 bool is_boolean() const
384 return base_type
== GLSL_TYPE_BOOL
;
388 * Query whether or not a type is a sampler
390 bool is_sampler() const
392 return base_type
== GLSL_TYPE_SAMPLER
;
396 * Query whether or not type is a sampler, or for struct and array
397 * types, contains a sampler.
399 bool contains_sampler() const;
402 * Get the Mesa texture target index for a sampler type.
404 gl_texture_index
sampler_index() const;
407 * Query whether or not type is an image, or for struct and array
408 * types, contains an image.
410 bool contains_image() const;
413 * Query whether or not a type is an image
415 bool is_image() const
417 return base_type
== GLSL_TYPE_IMAGE
;
421 * Query whether or not a type is an array
423 bool is_array() const
425 return base_type
== GLSL_TYPE_ARRAY
;
429 * Query whether or not a type is a record
431 bool is_record() const
433 return base_type
== GLSL_TYPE_STRUCT
;
437 * Query whether or not a type is an interface
439 bool is_interface() const
441 return base_type
== GLSL_TYPE_INTERFACE
;
445 * Query whether or not a type is the void type singleton.
449 return base_type
== GLSL_TYPE_VOID
;
453 * Query whether or not a type is the error type singleton.
455 bool is_error() const
457 return base_type
== GLSL_TYPE_ERROR
;
461 * Return the amount of atomic counter storage required for a type.
463 unsigned atomic_size() const
465 if (base_type
== GLSL_TYPE_ATOMIC_UINT
)
466 return ATOMIC_COUNTER_SIZE
;
468 return length
* element_type()->atomic_size();
474 * Return whether a type contains any atomic counters.
476 bool contains_atomic() const
478 return atomic_size() > 0;
482 * Return whether a type contains any opaque types.
484 bool contains_opaque() const;
487 * Query the full type of a matrix row
490 * If the type is not a matrix, \c glsl_type::error_type is returned.
491 * Otherwise a type matching the rows of the matrix is returned.
493 const glsl_type
*row_type() const
496 ? get_instance(base_type
, matrix_columns
, 1)
501 * Query the full type of a matrix column
504 * If the type is not a matrix, \c glsl_type::error_type is returned.
505 * Otherwise a type matching the columns of the matrix is returned.
507 const glsl_type
*column_type() const
510 ? get_instance(base_type
, vector_elements
, 1)
515 * Get the type of a structure field
518 * Pointer to the type of the named field. If the type is not a structure
519 * or the named field does not exist, \c glsl_type::error_type is returned.
521 const glsl_type
*field_type(const char *name
) const;
524 * Get the location of a filed within a record type
526 int field_index(const char *name
) const;
529 * Query the number of elements in an array type
532 * The number of elements in the array for array types or -1 for non-array
533 * types. If the number of elements in the array has not yet been declared,
536 int array_size() const
538 return is_array() ? length
: -1;
542 * Query whether the array size for all dimensions has been declared.
544 bool is_unsized_array() const
546 return is_array() && length
== 0;
550 * Return the number of coordinate components needed for this
551 * sampler or image type.
553 * This is based purely on the sampler's dimensionality. For example, this
554 * returns 1 for sampler1D, and 3 for sampler2DArray.
556 * Note that this is often different than actual coordinate type used in
557 * a texturing built-in function, since those pack additional values (such
558 * as the shadow comparitor or projector) into the coordinate type.
560 int coordinate_components() const;
563 * Compare a record type against another record type.
565 * This is useful for matching record types declared across shader stages.
567 bool record_compare(const glsl_type
*b
) const;
571 * ralloc context for all glsl_type allocations
573 * Set on the first call to \c glsl_type::new.
575 static void *mem_ctx
;
577 void init_ralloc_type_ctx(void);
579 /** Constructor for vector and matrix types */
580 glsl_type(GLenum gl_type
,
581 glsl_base_type base_type
, unsigned vector_elements
,
582 unsigned matrix_columns
, const char *name
);
584 /** Constructor for sampler or image types */
585 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
586 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
587 unsigned type
, const char *name
);
589 /** Constructor for record types */
590 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
593 /** Constructor for interface types */
594 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
595 enum glsl_interface_packing packing
, const char *name
);
597 /** Constructor for array types */
598 glsl_type(const glsl_type
*array
, unsigned length
);
600 /** Hash table containing the known array types. */
601 static struct hash_table
*array_types
;
603 /** Hash table containing the known record types. */
604 static struct hash_table
*record_types
;
606 /** Hash table containing the known interface types. */
607 static struct hash_table
*interface_types
;
609 static int record_key_compare(const void *a
, const void *b
);
610 static unsigned record_key_hash(const void *key
);
613 * \name Built-in type flyweights
617 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
619 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
620 #include "builtin_type_macros.h"
624 * \name Friend functions.
626 * These functions are friends because they must have C linkage and the
627 * need to call various private methods or access various private static
631 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
632 friend void _mesa_glsl_release_types(void);
636 struct glsl_struct_field
{
637 const struct glsl_type
*type
;
642 * For interface blocks, gl_varying_slot corresponding to the input/output
643 * if this is a built-in input/output (i.e. a member of the built-in
644 * gl_PerVertex interface block); -1 otherwise.
646 * Ignored for structs.
651 * For interface blocks, the interpolation mode (as in
652 * ir_variable::interpolation). 0 otherwise.
654 unsigned interpolation
:2;
657 * For interface blocks, 1 if this variable uses centroid interpolation (as
658 * in ir_variable::centroid). 0 otherwise.
663 * For interface blocks, 1 if this variable uses sample interpolation (as
664 * in ir_variable::sample). 0 otherwise.
669 static inline unsigned int
670 glsl_align(unsigned int a
, unsigned int align
)
672 return (a
+ align
- 1) / align
* align
;
677 #endif /* __cplusplus */
679 #endif /* GLSL_TYPES_H */