nir: Expose the packed attribute attached to glsl_type objects
[mesa.git] / src / compiler / nir_types.h
1 /*
2 * Copyright © 2014 Connor Abbott
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 DEALINGS
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 * Connor Abbott (cwabbott0@gmail.com)
25 *
26 */
27
28 #ifndef NIR_TYPES_H
29 #define NIR_TYPES_H
30
31 #include <stdio.h>
32 #include <stdbool.h>
33
34 /* C wrapper around compiler/glsl_types.h */
35
36 #include "glsl_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #else
41 struct glsl_type;
42 #endif
43
44 const char *glsl_get_type_name(const struct glsl_type *type);
45
46 const struct glsl_type *glsl_get_struct_field(const struct glsl_type *type,
47 unsigned index);
48
49 int glsl_get_struct_field_offset(const struct glsl_type *type,
50 unsigned index);
51
52 const struct glsl_struct_field *
53 glsl_get_struct_field_data(const struct glsl_type *type, unsigned index);
54
55 enum glsl_interface_packing
56 glsl_get_internal_ifc_packing(const struct glsl_type *type,
57 bool std430_supported);
58 enum glsl_interface_packing
59 glsl_get_ifc_packing(const struct glsl_type *type);
60
61 unsigned glsl_get_std140_base_alignment(const struct glsl_type *type,
62 bool row_major);
63 unsigned glsl_get_std140_size(const struct glsl_type *type, bool row_major);
64 unsigned glsl_get_std430_base_alignment(const struct glsl_type *type,
65 bool row_major);
66 unsigned glsl_get_std430_size(const struct glsl_type *type, bool row_major);
67 unsigned glsl_get_explicit_stride(const struct glsl_type *type);
68 int glsl_array_size(const struct glsl_type *type);
69 const struct glsl_type *glsl_get_array_element(const struct glsl_type *type);
70 const struct glsl_type *glsl_without_array(const struct glsl_type *type);
71 const struct glsl_type *glsl_without_array_or_matrix(const struct glsl_type *type);
72 const struct glsl_type *glsl_get_bare_type(const struct glsl_type *type);
73
74 const struct glsl_type *glsl_get_column_type(const struct glsl_type *type);
75
76 const struct glsl_type *
77 glsl_get_function_return_type(const struct glsl_type *type);
78
79 const struct glsl_function_param *
80 glsl_get_function_param(const struct glsl_type *type, unsigned index);
81
82 GLenum glsl_get_gl_type(const struct glsl_type *type);
83
84 enum glsl_base_type glsl_get_base_type(const struct glsl_type *type);
85
86 unsigned glsl_get_vector_elements(const struct glsl_type *type);
87
88 unsigned glsl_get_components(const struct glsl_type *type);
89
90 unsigned glsl_get_matrix_columns(const struct glsl_type *type);
91
92 unsigned glsl_get_length(const struct glsl_type *type);
93
94 unsigned glsl_get_aoa_size(const struct glsl_type *type);
95
96 unsigned glsl_count_vec4_slots(const struct glsl_type *type,
97 bool is_gl_vertex_input, bool is_bindless);
98 unsigned glsl_count_dword_slots(const struct glsl_type *type, bool is_bindless);
99 unsigned glsl_count_attribute_slots(const struct glsl_type *type,
100 bool is_gl_vertex_input);
101 unsigned glsl_get_component_slots(const struct glsl_type *type);
102 unsigned glsl_varying_count(const struct glsl_type *type);
103
104 const char *glsl_get_struct_elem_name(const struct glsl_type *type,
105 unsigned index);
106
107 enum glsl_sampler_dim glsl_get_sampler_dim(const struct glsl_type *type);
108 enum glsl_base_type glsl_get_sampler_result_type(const struct glsl_type *type);
109 unsigned glsl_get_sampler_target(const struct glsl_type *type);
110 int glsl_get_sampler_coordinate_components(const struct glsl_type *type);
111
112 unsigned glsl_get_struct_location_offset(const struct glsl_type *type,
113 unsigned length);
114
115 unsigned glsl_atomic_size(const struct glsl_type *type);
116
117 int glsl_get_cl_size(const struct glsl_type *type);
118
119 int glsl_get_cl_alignment(const struct glsl_type *type);
120
121 void glsl_get_cl_type_size_align(const struct glsl_type *type,
122 unsigned *size, unsigned *align);
123
124 unsigned glsl_get_explicit_size(const struct glsl_type *type, bool align_to_stride);
125
126 static inline unsigned
127 glsl_get_bit_size(const struct glsl_type *type)
128 {
129 return glsl_base_type_get_bit_size(glsl_get_base_type(type));
130 }
131
132 bool glsl_type_is_packed(const struct glsl_type *type);
133 bool glsl_type_is_16bit(const struct glsl_type *type);
134 bool glsl_type_is_32bit(const struct glsl_type *type);
135 bool glsl_type_is_64bit(const struct glsl_type *type);
136 bool glsl_type_is_void(const struct glsl_type *type);
137 bool glsl_type_is_error(const struct glsl_type *type);
138 bool glsl_type_is_vector(const struct glsl_type *type);
139 bool glsl_type_is_scalar(const struct glsl_type *type);
140 bool glsl_type_is_vector_or_scalar(const struct glsl_type *type);
141 bool glsl_type_is_matrix(const struct glsl_type *type);
142 bool glsl_matrix_type_is_row_major(const struct glsl_type *type);
143 bool glsl_type_is_array(const struct glsl_type *type);
144 bool glsl_type_is_unsized_array(const struct glsl_type *type);
145 bool glsl_type_is_array_of_arrays(const struct glsl_type *type);
146 bool glsl_type_is_array_or_matrix(const struct glsl_type *type);
147 bool glsl_type_is_struct(const struct glsl_type *type);
148 bool glsl_type_is_interface(const struct glsl_type *type);
149 bool glsl_type_is_struct_or_ifc(const struct glsl_type *type);
150 bool glsl_type_is_sampler(const struct glsl_type *type);
151 bool glsl_type_is_image(const struct glsl_type *type);
152 bool glsl_type_is_dual_slot(const struct glsl_type *type);
153 bool glsl_type_is_numeric(const struct glsl_type *type);
154 bool glsl_type_is_boolean(const struct glsl_type *type);
155 bool glsl_type_is_integer(const struct glsl_type *type);
156 bool glsl_type_contains_64bit(const struct glsl_type *type);
157 bool glsl_sampler_type_is_shadow(const struct glsl_type *type);
158 bool glsl_sampler_type_is_array(const struct glsl_type *type);
159 bool glsl_struct_type_is_packed(const struct glsl_type *type);
160 bool glsl_contains_atomic(const struct glsl_type *type);
161 bool glsl_contains_opaque(const struct glsl_type *type);
162
163 const struct glsl_type *glsl_void_type(void);
164 const struct glsl_type *glsl_float_type(void);
165 const struct glsl_type *glsl_float16_t_type(void);
166 const struct glsl_type *glsl_double_type(void);
167 const struct glsl_type *glsl_vec_type(unsigned n);
168 const struct glsl_type *glsl_dvec_type(unsigned n);
169 const struct glsl_type *glsl_vec4_type(void);
170 const struct glsl_type *glsl_uvec4_type(void);
171 const struct glsl_type *glsl_int_type(void);
172 const struct glsl_type *glsl_uint_type(void);
173 const struct glsl_type *glsl_int64_t_type(void);
174 const struct glsl_type *glsl_uint64_t_type(void);
175 const struct glsl_type *glsl_int16_t_type(void);
176 const struct glsl_type *glsl_uint16_t_type(void);
177 const struct glsl_type *glsl_int8_t_type(void);
178 const struct glsl_type *glsl_uint8_t_type(void);
179 const struct glsl_type *glsl_bool_type(void);
180
181 const struct glsl_type *glsl_scalar_type(enum glsl_base_type base_type);
182 const struct glsl_type *glsl_vector_type(enum glsl_base_type base_type,
183 unsigned components);
184 const struct glsl_type * glsl_replace_vector_type(const struct glsl_type *t,
185 unsigned components);
186 const struct glsl_type *glsl_matrix_type(enum glsl_base_type base_type,
187 unsigned rows, unsigned columns);
188 const struct glsl_type *glsl_explicit_matrix_type(const struct glsl_type *mat,
189 unsigned stride,
190 bool row_major);
191
192 const struct glsl_type *glsl_array_type(const struct glsl_type *base,
193 unsigned elements,
194 unsigned explicit_stride);
195
196 const struct glsl_type *glsl_struct_type(const struct glsl_struct_field *fields,
197 unsigned num_fields, const char *name,
198 bool packed);
199 const struct glsl_type *glsl_interface_type(const struct glsl_struct_field *fields,
200 unsigned num_fields,
201 enum glsl_interface_packing packing,
202 bool row_major,
203 const char *block_name);
204 const struct glsl_type *glsl_sampler_type(enum glsl_sampler_dim dim,
205 bool is_shadow, bool is_array,
206 enum glsl_base_type base_type);
207 const struct glsl_type *glsl_bare_sampler_type();
208 const struct glsl_type *glsl_bare_shadow_sampler_type();
209 const struct glsl_type *glsl_image_type(enum glsl_sampler_dim dim,
210 bool is_array,
211 enum glsl_base_type base_type);
212 const struct glsl_type * glsl_function_type(const struct glsl_type *return_type,
213 const struct glsl_function_param *params,
214 unsigned num_params);
215
216 const struct glsl_type *glsl_transposed_type(const struct glsl_type *type);
217
218 const struct glsl_type *glsl_channel_type(const struct glsl_type *type);
219
220 const struct glsl_type *glsl_float16_type(const struct glsl_type *type);
221 const struct glsl_type *glsl_int16_type(const struct glsl_type *type);
222 const struct glsl_type *glsl_uint16_type(const struct glsl_type *type);
223
224 void glsl_get_natural_size_align_bytes(const struct glsl_type *type,
225 unsigned *size, unsigned *align);
226
227 const struct glsl_type *glsl_atomic_uint_type(void);
228
229 const struct glsl_type *glsl_get_explicit_type_for_size_align(const struct glsl_type *type,
230 glsl_type_size_align_func type_info,
231 unsigned *size, unsigned *align);
232
233 unsigned glsl_type_get_sampler_count(const struct glsl_type *type);
234 unsigned glsl_type_get_image_count(const struct glsl_type *type);
235
236 bool glsl_type_is_leaf(const struct glsl_type *type);
237
238 #ifdef __cplusplus
239 }
240 #endif
241
242 #endif /* NIR_TYPES_H */