1/*
2 * Copyright 2019-2021 Hans-Kristian Arntzen
3 * SPDX-License-Identifier: Apache-2.0 OR MIT
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * At your option, you may choose to accept this material under either:
20 * 1. The Apache License, Version 2.0, found at <http://www.apache.org/licenses/LICENSE-2.0>, or
21 * 2. The MIT License, found at <http://opensource.org/licenses/MIT>.
22 */
23
24#ifndef SPIRV_CROSS_C_API_H
25#define SPIRV_CROSS_C_API_H
26
27#include <stddef.h>
28#include "spirv.h"
29
30/*
31 * C89-compatible wrapper for SPIRV-Cross' API.
32 * Documentation here is sparse unless the behavior does not map 1:1 with C++ API.
33 * It is recommended to look at the canonical C++ API for more detailed information.
34 */
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/* Bumped if ABI or API breaks backwards compatibility. */
41#define SPVC_C_API_VERSION_MAJOR 0
42/* Bumped if APIs or enumerations are added in a backwards compatible way. */
43#define SPVC_C_API_VERSION_MINOR 60
44/* Bumped if internal implementation details change. */
45#define SPVC_C_API_VERSION_PATCH 0
46
47#if !defined(SPVC_PUBLIC_API)
48#if defined(SPVC_EXPORT_SYMBOLS)
49/* Exports symbols. Standard C calling convention is used. */
50#if defined(__GNUC__)
51#define SPVC_PUBLIC_API __attribute__((visibility("default")))
52#elif defined(_MSC_VER)
53#define SPVC_PUBLIC_API __declspec(dllexport)
54#else
55#define SPVC_PUBLIC_API
56#endif
57#else
58#define SPVC_PUBLIC_API
59#endif
60#endif
61
62/*
63 * Gets the SPVC_C_API_VERSION_* used to build this library.
64 * Can be used to check for ABI mismatch if so-versioning did not catch it.
65 */
66SPVC_PUBLIC_API void spvc_get_version(unsigned *major, unsigned *minor, unsigned *patch);
67
68/* Gets a human readable version string to identify which commit a particular binary was created from. */
69SPVC_PUBLIC_API const char *spvc_get_commit_revision_and_timestamp(void);
70
71/* These types are opaque to the user. */
72typedef struct spvc_context_s *spvc_context;
73typedef struct spvc_parsed_ir_s *spvc_parsed_ir;
74typedef struct spvc_compiler_s *spvc_compiler;
75typedef struct spvc_compiler_options_s *spvc_compiler_options;
76typedef struct spvc_resources_s *spvc_resources;
77struct spvc_type_s;
78typedef const struct spvc_type_s *spvc_type;
79typedef struct spvc_constant_s *spvc_constant;
80struct spvc_set_s;
81typedef const struct spvc_set_s *spvc_set;
82
83/*
84 * Shallow typedefs. All SPIR-V IDs are plain 32-bit numbers, but this helps communicate which data is used.
85 * Maps to a SPIRType.
86 */
87typedef SpvId spvc_type_id;
88/* Maps to a SPIRVariable. */
89typedef SpvId spvc_variable_id;
90/* Maps to a SPIRConstant. */
91typedef SpvId spvc_constant_id;
92
93/* See C++ API. */
94typedef struct spvc_reflected_resource
95{
96 spvc_variable_id id;
97 spvc_type_id base_type_id;
98 spvc_type_id type_id;
99 const char *name;
100} spvc_reflected_resource;
101
102typedef struct spvc_reflected_builtin_resource
103{
104 SpvBuiltIn builtin;
105 spvc_type_id value_type_id;
106 spvc_reflected_resource resource;
107} spvc_reflected_builtin_resource;
108
109/* See C++ API. */
110typedef struct spvc_entry_point
111{
112 SpvExecutionModel execution_model;
113 const char *name;
114} spvc_entry_point;
115
116/* See C++ API. */
117typedef struct spvc_combined_image_sampler
118{
119 spvc_variable_id combined_id;
120 spvc_variable_id image_id;
121 spvc_variable_id sampler_id;
122} spvc_combined_image_sampler;
123
124/* See C++ API. */
125typedef struct spvc_specialization_constant
126{
127 spvc_constant_id id;
128 unsigned constant_id;
129} spvc_specialization_constant;
130
131/* See C++ API. */
132typedef struct spvc_buffer_range
133{
134 unsigned index;
135 size_t offset;
136 size_t range;
137} spvc_buffer_range;
138
139/* See C++ API. */
140typedef struct spvc_hlsl_root_constants
141{
142 unsigned start;
143 unsigned end;
144 unsigned binding;
145 unsigned space;
146} spvc_hlsl_root_constants;
147
148/* See C++ API. */
149typedef struct spvc_hlsl_vertex_attribute_remap
150{
151 unsigned location;
152 const char *semantic;
153} spvc_hlsl_vertex_attribute_remap;
154
155/*
156 * Be compatible with non-C99 compilers, which do not have stdbool.
157 * Only recent MSVC compilers supports this for example, and ideally SPIRV-Cross should be linkable
158 * from a wide range of compilers in its C wrapper.
159 */
160typedef unsigned char spvc_bool;
161#define SPVC_TRUE ((spvc_bool)1)
162#define SPVC_FALSE ((spvc_bool)0)
163
164typedef enum spvc_result
165{
166 /* Success. */
167 SPVC_SUCCESS = 0,
168
169 /* The SPIR-V is invalid. Should have been caught by validation ideally. */
170 SPVC_ERROR_INVALID_SPIRV = -1,
171
172 /* The SPIR-V might be valid or invalid, but SPIRV-Cross currently cannot correctly translate this to your target language. */
173 SPVC_ERROR_UNSUPPORTED_SPIRV = -2,
174
175 /* If for some reason we hit this, new or malloc failed. */
176 SPVC_ERROR_OUT_OF_MEMORY = -3,
177
178 /* Invalid API argument. */
179 SPVC_ERROR_INVALID_ARGUMENT = -4,
180
181 SPVC_ERROR_INT_MAX = 0x7fffffff
182} spvc_result;
183
184typedef enum spvc_capture_mode
185{
186 /* The Parsed IR payload will be copied, and the handle can be reused to create other compiler instances. */
187 SPVC_CAPTURE_MODE_COPY = 0,
188
189 /*
190 * The payload will now be owned by the compiler.
191 * parsed_ir should now be considered a dead blob and must not be used further.
192 * This is optimal for performance and should be the go-to option.
193 */
194 SPVC_CAPTURE_MODE_TAKE_OWNERSHIP = 1,
195
196 SPVC_CAPTURE_MODE_INT_MAX = 0x7fffffff
197} spvc_capture_mode;
198
199typedef enum spvc_backend
200{
201 /* This backend can only perform reflection, no compiler options are supported. Maps to spirv_cross::Compiler. */
202 SPVC_BACKEND_NONE = 0,
203 SPVC_BACKEND_GLSL = 1, /* spirv_cross::CompilerGLSL */
204 SPVC_BACKEND_HLSL = 2, /* CompilerHLSL */
205 SPVC_BACKEND_MSL = 3, /* CompilerMSL */
206 SPVC_BACKEND_CPP = 4, /* CompilerCPP */
207 SPVC_BACKEND_JSON = 5, /* CompilerReflection w/ JSON backend */
208 SPVC_BACKEND_INT_MAX = 0x7fffffff
209} spvc_backend;
210
211/* Maps to C++ API. */
212typedef enum spvc_resource_type
213{
214 SPVC_RESOURCE_TYPE_UNKNOWN = 0,
215 SPVC_RESOURCE_TYPE_UNIFORM_BUFFER = 1,
216 SPVC_RESOURCE_TYPE_STORAGE_BUFFER = 2,
217 SPVC_RESOURCE_TYPE_STAGE_INPUT = 3,
218 SPVC_RESOURCE_TYPE_STAGE_OUTPUT = 4,
219 SPVC_RESOURCE_TYPE_SUBPASS_INPUT = 5,
220 SPVC_RESOURCE_TYPE_STORAGE_IMAGE = 6,
221 SPVC_RESOURCE_TYPE_SAMPLED_IMAGE = 7,
222 SPVC_RESOURCE_TYPE_ATOMIC_COUNTER = 8,
223 SPVC_RESOURCE_TYPE_PUSH_CONSTANT = 9,
224 SPVC_RESOURCE_TYPE_SEPARATE_IMAGE = 10,
225 SPVC_RESOURCE_TYPE_SEPARATE_SAMPLERS = 11,
226 SPVC_RESOURCE_TYPE_ACCELERATION_STRUCTURE = 12,
227 SPVC_RESOURCE_TYPE_RAY_QUERY = 13,
228 SPVC_RESOURCE_TYPE_SHADER_RECORD_BUFFER = 14,
229 SPVC_RESOURCE_TYPE_INT_MAX = 0x7fffffff
230} spvc_resource_type;
231
232typedef enum spvc_builtin_resource_type
233{
234 SPVC_BUILTIN_RESOURCE_TYPE_UNKNOWN = 0,
235 SPVC_BUILTIN_RESOURCE_TYPE_STAGE_INPUT = 1,
236 SPVC_BUILTIN_RESOURCE_TYPE_STAGE_OUTPUT = 2,
237 SPVC_BUILTIN_RESOURCE_TYPE_INT_MAX = 0x7fffffff
238} spvc_builtin_resource_type;
239
240/* Maps to spirv_cross::SPIRType::BaseType. */
241typedef enum spvc_basetype
242{
243 SPVC_BASETYPE_UNKNOWN = 0,
244 SPVC_BASETYPE_VOID = 1,
245 SPVC_BASETYPE_BOOLEAN = 2,
246 SPVC_BASETYPE_INT8 = 3,
247 SPVC_BASETYPE_UINT8 = 4,
248 SPVC_BASETYPE_INT16 = 5,
249 SPVC_BASETYPE_UINT16 = 6,
250 SPVC_BASETYPE_INT32 = 7,
251 SPVC_BASETYPE_UINT32 = 8,
252 SPVC_BASETYPE_INT64 = 9,
253 SPVC_BASETYPE_UINT64 = 10,
254 SPVC_BASETYPE_ATOMIC_COUNTER = 11,
255 SPVC_BASETYPE_FP16 = 12,
256 SPVC_BASETYPE_FP32 = 13,
257 SPVC_BASETYPE_FP64 = 14,
258 SPVC_BASETYPE_STRUCT = 15,
259 SPVC_BASETYPE_IMAGE = 16,
260 SPVC_BASETYPE_SAMPLED_IMAGE = 17,
261 SPVC_BASETYPE_SAMPLER = 18,
262 SPVC_BASETYPE_ACCELERATION_STRUCTURE = 19,
263
264 SPVC_BASETYPE_INT_MAX = 0x7fffffff
265} spvc_basetype;
266
267#define SPVC_COMPILER_OPTION_COMMON_BIT 0x1000000
268#define SPVC_COMPILER_OPTION_GLSL_BIT 0x2000000
269#define SPVC_COMPILER_OPTION_HLSL_BIT 0x4000000
270#define SPVC_COMPILER_OPTION_MSL_BIT 0x8000000
271#define SPVC_COMPILER_OPTION_LANG_BITS 0x0f000000
272#define SPVC_COMPILER_OPTION_ENUM_BITS 0xffffff
273
274#define SPVC_MAKE_MSL_VERSION(major, minor, patch) ((major) * 10000 + (minor) * 100 + (patch))
275
276/* Maps to C++ API. */
277typedef enum spvc_msl_platform
278{
279 SPVC_MSL_PLATFORM_IOS = 0,
280 SPVC_MSL_PLATFORM_MACOS = 1,
281 SPVC_MSL_PLATFORM_MAX_INT = 0x7fffffff
282} spvc_msl_platform;
283
284/* Maps to C++ API. */
285typedef enum spvc_msl_index_type
286{
287 SPVC_MSL_INDEX_TYPE_NONE = 0,
288 SPVC_MSL_INDEX_TYPE_UINT16 = 1,
289 SPVC_MSL_INDEX_TYPE_UINT32 = 2,
290 SPVC_MSL_INDEX_TYPE_MAX_INT = 0x7fffffff
291} spvc_msl_index_type;
292
293/* Maps to C++ API. */
294typedef enum spvc_msl_shader_variable_format
295{
296 SPVC_MSL_SHADER_VARIABLE_FORMAT_OTHER = 0,
297 SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT8 = 1,
298 SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT16 = 2,
299 SPVC_MSL_SHADER_VARIABLE_FORMAT_ANY16 = 3,
300 SPVC_MSL_SHADER_VARIABLE_FORMAT_ANY32 = 4,
301
302 /* Deprecated names. */
303 SPVC_MSL_VERTEX_FORMAT_OTHER = SPVC_MSL_SHADER_VARIABLE_FORMAT_OTHER,
304 SPVC_MSL_VERTEX_FORMAT_UINT8 = SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT8,
305 SPVC_MSL_VERTEX_FORMAT_UINT16 = SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT16,
306 SPVC_MSL_SHADER_INPUT_FORMAT_OTHER = SPVC_MSL_SHADER_VARIABLE_FORMAT_OTHER,
307 SPVC_MSL_SHADER_INPUT_FORMAT_UINT8 = SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT8,
308 SPVC_MSL_SHADER_INPUT_FORMAT_UINT16 = SPVC_MSL_SHADER_VARIABLE_FORMAT_UINT16,
309 SPVC_MSL_SHADER_INPUT_FORMAT_ANY16 = SPVC_MSL_SHADER_VARIABLE_FORMAT_ANY16,
310 SPVC_MSL_SHADER_INPUT_FORMAT_ANY32 = SPVC_MSL_SHADER_VARIABLE_FORMAT_ANY32,
311
312
313 SPVC_MSL_SHADER_INPUT_FORMAT_INT_MAX = 0x7fffffff
314} spvc_msl_shader_variable_format, spvc_msl_shader_input_format, spvc_msl_vertex_format;
315
316/* Maps to C++ API. Deprecated; use spvc_msl_shader_interface_var. */
317typedef struct spvc_msl_vertex_attribute
318{
319 unsigned location;
320
321 /* Obsolete, do not use. Only lingers on for ABI compatibility. */
322 unsigned msl_buffer;
323 /* Obsolete, do not use. Only lingers on for ABI compatibility. */
324 unsigned msl_offset;
325 /* Obsolete, do not use. Only lingers on for ABI compatibility. */
326 unsigned msl_stride;
327 /* Obsolete, do not use. Only lingers on for ABI compatibility. */
328 spvc_bool per_instance;
329
330 spvc_msl_vertex_format format;
331 SpvBuiltIn builtin;
332} spvc_msl_vertex_attribute;
333
334/*
335 * Initializes the vertex attribute struct.
336 */
337SPVC_PUBLIC_API void spvc_msl_vertex_attribute_init(spvc_msl_vertex_attribute *attr);
338
339/* Maps to C++ API. Deprecated; use spvc_msl_shader_interface_var_2. */
340typedef struct spvc_msl_shader_interface_var
341{
342 unsigned location;
343 spvc_msl_vertex_format format;
344 SpvBuiltIn builtin;
345 unsigned vecsize;
346} spvc_msl_shader_interface_var, spvc_msl_shader_input;
347
348/*
349 * Initializes the shader input struct.
350 * Deprecated. Use spvc_msl_shader_interface_var_init_2().
351 */
352SPVC_PUBLIC_API void spvc_msl_shader_interface_var_init(spvc_msl_shader_interface_var *var);
353/*
354 * Deprecated. Use spvc_msl_shader_interface_var_init_2().
355 */
356SPVC_PUBLIC_API void spvc_msl_shader_input_init(spvc_msl_shader_input *input);
357
358/* Maps to C++ API. */
359typedef enum spvc_msl_shader_variable_rate
360{
361 SPVC_MSL_SHADER_VARIABLE_RATE_PER_VERTEX = 0,
362 SPVC_MSL_SHADER_VARIABLE_RATE_PER_PRIMITIVE = 1,
363 SPVC_MSL_SHADER_VARIABLE_RATE_PER_PATCH = 2,
364
365 SPVC_MSL_SHADER_VARIABLE_RATE_INT_MAX = 0x7fffffff,
366} spvc_msl_shader_variable_rate;
367
368/* Maps to C++ API. */
369typedef struct spvc_msl_shader_interface_var_2
370{
371 unsigned location;
372 spvc_msl_shader_variable_format format;
373 SpvBuiltIn builtin;
374 unsigned vecsize;
375 spvc_msl_shader_variable_rate rate;
376} spvc_msl_shader_interface_var_2;
377
378/*
379 * Initializes the shader interface variable struct.
380 */
381SPVC_PUBLIC_API void spvc_msl_shader_interface_var_init_2(spvc_msl_shader_interface_var_2 *var);
382
383/* Maps to C++ API. */
384typedef struct spvc_msl_resource_binding
385{
386 SpvExecutionModel stage;
387 unsigned desc_set;
388 unsigned binding;
389 unsigned msl_buffer;
390 unsigned msl_texture;
391 unsigned msl_sampler;
392} spvc_msl_resource_binding;
393
394/*
395 * Initializes the resource binding struct.
396 * The defaults are non-zero.
397 */
398SPVC_PUBLIC_API void spvc_msl_resource_binding_init(spvc_msl_resource_binding *binding);
399
400#define SPVC_MSL_PUSH_CONSTANT_DESC_SET (~(0u))
401#define SPVC_MSL_PUSH_CONSTANT_BINDING (0)
402#define SPVC_MSL_SWIZZLE_BUFFER_BINDING (~(1u))
403#define SPVC_MSL_BUFFER_SIZE_BUFFER_BINDING (~(2u))
404#define SPVC_MSL_ARGUMENT_BUFFER_BINDING (~(3u))
405
406/* Obsolete. Sticks around for backwards compatibility. */
407#define SPVC_MSL_AUX_BUFFER_STRUCT_VERSION 1
408
409/* Runtime check for incompatibility. Obsolete. */
410SPVC_PUBLIC_API unsigned spvc_msl_get_aux_buffer_struct_version(void);
411
412/* Maps to C++ API. */
413typedef enum spvc_msl_sampler_coord
414{
415 SPVC_MSL_SAMPLER_COORD_NORMALIZED = 0,
416 SPVC_MSL_SAMPLER_COORD_PIXEL = 1,
417 SPVC_MSL_SAMPLER_INT_MAX = 0x7fffffff
418} spvc_msl_sampler_coord;
419
420/* Maps to C++ API. */
421typedef enum spvc_msl_sampler_filter
422{
423 SPVC_MSL_SAMPLER_FILTER_NEAREST = 0,
424 SPVC_MSL_SAMPLER_FILTER_LINEAR = 1,
425 SPVC_MSL_SAMPLER_FILTER_INT_MAX = 0x7fffffff
426} spvc_msl_sampler_filter;
427
428/* Maps to C++ API. */
429typedef enum spvc_msl_sampler_mip_filter
430{
431 SPVC_MSL_SAMPLER_MIP_FILTER_NONE = 0,
432 SPVC_MSL_SAMPLER_MIP_FILTER_NEAREST = 1,
433 SPVC_MSL_SAMPLER_MIP_FILTER_LINEAR = 2,
434 SPVC_MSL_SAMPLER_MIP_FILTER_INT_MAX = 0x7fffffff
435} spvc_msl_sampler_mip_filter;
436
437/* Maps to C++ API. */
438typedef enum spvc_msl_sampler_address
439{
440 SPVC_MSL_SAMPLER_ADDRESS_CLAMP_TO_ZERO = 0,
441 SPVC_MSL_SAMPLER_ADDRESS_CLAMP_TO_EDGE = 1,
442 SPVC_MSL_SAMPLER_ADDRESS_CLAMP_TO_BORDER = 2,
443 SPVC_MSL_SAMPLER_ADDRESS_REPEAT = 3,
444 SPVC_MSL_SAMPLER_ADDRESS_MIRRORED_REPEAT = 4,
445 SPVC_MSL_SAMPLER_ADDRESS_INT_MAX = 0x7fffffff
446} spvc_msl_sampler_address;
447
448/* Maps to C++ API. */
449typedef enum spvc_msl_sampler_compare_func
450{
451 SPVC_MSL_SAMPLER_COMPARE_FUNC_NEVER = 0,
452 SPVC_MSL_SAMPLER_COMPARE_FUNC_LESS = 1,
453 SPVC_MSL_SAMPLER_COMPARE_FUNC_LESS_EQUAL = 2,
454 SPVC_MSL_SAMPLER_COMPARE_FUNC_GREATER = 3,
455 SPVC_MSL_SAMPLER_COMPARE_FUNC_GREATER_EQUAL = 4,
456 SPVC_MSL_SAMPLER_COMPARE_FUNC_EQUAL = 5,
457 SPVC_MSL_SAMPLER_COMPARE_FUNC_NOT_EQUAL = 6,
458 SPVC_MSL_SAMPLER_COMPARE_FUNC_ALWAYS = 7,
459 SPVC_MSL_SAMPLER_COMPARE_FUNC_INT_MAX = 0x7fffffff
460} spvc_msl_sampler_compare_func;
461
462/* Maps to C++ API. */
463typedef enum spvc_msl_sampler_border_color
464{
465 SPVC_MSL_SAMPLER_BORDER_COLOR_TRANSPARENT_BLACK = 0,
466 SPVC_MSL_SAMPLER_BORDER_COLOR_OPAQUE_BLACK = 1,
467 SPVC_MSL_SAMPLER_BORDER_COLOR_OPAQUE_WHITE = 2,
468 SPVC_MSL_SAMPLER_BORDER_COLOR_INT_MAX = 0x7fffffff
469} spvc_msl_sampler_border_color;
470
471/* Maps to C++ API. */
472typedef enum spvc_msl_format_resolution
473{
474 SPVC_MSL_FORMAT_RESOLUTION_444 = 0,
475 SPVC_MSL_FORMAT_RESOLUTION_422,
476 SPVC_MSL_FORMAT_RESOLUTION_420,
477 SPVC_MSL_FORMAT_RESOLUTION_INT_MAX = 0x7fffffff
478} spvc_msl_format_resolution;
479
480/* Maps to C++ API. */
481typedef enum spvc_msl_chroma_location
482{
483 SPVC_MSL_CHROMA_LOCATION_COSITED_EVEN = 0,
484 SPVC_MSL_CHROMA_LOCATION_MIDPOINT,
485 SPVC_MSL_CHROMA_LOCATION_INT_MAX = 0x7fffffff
486} spvc_msl_chroma_location;
487
488/* Maps to C++ API. */
489typedef enum spvc_msl_component_swizzle
490{
491 SPVC_MSL_COMPONENT_SWIZZLE_IDENTITY = 0,
492 SPVC_MSL_COMPONENT_SWIZZLE_ZERO,
493 SPVC_MSL_COMPONENT_SWIZZLE_ONE,
494 SPVC_MSL_COMPONENT_SWIZZLE_R,
495 SPVC_MSL_COMPONENT_SWIZZLE_G,
496 SPVC_MSL_COMPONENT_SWIZZLE_B,
497 SPVC_MSL_COMPONENT_SWIZZLE_A,
498 SPVC_MSL_COMPONENT_SWIZZLE_INT_MAX = 0x7fffffff
499} spvc_msl_component_swizzle;
500
501/* Maps to C++ API. */
502typedef enum spvc_msl_sampler_ycbcr_model_conversion
503{
504 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY = 0,
505 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_IDENTITY,
506 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_BT_709,
507 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_BT_601,
508 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_BT_2020,
509 SPVC_MSL_SAMPLER_YCBCR_MODEL_CONVERSION_INT_MAX = 0x7fffffff
510} spvc_msl_sampler_ycbcr_model_conversion;
511
512/* Maps to C+ API. */
513typedef enum spvc_msl_sampler_ycbcr_range
514{
515 SPVC_MSL_SAMPLER_YCBCR_RANGE_ITU_FULL = 0,
516 SPVC_MSL_SAMPLER_YCBCR_RANGE_ITU_NARROW,
517 SPVC_MSL_SAMPLER_YCBCR_RANGE_INT_MAX = 0x7fffffff
518} spvc_msl_sampler_ycbcr_range;
519
520/* Maps to C++ API. */
521typedef struct spvc_msl_constexpr_sampler
522{
523 spvc_msl_sampler_coord coord;
524 spvc_msl_sampler_filter min_filter;
525 spvc_msl_sampler_filter mag_filter;
526 spvc_msl_sampler_mip_filter mip_filter;
527 spvc_msl_sampler_address s_address;
528 spvc_msl_sampler_address t_address;
529 spvc_msl_sampler_address r_address;
530 spvc_msl_sampler_compare_func compare_func;
531 spvc_msl_sampler_border_color border_color;
532 float lod_clamp_min;
533 float lod_clamp_max;
534 int max_anisotropy;
535
536 spvc_bool compare_enable;
537 spvc_bool lod_clamp_enable;
538 spvc_bool anisotropy_enable;
539} spvc_msl_constexpr_sampler;
540
541/*
542 * Initializes the constexpr sampler struct.
543 * The defaults are non-zero.
544 */
545SPVC_PUBLIC_API void spvc_msl_constexpr_sampler_init(spvc_msl_constexpr_sampler *sampler);
546
547/* Maps to the sampler Y'CbCr conversion-related portions of MSLConstexprSampler. See C++ API for defaults and details. */
548typedef struct spvc_msl_sampler_ycbcr_conversion
549{
550 unsigned planes;
551 spvc_msl_format_resolution resolution;
552 spvc_msl_sampler_filter chroma_filter;
553 spvc_msl_chroma_location x_chroma_offset;
554 spvc_msl_chroma_location y_chroma_offset;
555 spvc_msl_component_swizzle swizzle[4];
556 spvc_msl_sampler_ycbcr_model_conversion ycbcr_model;
557 spvc_msl_sampler_ycbcr_range ycbcr_range;
558 unsigned bpc;
559} spvc_msl_sampler_ycbcr_conversion;
560
561/*
562 * Initializes the constexpr sampler struct.
563 * The defaults are non-zero.
564 */
565SPVC_PUBLIC_API void spvc_msl_sampler_ycbcr_conversion_init(spvc_msl_sampler_ycbcr_conversion *conv);
566
567/* Maps to C++ API. */
568typedef enum spvc_hlsl_binding_flag_bits
569{
570 SPVC_HLSL_BINDING_AUTO_NONE_BIT = 0,
571 SPVC_HLSL_BINDING_AUTO_PUSH_CONSTANT_BIT = 1 << 0,
572 SPVC_HLSL_BINDING_AUTO_CBV_BIT = 1 << 1,
573 SPVC_HLSL_BINDING_AUTO_SRV_BIT = 1 << 2,
574 SPVC_HLSL_BINDING_AUTO_UAV_BIT = 1 << 3,
575 SPVC_HLSL_BINDING_AUTO_SAMPLER_BIT = 1 << 4,
576 SPVC_HLSL_BINDING_AUTO_ALL = 0x7fffffff
577} spvc_hlsl_binding_flag_bits;
578typedef unsigned spvc_hlsl_binding_flags;
579
580#define SPVC_HLSL_PUSH_CONSTANT_DESC_SET (~(0u))
581#define SPVC_HLSL_PUSH_CONSTANT_BINDING (0)
582
583/* Maps to C++ API. */
584typedef struct spvc_hlsl_resource_binding_mapping
585{
586 unsigned register_space;
587 unsigned register_binding;
588} spvc_hlsl_resource_binding_mapping;
589
590typedef struct spvc_hlsl_resource_binding
591{
592 SpvExecutionModel stage;
593 unsigned desc_set;
594 unsigned binding;
595
596 spvc_hlsl_resource_binding_mapping cbv, uav, srv, sampler;
597} spvc_hlsl_resource_binding;
598
599/*
600 * Initializes the resource binding struct.
601 * The defaults are non-zero.
602 */
603SPVC_PUBLIC_API void spvc_hlsl_resource_binding_init(spvc_hlsl_resource_binding *binding);
604
605/* Maps to the various spirv_cross::Compiler*::Option structures. See C++ API for defaults and details. */
606typedef enum spvc_compiler_option
607{
608 SPVC_COMPILER_OPTION_UNKNOWN = 0,
609
610 SPVC_COMPILER_OPTION_FORCE_TEMPORARY = 1 | SPVC_COMPILER_OPTION_COMMON_BIT,
611 SPVC_COMPILER_OPTION_FLATTEN_MULTIDIMENSIONAL_ARRAYS = 2 | SPVC_COMPILER_OPTION_COMMON_BIT,
612 SPVC_COMPILER_OPTION_FIXUP_DEPTH_CONVENTION = 3 | SPVC_COMPILER_OPTION_COMMON_BIT,
613 SPVC_COMPILER_OPTION_FLIP_VERTEX_Y = 4 | SPVC_COMPILER_OPTION_COMMON_BIT,
614
615 SPVC_COMPILER_OPTION_GLSL_SUPPORT_NONZERO_BASE_INSTANCE = 5 | SPVC_COMPILER_OPTION_GLSL_BIT,
616 SPVC_COMPILER_OPTION_GLSL_SEPARATE_SHADER_OBJECTS = 6 | SPVC_COMPILER_OPTION_GLSL_BIT,
617 SPVC_COMPILER_OPTION_GLSL_ENABLE_420PACK_EXTENSION = 7 | SPVC_COMPILER_OPTION_GLSL_BIT,
618 SPVC_COMPILER_OPTION_GLSL_VERSION = 8 | SPVC_COMPILER_OPTION_GLSL_BIT,
619 SPVC_COMPILER_OPTION_GLSL_ES = 9 | SPVC_COMPILER_OPTION_GLSL_BIT,
620 SPVC_COMPILER_OPTION_GLSL_VULKAN_SEMANTICS = 10 | SPVC_COMPILER_OPTION_GLSL_BIT,
621 SPVC_COMPILER_OPTION_GLSL_ES_DEFAULT_FLOAT_PRECISION_HIGHP = 11 | SPVC_COMPILER_OPTION_GLSL_BIT,
622 SPVC_COMPILER_OPTION_GLSL_ES_DEFAULT_INT_PRECISION_HIGHP = 12 | SPVC_COMPILER_OPTION_GLSL_BIT,
623
624 SPVC_COMPILER_OPTION_HLSL_SHADER_MODEL = 13 | SPVC_COMPILER_OPTION_HLSL_BIT,
625 SPVC_COMPILER_OPTION_HLSL_POINT_SIZE_COMPAT = 14 | SPVC_COMPILER_OPTION_HLSL_BIT,
626 SPVC_COMPILER_OPTION_HLSL_POINT_COORD_COMPAT = 15 | SPVC_COMPILER_OPTION_HLSL_BIT,
627 SPVC_COMPILER_OPTION_HLSL_SUPPORT_NONZERO_BASE_VERTEX_BASE_INSTANCE = 16 | SPVC_COMPILER_OPTION_HLSL_BIT,
628
629 SPVC_COMPILER_OPTION_MSL_VERSION = 17 | SPVC_COMPILER_OPTION_MSL_BIT,
630 SPVC_COMPILER_OPTION_MSL_TEXEL_BUFFER_TEXTURE_WIDTH = 18 | SPVC_COMPILER_OPTION_MSL_BIT,
631
632 /* Obsolete, use SWIZZLE_BUFFER_INDEX instead. */
633 SPVC_COMPILER_OPTION_MSL_AUX_BUFFER_INDEX = 19 | SPVC_COMPILER_OPTION_MSL_BIT,
634 SPVC_COMPILER_OPTION_MSL_SWIZZLE_BUFFER_INDEX = 19 | SPVC_COMPILER_OPTION_MSL_BIT,
635
636 SPVC_COMPILER_OPTION_MSL_INDIRECT_PARAMS_BUFFER_INDEX = 20 | SPVC_COMPILER_OPTION_MSL_BIT,
637 SPVC_COMPILER_OPTION_MSL_SHADER_OUTPUT_BUFFER_INDEX = 21 | SPVC_COMPILER_OPTION_MSL_BIT,
638 SPVC_COMPILER_OPTION_MSL_SHADER_PATCH_OUTPUT_BUFFER_INDEX = 22 | SPVC_COMPILER_OPTION_MSL_BIT,
639 SPVC_COMPILER_OPTION_MSL_SHADER_TESS_FACTOR_OUTPUT_BUFFER_INDEX = 23 | SPVC_COMPILER_OPTION_MSL_BIT,
640 SPVC_COMPILER_OPTION_MSL_SHADER_INPUT_WORKGROUP_INDEX = 24 | SPVC_COMPILER_OPTION_MSL_BIT,
641 SPVC_COMPILER_OPTION_MSL_ENABLE_POINT_SIZE_BUILTIN = 25 | SPVC_COMPILER_OPTION_MSL_BIT,
642 SPVC_COMPILER_OPTION_MSL_DISABLE_RASTERIZATION = 26 | SPVC_COMPILER_OPTION_MSL_BIT,
643 SPVC_COMPILER_OPTION_MSL_CAPTURE_OUTPUT_TO_BUFFER = 27 | SPVC_COMPILER_OPTION_MSL_BIT,
644 SPVC_COMPILER_OPTION_MSL_SWIZZLE_TEXTURE_SAMPLES = 28 | SPVC_COMPILER_OPTION_MSL_BIT,
645 SPVC_COMPILER_OPTION_MSL_PAD_FRAGMENT_OUTPUT_COMPONENTS = 29 | SPVC_COMPILER_OPTION_MSL_BIT,
646 SPVC_COMPILER_OPTION_MSL_TESS_DOMAIN_ORIGIN_LOWER_LEFT = 30 | SPVC_COMPILER_OPTION_MSL_BIT,
647 SPVC_COMPILER_OPTION_MSL_PLATFORM = 31 | SPVC_COMPILER_OPTION_MSL_BIT,
648 SPVC_COMPILER_OPTION_MSL_ARGUMENT_BUFFERS = 32 | SPVC_COMPILER_OPTION_MSL_BIT,
649
650 SPVC_COMPILER_OPTION_GLSL_EMIT_PUSH_CONSTANT_AS_UNIFORM_BUFFER = 33 | SPVC_COMPILER_OPTION_GLSL_BIT,
651
652 SPVC_COMPILER_OPTION_MSL_TEXTURE_BUFFER_NATIVE = 34 | SPVC_COMPILER_OPTION_MSL_BIT,
653
654 SPVC_COMPILER_OPTION_GLSL_EMIT_UNIFORM_BUFFER_AS_PLAIN_UNIFORMS = 35 | SPVC_COMPILER_OPTION_GLSL_BIT,
655
656 SPVC_COMPILER_OPTION_MSL_BUFFER_SIZE_BUFFER_INDEX = 36 | SPVC_COMPILER_OPTION_MSL_BIT,
657
658 SPVC_COMPILER_OPTION_EMIT_LINE_DIRECTIVES = 37 | SPVC_COMPILER_OPTION_COMMON_BIT,
659
660 SPVC_COMPILER_OPTION_MSL_MULTIVIEW = 38 | SPVC_COMPILER_OPTION_MSL_BIT,
661 SPVC_COMPILER_OPTION_MSL_VIEW_MASK_BUFFER_INDEX = 39 | SPVC_COMPILER_OPTION_MSL_BIT,
662 SPVC_COMPILER_OPTION_MSL_DEVICE_INDEX = 40 | SPVC_COMPILER_OPTION_MSL_BIT,
663 SPVC_COMPILER_OPTION_MSL_VIEW_INDEX_FROM_DEVICE_INDEX = 41 | SPVC_COMPILER_OPTION_MSL_BIT,
664 SPVC_COMPILER_OPTION_MSL_DISPATCH_BASE = 42 | SPVC_COMPILER_OPTION_MSL_BIT,
665 SPVC_COMPILER_OPTION_MSL_DYNAMIC_OFFSETS_BUFFER_INDEX = 43 | SPVC_COMPILER_OPTION_MSL_BIT,
666 SPVC_COMPILER_OPTION_MSL_TEXTURE_1D_AS_2D = 44 | SPVC_COMPILER_OPTION_MSL_BIT,
667 SPVC_COMPILER_OPTION_MSL_ENABLE_BASE_INDEX_ZERO = 45 | SPVC_COMPILER_OPTION_MSL_BIT,
668
669 /* Obsolete. Use MSL_FRAMEBUFFER_FETCH_SUBPASS instead. */
670 SPVC_COMPILER_OPTION_MSL_IOS_FRAMEBUFFER_FETCH_SUBPASS = 46 | SPVC_COMPILER_OPTION_MSL_BIT,
671 SPVC_COMPILER_OPTION_MSL_FRAMEBUFFER_FETCH_SUBPASS = 46 | SPVC_COMPILER_OPTION_MSL_BIT,
672
673 SPVC_COMPILER_OPTION_MSL_INVARIANT_FP_MATH = 47 | SPVC_COMPILER_OPTION_MSL_BIT,
674 SPVC_COMPILER_OPTION_MSL_EMULATE_CUBEMAP_ARRAY = 48 | SPVC_COMPILER_OPTION_MSL_BIT,
675 SPVC_COMPILER_OPTION_MSL_ENABLE_DECORATION_BINDING = 49 | SPVC_COMPILER_OPTION_MSL_BIT,
676 SPVC_COMPILER_OPTION_MSL_FORCE_ACTIVE_ARGUMENT_BUFFER_RESOURCES = 50 | SPVC_COMPILER_OPTION_MSL_BIT,
677 SPVC_COMPILER_OPTION_MSL_FORCE_NATIVE_ARRAYS = 51 | SPVC_COMPILER_OPTION_MSL_BIT,
678
679 SPVC_COMPILER_OPTION_ENABLE_STORAGE_IMAGE_QUALIFIER_DEDUCTION = 52 | SPVC_COMPILER_OPTION_COMMON_BIT,
680
681 SPVC_COMPILER_OPTION_HLSL_FORCE_STORAGE_BUFFER_AS_UAV = 53 | SPVC_COMPILER_OPTION_HLSL_BIT,
682
683 SPVC_COMPILER_OPTION_FORCE_ZERO_INITIALIZED_VARIABLES = 54 | SPVC_COMPILER_OPTION_COMMON_BIT,
684
685 SPVC_COMPILER_OPTION_HLSL_NONWRITABLE_UAV_TEXTURE_AS_SRV = 55 | SPVC_COMPILER_OPTION_HLSL_BIT,
686
687 SPVC_COMPILER_OPTION_MSL_ENABLE_FRAG_OUTPUT_MASK = 56 | SPVC_COMPILER_OPTION_MSL_BIT,
688 SPVC_COMPILER_OPTION_MSL_ENABLE_FRAG_DEPTH_BUILTIN = 57 | SPVC_COMPILER_OPTION_MSL_BIT,
689 SPVC_COMPILER_OPTION_MSL_ENABLE_FRAG_STENCIL_REF_BUILTIN = 58 | SPVC_COMPILER_OPTION_MSL_BIT,
690 SPVC_COMPILER_OPTION_MSL_ENABLE_CLIP_DISTANCE_USER_VARYING = 59 | SPVC_COMPILER_OPTION_MSL_BIT,
691
692 SPVC_COMPILER_OPTION_HLSL_ENABLE_16BIT_TYPES = 60 | SPVC_COMPILER_OPTION_HLSL_BIT,
693
694 SPVC_COMPILER_OPTION_MSL_MULTI_PATCH_WORKGROUP = 61 | SPVC_COMPILER_OPTION_MSL_BIT,
695 SPVC_COMPILER_OPTION_MSL_SHADER_INPUT_BUFFER_INDEX = 62 | SPVC_COMPILER_OPTION_MSL_BIT,
696 SPVC_COMPILER_OPTION_MSL_SHADER_INDEX_BUFFER_INDEX = 63 | SPVC_COMPILER_OPTION_MSL_BIT,
697 SPVC_COMPILER_OPTION_MSL_VERTEX_FOR_TESSELLATION = 64 | SPVC_COMPILER_OPTION_MSL_BIT,
698 SPVC_COMPILER_OPTION_MSL_VERTEX_INDEX_TYPE = 65 | SPVC_COMPILER_OPTION_MSL_BIT,
699
700 SPVC_COMPILER_OPTION_GLSL_FORCE_FLATTENED_IO_BLOCKS = 66 | SPVC_COMPILER_OPTION_GLSL_BIT,
701
702 SPVC_COMPILER_OPTION_MSL_MULTIVIEW_LAYERED_RENDERING = 67 | SPVC_COMPILER_OPTION_MSL_BIT,
703 SPVC_COMPILER_OPTION_MSL_ARRAYED_SUBPASS_INPUT = 68 | SPVC_COMPILER_OPTION_MSL_BIT,
704 SPVC_COMPILER_OPTION_MSL_R32UI_LINEAR_TEXTURE_ALIGNMENT = 69 | SPVC_COMPILER_OPTION_MSL_BIT,
705 SPVC_COMPILER_OPTION_MSL_R32UI_ALIGNMENT_CONSTANT_ID = 70 | SPVC_COMPILER_OPTION_MSL_BIT,
706
707 SPVC_COMPILER_OPTION_HLSL_FLATTEN_MATRIX_VERTEX_INPUT_SEMANTICS = 71 | SPVC_COMPILER_OPTION_HLSL_BIT,
708
709 SPVC_COMPILER_OPTION_MSL_IOS_USE_SIMDGROUP_FUNCTIONS = 72 | SPVC_COMPILER_OPTION_MSL_BIT,
710 SPVC_COMPILER_OPTION_MSL_EMULATE_SUBGROUPS = 73 | SPVC_COMPILER_OPTION_MSL_BIT,
711 SPVC_COMPILER_OPTION_MSL_FIXED_SUBGROUP_SIZE = 74 | SPVC_COMPILER_OPTION_MSL_BIT,
712 SPVC_COMPILER_OPTION_MSL_FORCE_SAMPLE_RATE_SHADING = 75 | SPVC_COMPILER_OPTION_MSL_BIT,
713 SPVC_COMPILER_OPTION_MSL_IOS_SUPPORT_BASE_VERTEX_INSTANCE = 76 | SPVC_COMPILER_OPTION_MSL_BIT,
714
715 SPVC_COMPILER_OPTION_GLSL_OVR_MULTIVIEW_VIEW_COUNT = 77 | SPVC_COMPILER_OPTION_GLSL_BIT,
716
717 SPVC_COMPILER_OPTION_RELAX_NAN_CHECKS = 78 | SPVC_COMPILER_OPTION_COMMON_BIT,
718
719 SPVC_COMPILER_OPTION_MSL_RAW_BUFFER_TESE_INPUT = 79 | SPVC_COMPILER_OPTION_MSL_BIT,
720 SPVC_COMPILER_OPTION_MSL_SHADER_PATCH_INPUT_BUFFER_INDEX = 80 | SPVC_COMPILER_OPTION_MSL_BIT,
721 SPVC_COMPILER_OPTION_MSL_MANUAL_HELPER_INVOCATION_UPDATES = 81 | SPVC_COMPILER_OPTION_MSL_BIT,
722 SPVC_COMPILER_OPTION_MSL_CHECK_DISCARDED_FRAG_STORES = 82 | SPVC_COMPILER_OPTION_MSL_BIT,
723
724 SPVC_COMPILER_OPTION_GLSL_ENABLE_ROW_MAJOR_LOAD_WORKAROUND = 83 | SPVC_COMPILER_OPTION_GLSL_BIT,
725
726 SPVC_COMPILER_OPTION_MSL_ARGUMENT_BUFFERS_TIER = 84 | SPVC_COMPILER_OPTION_MSL_BIT,
727 SPVC_COMPILER_OPTION_MSL_SAMPLE_DREF_LOD_ARRAY_AS_GRAD = 85 | SPVC_COMPILER_OPTION_MSL_BIT,
728 SPVC_COMPILER_OPTION_MSL_READWRITE_TEXTURE_FENCES = 86 | SPVC_COMPILER_OPTION_MSL_BIT,
729 SPVC_COMPILER_OPTION_MSL_REPLACE_RECURSIVE_INPUTS = 87 | SPVC_COMPILER_OPTION_MSL_BIT,
730 SPVC_COMPILER_OPTION_MSL_AGX_MANUAL_CUBE_GRAD_FIXUP = 88 | SPVC_COMPILER_OPTION_MSL_BIT,
731 SPVC_COMPILER_OPTION_MSL_FORCE_FRAGMENT_WITH_SIDE_EFFECTS_EXECUTION = 89 | SPVC_COMPILER_OPTION_MSL_BIT,
732
733 SPVC_COMPILER_OPTION_INT_MAX = 0x7fffffff
734} spvc_compiler_option;
735
736/*
737 * Context is the highest-level API construct.
738 * The context owns all memory allocations made by its child object hierarchy, including various non-opaque structs and strings.
739 * This means that the API user only has to care about one "destroy" call ever when using the C API.
740 * All pointers handed out by the APIs are only valid as long as the context
741 * is alive and spvc_context_release_allocations has not been called.
742 */
743SPVC_PUBLIC_API spvc_result spvc_context_create(spvc_context *context);
744
745/* Frees all memory allocations and objects associated with the context and its child objects. */
746SPVC_PUBLIC_API void spvc_context_destroy(spvc_context context);
747
748/* Frees all memory allocations and objects associated with the context and its child objects, but keeps the context alive. */
749SPVC_PUBLIC_API void spvc_context_release_allocations(spvc_context context);
750
751/* Get the string for the last error which was logged. */
752SPVC_PUBLIC_API const char *spvc_context_get_last_error_string(spvc_context context);
753
754/* Get notified in a callback when an error triggers. Useful for debugging. */
755typedef void (*spvc_error_callback)(void *userdata, const char *error);
756SPVC_PUBLIC_API void spvc_context_set_error_callback(spvc_context context, spvc_error_callback cb, void *userdata);
757
758/* SPIR-V parsing interface. Maps to Parser which then creates a ParsedIR, and that IR is extracted into the handle. */
759SPVC_PUBLIC_API spvc_result spvc_context_parse_spirv(spvc_context context, const SpvId *spirv, size_t word_count,
760 spvc_parsed_ir *parsed_ir);
761
762/*
763 * Create a compiler backend. Capture mode controls if we construct by copy or move semantics.
764 * It is always recommended to use SPVC_CAPTURE_MODE_TAKE_OWNERSHIP if you only intend to cross-compile the IR once.
765 */
766SPVC_PUBLIC_API spvc_result spvc_context_create_compiler(spvc_context context, spvc_backend backend,
767 spvc_parsed_ir parsed_ir, spvc_capture_mode mode,
768 spvc_compiler *compiler);
769
770/* Maps directly to C++ API. */
771SPVC_PUBLIC_API unsigned spvc_compiler_get_current_id_bound(spvc_compiler compiler);
772
773/* Create compiler options, which will initialize defaults. */
774SPVC_PUBLIC_API spvc_result spvc_compiler_create_compiler_options(spvc_compiler compiler,
775 spvc_compiler_options *options);
776/* Override options. Will return error if e.g. MSL options are used for the HLSL backend, etc. */
777SPVC_PUBLIC_API spvc_result spvc_compiler_options_set_bool(spvc_compiler_options options,
778 spvc_compiler_option option, spvc_bool value);
779SPVC_PUBLIC_API spvc_result spvc_compiler_options_set_uint(spvc_compiler_options options,
780 spvc_compiler_option option, unsigned value);
781/* Set compiler options. */
782SPVC_PUBLIC_API spvc_result spvc_compiler_install_compiler_options(spvc_compiler compiler,
783 spvc_compiler_options options);
784
785/* Compile IR into a string. *source is owned by the context, and caller must not free it themselves. */
786SPVC_PUBLIC_API spvc_result spvc_compiler_compile(spvc_compiler compiler, const char **source);
787
788/* Maps to C++ API. */
789SPVC_PUBLIC_API spvc_result spvc_compiler_add_header_line(spvc_compiler compiler, const char *line);
790SPVC_PUBLIC_API spvc_result spvc_compiler_require_extension(spvc_compiler compiler, const char *ext);
791SPVC_PUBLIC_API size_t spvc_compiler_get_num_required_extensions(spvc_compiler compiler);
792SPVC_PUBLIC_API const char *spvc_compiler_get_required_extension(spvc_compiler compiler, size_t index);
793SPVC_PUBLIC_API spvc_result spvc_compiler_flatten_buffer_block(spvc_compiler compiler, spvc_variable_id id);
794
795SPVC_PUBLIC_API spvc_bool spvc_compiler_variable_is_depth_or_compare(spvc_compiler compiler, spvc_variable_id id);
796
797SPVC_PUBLIC_API spvc_result spvc_compiler_mask_stage_output_by_location(spvc_compiler compiler,
798 unsigned location, unsigned component);
799SPVC_PUBLIC_API spvc_result spvc_compiler_mask_stage_output_by_builtin(spvc_compiler compiler, SpvBuiltIn builtin);
800
801/*
802 * HLSL specifics.
803 * Maps to C++ API.
804 */
805SPVC_PUBLIC_API spvc_result spvc_compiler_hlsl_set_root_constants_layout(spvc_compiler compiler,
806 const spvc_hlsl_root_constants *constant_info,
807 size_t count);
808SPVC_PUBLIC_API spvc_result spvc_compiler_hlsl_add_vertex_attribute_remap(spvc_compiler compiler,
809 const spvc_hlsl_vertex_attribute_remap *remap,
810 size_t remaps);
811SPVC_PUBLIC_API spvc_variable_id spvc_compiler_hlsl_remap_num_workgroups_builtin(spvc_compiler compiler);
812
813SPVC_PUBLIC_API spvc_result spvc_compiler_hlsl_set_resource_binding_flags(spvc_compiler compiler,
814 spvc_hlsl_binding_flags flags);
815
816SPVC_PUBLIC_API spvc_result spvc_compiler_hlsl_add_resource_binding(spvc_compiler compiler,
817 const spvc_hlsl_resource_binding *binding);
818SPVC_PUBLIC_API spvc_bool spvc_compiler_hlsl_is_resource_used(spvc_compiler compiler,
819 SpvExecutionModel model,
820 unsigned set,
821 unsigned binding);
822
823/*
824 * MSL specifics.
825 * Maps to C++ API.
826 */
827SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_is_rasterization_disabled(spvc_compiler compiler);
828
829/* Obsolete. Renamed to needs_swizzle_buffer. */
830SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_aux_buffer(spvc_compiler compiler);
831SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_swizzle_buffer(spvc_compiler compiler);
832SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_buffer_size_buffer(spvc_compiler compiler);
833
834SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_output_buffer(spvc_compiler compiler);
835SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_patch_output_buffer(spvc_compiler compiler);
836SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_needs_input_threadgroup_mem(spvc_compiler compiler);
837SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_vertex_attribute(spvc_compiler compiler,
838 const spvc_msl_vertex_attribute *attrs);
839SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_resource_binding(spvc_compiler compiler,
840 const spvc_msl_resource_binding *binding);
841/* Deprecated; use spvc_compiler_msl_add_shader_input_2(). */
842SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_shader_input(spvc_compiler compiler,
843 const spvc_msl_shader_interface_var *input);
844SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_shader_input_2(spvc_compiler compiler,
845 const spvc_msl_shader_interface_var_2 *input);
846/* Deprecated; use spvc_compiler_msl_add_shader_output_2(). */
847SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_shader_output(spvc_compiler compiler,
848 const spvc_msl_shader_interface_var *output);
849SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_shader_output_2(spvc_compiler compiler,
850 const spvc_msl_shader_interface_var_2 *output);
851SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_discrete_descriptor_set(spvc_compiler compiler, unsigned desc_set);
852SPVC_PUBLIC_API spvc_result spvc_compiler_msl_set_argument_buffer_device_address_space(spvc_compiler compiler, unsigned desc_set, spvc_bool device_address);
853
854/* Obsolete, use is_shader_input_used. */
855SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_is_vertex_attribute_used(spvc_compiler compiler, unsigned location);
856SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_is_shader_input_used(spvc_compiler compiler, unsigned location);
857SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_is_shader_output_used(spvc_compiler compiler, unsigned location);
858
859SPVC_PUBLIC_API spvc_bool spvc_compiler_msl_is_resource_used(spvc_compiler compiler,
860 SpvExecutionModel model,
861 unsigned set,
862 unsigned binding);
863SPVC_PUBLIC_API spvc_result spvc_compiler_msl_remap_constexpr_sampler(spvc_compiler compiler, spvc_variable_id id, const spvc_msl_constexpr_sampler *sampler);
864SPVC_PUBLIC_API spvc_result spvc_compiler_msl_remap_constexpr_sampler_by_binding(spvc_compiler compiler, unsigned desc_set, unsigned binding, const spvc_msl_constexpr_sampler *sampler);
865SPVC_PUBLIC_API spvc_result spvc_compiler_msl_remap_constexpr_sampler_ycbcr(spvc_compiler compiler, spvc_variable_id id, const spvc_msl_constexpr_sampler *sampler, const spvc_msl_sampler_ycbcr_conversion *conv);
866SPVC_PUBLIC_API spvc_result spvc_compiler_msl_remap_constexpr_sampler_by_binding_ycbcr(spvc_compiler compiler, unsigned desc_set, unsigned binding, const spvc_msl_constexpr_sampler *sampler, const spvc_msl_sampler_ycbcr_conversion *conv);
867SPVC_PUBLIC_API spvc_result spvc_compiler_msl_set_fragment_output_components(spvc_compiler compiler, unsigned location, unsigned components);
868
869SPVC_PUBLIC_API unsigned spvc_compiler_msl_get_automatic_resource_binding(spvc_compiler compiler, spvc_variable_id id);
870SPVC_PUBLIC_API unsigned spvc_compiler_msl_get_automatic_resource_binding_secondary(spvc_compiler compiler, spvc_variable_id id);
871
872SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_dynamic_buffer(spvc_compiler compiler, unsigned desc_set, unsigned binding, unsigned index);
873
874SPVC_PUBLIC_API spvc_result spvc_compiler_msl_add_inline_uniform_block(spvc_compiler compiler, unsigned desc_set, unsigned binding);
875
876SPVC_PUBLIC_API spvc_result spvc_compiler_msl_set_combined_sampler_suffix(spvc_compiler compiler, const char *suffix);
877SPVC_PUBLIC_API const char *spvc_compiler_msl_get_combined_sampler_suffix(spvc_compiler compiler);
878
879/*
880 * Reflect resources.
881 * Maps almost 1:1 to C++ API.
882 */
883SPVC_PUBLIC_API spvc_result spvc_compiler_get_active_interface_variables(spvc_compiler compiler, spvc_set *set);
884SPVC_PUBLIC_API spvc_result spvc_compiler_set_enabled_interface_variables(spvc_compiler compiler, spvc_set set);
885SPVC_PUBLIC_API spvc_result spvc_compiler_create_shader_resources(spvc_compiler compiler, spvc_resources *resources);
886SPVC_PUBLIC_API spvc_result spvc_compiler_create_shader_resources_for_active_variables(spvc_compiler compiler,
887 spvc_resources *resources,
888 spvc_set active);
889SPVC_PUBLIC_API spvc_result spvc_resources_get_resource_list_for_type(spvc_resources resources, spvc_resource_type type,
890 const spvc_reflected_resource **resource_list,
891 size_t *resource_size);
892
893SPVC_PUBLIC_API spvc_result spvc_resources_get_builtin_resource_list_for_type(
894 spvc_resources resources, spvc_builtin_resource_type type,
895 const spvc_reflected_builtin_resource **resource_list,
896 size_t *resource_size);
897
898/*
899 * Decorations.
900 * Maps to C++ API.
901 */
902SPVC_PUBLIC_API void spvc_compiler_set_decoration(spvc_compiler compiler, SpvId id, SpvDecoration decoration,
903 unsigned argument);
904SPVC_PUBLIC_API void spvc_compiler_set_decoration_string(spvc_compiler compiler, SpvId id, SpvDecoration decoration,
905 const char *argument);
906SPVC_PUBLIC_API void spvc_compiler_set_name(spvc_compiler compiler, SpvId id, const char *argument);
907SPVC_PUBLIC_API void spvc_compiler_set_member_decoration(spvc_compiler compiler, spvc_type_id id, unsigned member_index,
908 SpvDecoration decoration, unsigned argument);
909SPVC_PUBLIC_API void spvc_compiler_set_member_decoration_string(spvc_compiler compiler, spvc_type_id id,
910 unsigned member_index, SpvDecoration decoration,
911 const char *argument);
912SPVC_PUBLIC_API void spvc_compiler_set_member_name(spvc_compiler compiler, spvc_type_id id, unsigned member_index,
913 const char *argument);
914SPVC_PUBLIC_API void spvc_compiler_unset_decoration(spvc_compiler compiler, SpvId id, SpvDecoration decoration);
915SPVC_PUBLIC_API void spvc_compiler_unset_member_decoration(spvc_compiler compiler, spvc_type_id id,
916 unsigned member_index, SpvDecoration decoration);
917
918SPVC_PUBLIC_API spvc_bool spvc_compiler_has_decoration(spvc_compiler compiler, SpvId id, SpvDecoration decoration);
919SPVC_PUBLIC_API spvc_bool spvc_compiler_has_member_decoration(spvc_compiler compiler, spvc_type_id id,
920 unsigned member_index, SpvDecoration decoration);
921SPVC_PUBLIC_API const char *spvc_compiler_get_name(spvc_compiler compiler, SpvId id);
922SPVC_PUBLIC_API unsigned spvc_compiler_get_decoration(spvc_compiler compiler, SpvId id, SpvDecoration decoration);
923SPVC_PUBLIC_API const char *spvc_compiler_get_decoration_string(spvc_compiler compiler, SpvId id,
924 SpvDecoration decoration);
925SPVC_PUBLIC_API unsigned spvc_compiler_get_member_decoration(spvc_compiler compiler, spvc_type_id id,
926 unsigned member_index, SpvDecoration decoration);
927SPVC_PUBLIC_API const char *spvc_compiler_get_member_decoration_string(spvc_compiler compiler, spvc_type_id id,
928 unsigned member_index, SpvDecoration decoration);
929SPVC_PUBLIC_API const char *spvc_compiler_get_member_name(spvc_compiler compiler, spvc_type_id id, unsigned member_index);
930
931/*
932 * Entry points.
933 * Maps to C++ API.
934 */
935SPVC_PUBLIC_API spvc_result spvc_compiler_get_entry_points(spvc_compiler compiler,
936 const spvc_entry_point **entry_points,
937 size_t *num_entry_points);
938SPVC_PUBLIC_API spvc_result spvc_compiler_set_entry_point(spvc_compiler compiler, const char *name,
939 SpvExecutionModel model);
940SPVC_PUBLIC_API spvc_result spvc_compiler_rename_entry_point(spvc_compiler compiler, const char *old_name,
941 const char *new_name, SpvExecutionModel model);
942SPVC_PUBLIC_API const char *spvc_compiler_get_cleansed_entry_point_name(spvc_compiler compiler, const char *name,
943 SpvExecutionModel model);
944SPVC_PUBLIC_API void spvc_compiler_set_execution_mode(spvc_compiler compiler, SpvExecutionMode mode);
945SPVC_PUBLIC_API void spvc_compiler_unset_execution_mode(spvc_compiler compiler, SpvExecutionMode mode);
946SPVC_PUBLIC_API void spvc_compiler_set_execution_mode_with_arguments(spvc_compiler compiler, SpvExecutionMode mode,
947 unsigned arg0, unsigned arg1, unsigned arg2);
948SPVC_PUBLIC_API spvc_result spvc_compiler_get_execution_modes(spvc_compiler compiler, const SpvExecutionMode **modes,
949 size_t *num_modes);
950SPVC_PUBLIC_API unsigned spvc_compiler_get_execution_mode_argument(spvc_compiler compiler, SpvExecutionMode mode);
951SPVC_PUBLIC_API unsigned spvc_compiler_get_execution_mode_argument_by_index(spvc_compiler compiler,
952 SpvExecutionMode mode, unsigned index);
953SPVC_PUBLIC_API SpvExecutionModel spvc_compiler_get_execution_model(spvc_compiler compiler);
954SPVC_PUBLIC_API void spvc_compiler_update_active_builtins(spvc_compiler compiler);
955SPVC_PUBLIC_API spvc_bool spvc_compiler_has_active_builtin(spvc_compiler compiler, SpvBuiltIn builtin, SpvStorageClass storage);
956
957/*
958 * Type query interface.
959 * Maps to C++ API, except it's read-only.
960 */
961SPVC_PUBLIC_API spvc_type spvc_compiler_get_type_handle(spvc_compiler compiler, spvc_type_id id);
962
963/* Pulls out SPIRType::self. This effectively gives the type ID without array or pointer qualifiers.
964 * This is necessary when reflecting decoration/name information on members of a struct,
965 * which are placed in the base type, not the qualified type.
966 * This is similar to spvc_reflected_resource::base_type_id. */
967SPVC_PUBLIC_API spvc_type_id spvc_type_get_base_type_id(spvc_type type);
968
969SPVC_PUBLIC_API spvc_basetype spvc_type_get_basetype(spvc_type type);
970SPVC_PUBLIC_API unsigned spvc_type_get_bit_width(spvc_type type);
971SPVC_PUBLIC_API unsigned spvc_type_get_vector_size(spvc_type type);
972SPVC_PUBLIC_API unsigned spvc_type_get_columns(spvc_type type);
973SPVC_PUBLIC_API unsigned spvc_type_get_num_array_dimensions(spvc_type type);
974SPVC_PUBLIC_API spvc_bool spvc_type_array_dimension_is_literal(spvc_type type, unsigned dimension);
975SPVC_PUBLIC_API SpvId spvc_type_get_array_dimension(spvc_type type, unsigned dimension);
976SPVC_PUBLIC_API unsigned spvc_type_get_num_member_types(spvc_type type);
977SPVC_PUBLIC_API spvc_type_id spvc_type_get_member_type(spvc_type type, unsigned index);
978SPVC_PUBLIC_API SpvStorageClass spvc_type_get_storage_class(spvc_type type);
979
980/* Image type query. */
981SPVC_PUBLIC_API spvc_type_id spvc_type_get_image_sampled_type(spvc_type type);
982SPVC_PUBLIC_API SpvDim spvc_type_get_image_dimension(spvc_type type);
983SPVC_PUBLIC_API spvc_bool spvc_type_get_image_is_depth(spvc_type type);
984SPVC_PUBLIC_API spvc_bool spvc_type_get_image_arrayed(spvc_type type);
985SPVC_PUBLIC_API spvc_bool spvc_type_get_image_multisampled(spvc_type type);
986SPVC_PUBLIC_API spvc_bool spvc_type_get_image_is_storage(spvc_type type);
987SPVC_PUBLIC_API SpvImageFormat spvc_type_get_image_storage_format(spvc_type type);
988SPVC_PUBLIC_API SpvAccessQualifier spvc_type_get_image_access_qualifier(spvc_type type);
989
990/*
991 * Buffer layout query.
992 * Maps to C++ API.
993 */
994SPVC_PUBLIC_API spvc_result spvc_compiler_get_declared_struct_size(spvc_compiler compiler, spvc_type struct_type, size_t *size);
995SPVC_PUBLIC_API spvc_result spvc_compiler_get_declared_struct_size_runtime_array(spvc_compiler compiler,
996 spvc_type struct_type, size_t array_size, size_t *size);
997SPVC_PUBLIC_API spvc_result spvc_compiler_get_declared_struct_member_size(spvc_compiler compiler, spvc_type type, unsigned index, size_t *size);
998
999SPVC_PUBLIC_API spvc_result spvc_compiler_type_struct_member_offset(spvc_compiler compiler,
1000 spvc_type type, unsigned index, unsigned *offset);
1001SPVC_PUBLIC_API spvc_result spvc_compiler_type_struct_member_array_stride(spvc_compiler compiler,
1002 spvc_type type, unsigned index, unsigned *stride);
1003SPVC_PUBLIC_API spvc_result spvc_compiler_type_struct_member_matrix_stride(spvc_compiler compiler,
1004 spvc_type type, unsigned index, unsigned *stride);
1005
1006/*
1007 * Workaround helper functions.
1008 * Maps to C++ API.
1009 */
1010SPVC_PUBLIC_API spvc_result spvc_compiler_build_dummy_sampler_for_combined_images(spvc_compiler compiler, spvc_variable_id *id);
1011SPVC_PUBLIC_API spvc_result spvc_compiler_build_combined_image_samplers(spvc_compiler compiler);
1012SPVC_PUBLIC_API spvc_result spvc_compiler_get_combined_image_samplers(spvc_compiler compiler,
1013 const spvc_combined_image_sampler **samplers,
1014 size_t *num_samplers);
1015
1016/*
1017 * Constants
1018 * Maps to C++ API.
1019 */
1020SPVC_PUBLIC_API spvc_result spvc_compiler_get_specialization_constants(spvc_compiler compiler,
1021 const spvc_specialization_constant **constants,
1022 size_t *num_constants);
1023SPVC_PUBLIC_API spvc_constant spvc_compiler_get_constant_handle(spvc_compiler compiler,
1024 spvc_constant_id id);
1025
1026SPVC_PUBLIC_API spvc_constant_id spvc_compiler_get_work_group_size_specialization_constants(spvc_compiler compiler,
1027 spvc_specialization_constant *x,
1028 spvc_specialization_constant *y,
1029 spvc_specialization_constant *z);
1030
1031/*
1032 * Buffer ranges
1033 * Maps to C++ API.
1034 */
1035SPVC_PUBLIC_API spvc_result spvc_compiler_get_active_buffer_ranges(spvc_compiler compiler,
1036 spvc_variable_id id,
1037 const spvc_buffer_range **ranges,
1038 size_t *num_ranges);
1039
1040/*
1041 * No stdint.h until C99, sigh :(
1042 * For smaller types, the result is sign or zero-extended as appropriate.
1043 * Maps to C++ API.
1044 * TODO: The SPIRConstant query interface and modification interface is not quite complete.
1045 */
1046SPVC_PUBLIC_API float spvc_constant_get_scalar_fp16(spvc_constant constant, unsigned column, unsigned row);
1047SPVC_PUBLIC_API float spvc_constant_get_scalar_fp32(spvc_constant constant, unsigned column, unsigned row);
1048SPVC_PUBLIC_API double spvc_constant_get_scalar_fp64(spvc_constant constant, unsigned column, unsigned row);
1049SPVC_PUBLIC_API unsigned spvc_constant_get_scalar_u32(spvc_constant constant, unsigned column, unsigned row);
1050SPVC_PUBLIC_API int spvc_constant_get_scalar_i32(spvc_constant constant, unsigned column, unsigned row);
1051SPVC_PUBLIC_API unsigned spvc_constant_get_scalar_u16(spvc_constant constant, unsigned column, unsigned row);
1052SPVC_PUBLIC_API int spvc_constant_get_scalar_i16(spvc_constant constant, unsigned column, unsigned row);
1053SPVC_PUBLIC_API unsigned spvc_constant_get_scalar_u8(spvc_constant constant, unsigned column, unsigned row);
1054SPVC_PUBLIC_API int spvc_constant_get_scalar_i8(spvc_constant constant, unsigned column, unsigned row);
1055SPVC_PUBLIC_API void spvc_constant_get_subconstants(spvc_constant constant, const spvc_constant_id **constituents, size_t *count);
1056SPVC_PUBLIC_API unsigned long long spvc_constant_get_scalar_u64(spvc_constant constant, unsigned column, unsigned row);
1057SPVC_PUBLIC_API long long spvc_constant_get_scalar_i64(spvc_constant constant, unsigned column, unsigned row);
1058SPVC_PUBLIC_API spvc_type_id spvc_constant_get_type(spvc_constant constant);
1059
1060/*
1061 * C implementation of the C++ api.
1062 */
1063SPVC_PUBLIC_API void spvc_constant_set_scalar_fp16(spvc_constant constant, unsigned column, unsigned row, unsigned short value);
1064SPVC_PUBLIC_API void spvc_constant_set_scalar_fp32(spvc_constant constant, unsigned column, unsigned row, float value);
1065SPVC_PUBLIC_API void spvc_constant_set_scalar_fp64(spvc_constant constant, unsigned column, unsigned row, double value);
1066SPVC_PUBLIC_API void spvc_constant_set_scalar_u32(spvc_constant constant, unsigned column, unsigned row, unsigned value);
1067SPVC_PUBLIC_API void spvc_constant_set_scalar_i32(spvc_constant constant, unsigned column, unsigned row, int value);
1068SPVC_PUBLIC_API void spvc_constant_set_scalar_u64(spvc_constant constant, unsigned column, unsigned row, unsigned long long value);
1069SPVC_PUBLIC_API void spvc_constant_set_scalar_i64(spvc_constant constant, unsigned column, unsigned row, long long value);
1070SPVC_PUBLIC_API void spvc_constant_set_scalar_u16(spvc_constant constant, unsigned column, unsigned row, unsigned short value);
1071SPVC_PUBLIC_API void spvc_constant_set_scalar_i16(spvc_constant constant, unsigned column, unsigned row, signed short value);
1072SPVC_PUBLIC_API void spvc_constant_set_scalar_u8(spvc_constant constant, unsigned column, unsigned row, unsigned char value);
1073SPVC_PUBLIC_API void spvc_constant_set_scalar_i8(spvc_constant constant, unsigned column, unsigned row, signed char value);
1074
1075/*
1076 * Misc reflection
1077 * Maps to C++ API.
1078 */
1079SPVC_PUBLIC_API spvc_bool spvc_compiler_get_binary_offset_for_decoration(spvc_compiler compiler,
1080 spvc_variable_id id,
1081 SpvDecoration decoration,
1082 unsigned *word_offset);
1083
1084SPVC_PUBLIC_API spvc_bool spvc_compiler_buffer_is_hlsl_counter_buffer(spvc_compiler compiler, spvc_variable_id id);
1085SPVC_PUBLIC_API spvc_bool spvc_compiler_buffer_get_hlsl_counter_buffer(spvc_compiler compiler, spvc_variable_id id,
1086 spvc_variable_id *counter_id);
1087
1088SPVC_PUBLIC_API spvc_result spvc_compiler_get_declared_capabilities(spvc_compiler compiler,
1089 const SpvCapability **capabilities,
1090 size_t *num_capabilities);
1091SPVC_PUBLIC_API spvc_result spvc_compiler_get_declared_extensions(spvc_compiler compiler, const char ***extensions,
1092 size_t *num_extensions);
1093
1094SPVC_PUBLIC_API const char *spvc_compiler_get_remapped_declared_block_name(spvc_compiler compiler, spvc_variable_id id);
1095SPVC_PUBLIC_API spvc_result spvc_compiler_get_buffer_block_decorations(spvc_compiler compiler, spvc_variable_id id,
1096 const SpvDecoration **decorations,
1097 size_t *num_decorations);
1098
1099#ifdef __cplusplus
1100}
1101#endif
1102#endif
1103

source code of qtshadertools/src/3rdparty/SPIRV-Cross/spirv_cross_c.h