glsl_type: Add a C wrapper to get struct field offsets
[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 const int glsl_get_struct_field_offset(const struct glsl_type *type,
50 unsigned index);
51
52 const struct glsl_type *glsl_get_array_element(const struct glsl_type *type);
53 const struct glsl_type *glsl_without_array(const struct glsl_type *type);
54 const struct glsl_type *glsl_without_array_or_matrix(const struct glsl_type *type);
55
56 const struct glsl_type *glsl_get_column_type(const struct glsl_type *type);
57
58 const struct glsl_type *
59 glsl_get_function_return_type(const struct glsl_type *type);
60
61 const struct glsl_function_param *
62 glsl_get_function_param(const struct glsl_type *type, unsigned index);
63
64 GLenum glsl_get_gl_type(const struct glsl_type *type);
65
66 enum glsl_base_type glsl_get_base_type(const struct glsl_type *type);
67
68 unsigned glsl_get_vector_elements(const struct glsl_type *type);
69
70 unsigned glsl_get_components(const struct glsl_type *type);
71
72 unsigned glsl_get_matrix_columns(const struct glsl_type *type);
73
74 unsigned glsl_get_length(const struct glsl_type *type);
75
76 unsigned glsl_get_aoa_size(const struct glsl_type *type);
77
78 unsigned glsl_count_attribute_slots(const struct glsl_type *type,
79 bool is_vertex_input);
80 unsigned glsl_get_component_slots(const struct glsl_type *type);
81
82 const char *glsl_get_struct_elem_name(const struct glsl_type *type,
83 unsigned index);
84
85 enum glsl_sampler_dim glsl_get_sampler_dim(const struct glsl_type *type);
86 enum glsl_base_type glsl_get_sampler_result_type(const struct glsl_type *type);
87 unsigned glsl_get_sampler_target(const struct glsl_type *type);
88 int glsl_get_sampler_coordinate_components(const struct glsl_type *type);
89
90 unsigned glsl_get_record_location_offset(const struct glsl_type *type,
91 unsigned length);
92
93 unsigned glsl_atomic_size(const struct glsl_type *type);
94
95 static inline unsigned
96 glsl_get_bit_size(const struct glsl_type *type)
97 {
98 switch (glsl_get_base_type(type)) {
99 case GLSL_TYPE_BOOL:
100 return 1;
101
102 case GLSL_TYPE_INT:
103 case GLSL_TYPE_UINT:
104 case GLSL_TYPE_FLOAT: /* TODO handle mediump */
105 case GLSL_TYPE_SUBROUTINE:
106 return 32;
107
108 case GLSL_TYPE_FLOAT16:
109 case GLSL_TYPE_UINT16:
110 case GLSL_TYPE_INT16:
111 return 16;
112
113 case GLSL_TYPE_UINT8:
114 case GLSL_TYPE_INT8:
115 return 8;
116
117 case GLSL_TYPE_DOUBLE:
118 case GLSL_TYPE_INT64:
119 case GLSL_TYPE_UINT64:
120 case GLSL_TYPE_IMAGE:
121 case GLSL_TYPE_SAMPLER:
122 return 64;
123
124 default:
125 unreachable("unknown base type");
126 }
127
128 return 0;
129 }
130
131 bool glsl_type_is_16bit(const struct glsl_type *type);
132 bool glsl_type_is_64bit(const struct glsl_type *type);
133 bool glsl_type_is_void(const struct glsl_type *type);
134 bool glsl_type_is_error(const struct glsl_type *type);
135 bool glsl_type_is_vector(const struct glsl_type *type);
136 bool glsl_type_is_scalar(const struct glsl_type *type);
137 bool glsl_type_is_vector_or_scalar(const struct glsl_type *type);
138 bool glsl_type_is_matrix(const struct glsl_type *type);
139 bool glsl_type_is_array(const struct glsl_type *type);
140 bool glsl_type_is_array_of_arrays(const struct glsl_type *type);
141 bool glsl_type_is_array_or_matrix(const struct glsl_type *type);
142 bool glsl_type_is_struct(const struct glsl_type *type);
143 bool glsl_type_is_sampler(const struct glsl_type *type);
144 bool glsl_type_is_image(const struct glsl_type *type);
145 bool glsl_type_is_dual_slot(const struct glsl_type *type);
146 bool glsl_type_is_numeric(const struct glsl_type *type);
147 bool glsl_type_is_boolean(const struct glsl_type *type);
148 bool glsl_type_is_integer(const struct glsl_type *type);
149 bool glsl_sampler_type_is_shadow(const struct glsl_type *type);
150 bool glsl_sampler_type_is_array(const struct glsl_type *type);
151 bool glsl_contains_atomic(const struct glsl_type *type);
152
153 const struct glsl_type *glsl_void_type(void);
154 const struct glsl_type *glsl_float_type(void);
155 const struct glsl_type *glsl_float16_t_type(void);
156 const struct glsl_type *glsl_double_type(void);
157 const struct glsl_type *glsl_vec_type(unsigned n);
158 const struct glsl_type *glsl_dvec_type(unsigned n);
159 const struct glsl_type *glsl_vec4_type(void);
160 const struct glsl_type *glsl_uvec4_type(void);
161 const struct glsl_type *glsl_int_type(void);
162 const struct glsl_type *glsl_uint_type(void);
163 const struct glsl_type *glsl_int64_t_type(void);
164 const struct glsl_type *glsl_uint64_t_type(void);
165 const struct glsl_type *glsl_int16_t_type(void);
166 const struct glsl_type *glsl_uint16_t_type(void);
167 const struct glsl_type *glsl_int8_t_type(void);
168 const struct glsl_type *glsl_uint8_t_type(void);
169 const struct glsl_type *glsl_bool_type(void);
170
171 const struct glsl_type *glsl_scalar_type(enum glsl_base_type base_type);
172 const struct glsl_type *glsl_vector_type(enum glsl_base_type base_type,
173 unsigned components);
174 const struct glsl_type *glsl_matrix_type(enum glsl_base_type base_type,
175 unsigned rows, unsigned columns);
176 const struct glsl_type *glsl_array_type(const struct glsl_type *base,
177 unsigned elements);
178 const struct glsl_type *glsl_struct_type(const struct glsl_struct_field *fields,
179 unsigned num_fields, const char *name);
180 const struct glsl_type *glsl_interface_type(const struct glsl_struct_field *fields,
181 unsigned num_fields,
182 enum glsl_interface_packing packing,
183 bool row_major,
184 const char *block_name);
185 const struct glsl_type *glsl_sampler_type(enum glsl_sampler_dim dim,
186 bool is_shadow, bool is_array,
187 enum glsl_base_type base_type);
188 const struct glsl_type *glsl_bare_sampler_type();
189 const struct glsl_type *glsl_image_type(enum glsl_sampler_dim dim,
190 bool is_array,
191 enum glsl_base_type base_type);
192 const struct glsl_type * glsl_function_type(const struct glsl_type *return_type,
193 const struct glsl_function_param *params,
194 unsigned num_params);
195
196 const struct glsl_type *glsl_transposed_type(const struct glsl_type *type);
197
198 const struct glsl_type *glsl_channel_type(const struct glsl_type *type);
199
200 typedef void (*glsl_type_size_align_func)(const struct glsl_type *type,
201 unsigned *size, unsigned *align);
202
203 void glsl_get_natural_size_align_bytes(const struct glsl_type *type,
204 unsigned *size, unsigned *align);
205
206 const struct glsl_type *glsl_atomic_uint_type(void);
207
208 #ifdef __cplusplus
209 }
210 #endif
211
212 #endif /* NIR_TYPES_H */