1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
|
#include <algorithm>
#include <cassert>
#include "common.h"
#include "sample_spv.h"
#if defined(SPIRV_REFLECT_HAS_VULKAN_H)
#include <vulkan/vulkan.h>
// Returns the size in bytes of the provided VkFormat.
// As this is only intended for vertex attribute formats, not all VkFormats are
// supported.
static uint32_t FormatSize(VkFormat format) {
uint32_t result = 0;
switch (format) {
case VK_FORMAT_UNDEFINED:
result = 0;
break;
case VK_FORMAT_R4G4_UNORM_PACK8:
result = 1;
break;
case VK_FORMAT_R4G4B4A4_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_B4G4R4A4_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_R5G6B5_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_B5G6R5_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_R5G5B5A1_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_B5G5R5A1_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_A1R5G5B5_UNORM_PACK16:
result = 2;
break;
case VK_FORMAT_R8_UNORM:
result = 1;
break;
case VK_FORMAT_R8_SNORM:
result = 1;
break;
case VK_FORMAT_R8_USCALED:
result = 1;
break;
case VK_FORMAT_R8_SSCALED:
result = 1;
break;
case VK_FORMAT_R8_UINT:
result = 1;
break;
case VK_FORMAT_R8_SINT:
result = 1;
break;
case VK_FORMAT_R8_SRGB:
result = 1;
break;
case VK_FORMAT_R8G8_UNORM:
result = 2;
break;
case VK_FORMAT_R8G8_SNORM:
result = 2;
break;
case VK_FORMAT_R8G8_USCALED:
result = 2;
break;
case VK_FORMAT_R8G8_SSCALED:
result = 2;
break;
case VK_FORMAT_R8G8_UINT:
result = 2;
break;
case VK_FORMAT_R8G8_SINT:
result = 2;
break;
case VK_FORMAT_R8G8_SRGB:
result = 2;
break;
case VK_FORMAT_R8G8B8_UNORM:
result = 3;
break;
case VK_FORMAT_R8G8B8_SNORM:
result = 3;
break;
case VK_FORMAT_R8G8B8_USCALED:
result = 3;
break;
case VK_FORMAT_R8G8B8_SSCALED:
result = 3;
break;
case VK_FORMAT_R8G8B8_UINT:
result = 3;
break;
case VK_FORMAT_R8G8B8_SINT:
result = 3;
break;
case VK_FORMAT_R8G8B8_SRGB:
result = 3;
break;
case VK_FORMAT_B8G8R8_UNORM:
result = 3;
break;
case VK_FORMAT_B8G8R8_SNORM:
result = 3;
break;
case VK_FORMAT_B8G8R8_USCALED:
result = 3;
break;
case VK_FORMAT_B8G8R8_SSCALED:
result = 3;
break;
case VK_FORMAT_B8G8R8_UINT:
result = 3;
break;
case VK_FORMAT_B8G8R8_SINT:
result = 3;
break;
case VK_FORMAT_B8G8R8_SRGB:
result = 3;
break;
case VK_FORMAT_R8G8B8A8_UNORM:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_SNORM:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_USCALED:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_SSCALED:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_UINT:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_SINT:
result = 4;
break;
case VK_FORMAT_R8G8B8A8_SRGB:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_UNORM:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_SNORM:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_USCALED:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_SSCALED:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_UINT:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_SINT:
result = 4;
break;
case VK_FORMAT_B8G8R8A8_SRGB:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_UNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_SNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_USCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_SSCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_UINT_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_SINT_PACK32:
result = 4;
break;
case VK_FORMAT_A8B8G8R8_SRGB_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_UNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_SNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_USCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_SSCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_UINT_PACK32:
result = 4;
break;
case VK_FORMAT_A2R10G10B10_SINT_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_UNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_SNORM_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_USCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_SSCALED_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_UINT_PACK32:
result = 4;
break;
case VK_FORMAT_A2B10G10R10_SINT_PACK32:
result = 4;
break;
case VK_FORMAT_R16_UNORM:
result = 2;
break;
case VK_FORMAT_R16_SNORM:
result = 2;
break;
case VK_FORMAT_R16_USCALED:
result = 2;
break;
case VK_FORMAT_R16_SSCALED:
result = 2;
break;
case VK_FORMAT_R16_UINT:
result = 2;
break;
case VK_FORMAT_R16_SINT:
result = 2;
break;
case VK_FORMAT_R16_SFLOAT:
result = 2;
break;
case VK_FORMAT_R16G16_UNORM:
result = 4;
break;
case VK_FORMAT_R16G16_SNORM:
result = 4;
break;
case VK_FORMAT_R16G16_USCALED:
result = 4;
break;
case VK_FORMAT_R16G16_SSCALED:
result = 4;
break;
case VK_FORMAT_R16G16_UINT:
result = 4;
break;
case VK_FORMAT_R16G16_SINT:
result = 4;
break;
case VK_FORMAT_R16G16_SFLOAT:
result = 4;
break;
case VK_FORMAT_R16G16B16_UNORM:
result = 6;
break;
case VK_FORMAT_R16G16B16_SNORM:
result = 6;
break;
case VK_FORMAT_R16G16B16_USCALED:
result = 6;
break;
case VK_FORMAT_R16G16B16_SSCALED:
result = 6;
break;
case VK_FORMAT_R16G16B16_UINT:
result = 6;
break;
case VK_FORMAT_R16G16B16_SINT:
result = 6;
break;
case VK_FORMAT_R16G16B16_SFLOAT:
result = 6;
break;
case VK_FORMAT_R16G16B16A16_UNORM:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_SNORM:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_USCALED:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_SSCALED:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_UINT:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_SINT:
result = 8;
break;
case VK_FORMAT_R16G16B16A16_SFLOAT:
result = 8;
break;
case VK_FORMAT_R32_UINT:
result = 4;
break;
case VK_FORMAT_R32_SINT:
result = 4;
break;
case VK_FORMAT_R32_SFLOAT:
result = 4;
break;
case VK_FORMAT_R32G32_UINT:
result = 8;
break;
case VK_FORMAT_R32G32_SINT:
result = 8;
break;
case VK_FORMAT_R32G32_SFLOAT:
result = 8;
break;
case VK_FORMAT_R32G32B32_UINT:
result = 12;
break;
case VK_FORMAT_R32G32B32_SINT:
result = 12;
break;
case VK_FORMAT_R32G32B32_SFLOAT:
result = 12;
break;
case VK_FORMAT_R32G32B32A32_UINT:
result = 16;
break;
case VK_FORMAT_R32G32B32A32_SINT:
result = 16;
break;
case VK_FORMAT_R32G32B32A32_SFLOAT:
result = 16;
break;
case VK_FORMAT_R64_UINT:
result = 8;
break;
case VK_FORMAT_R64_SINT:
result = 8;
break;
case VK_FORMAT_R64_SFLOAT:
result = 8;
break;
case VK_FORMAT_R64G64_UINT:
result = 16;
break;
case VK_FORMAT_R64G64_SINT:
result = 16;
break;
case VK_FORMAT_R64G64_SFLOAT:
result = 16;
break;
case VK_FORMAT_R64G64B64_UINT:
result = 24;
break;
case VK_FORMAT_R64G64B64_SINT:
result = 24;
break;
case VK_FORMAT_R64G64B64_SFLOAT:
result = 24;
break;
case VK_FORMAT_R64G64B64A64_UINT:
result = 32;
break;
case VK_FORMAT_R64G64B64A64_SINT:
result = 32;
break;
case VK_FORMAT_R64G64B64A64_SFLOAT:
result = 32;
break;
case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
result = 4;
break;
case VK_FORMAT_E5B9G9R9_UFLOAT_PACK32:
result = 4;
break;
default:
break;
}
return result;
}
#endif
int main(int argn, char** argv) {
SpvReflectShaderModule module = {};
SpvReflectResult result = spvReflectCreateShaderModule(sizeof(k_sample_spv), k_sample_spv, &module);
assert(result == SPV_REFLECT_RESULT_SUCCESS);
uint32_t count = 0;
result = spvReflectEnumerateInputVariables(&module, &count, NULL);
assert(result == SPV_REFLECT_RESULT_SUCCESS);
std::vector<SpvReflectInterfaceVariable*> input_vars(count);
result = spvReflectEnumerateInputVariables(&module, &count, input_vars.data());
assert(result == SPV_REFLECT_RESULT_SUCCESS);
count = 0;
result = spvReflectEnumerateOutputVariables(&module, &count, NULL);
assert(result == SPV_REFLECT_RESULT_SUCCESS);
std::vector<SpvReflectInterfaceVariable*> output_vars(count);
result = spvReflectEnumerateOutputVariables(&module, &count, output_vars.data());
assert(result == SPV_REFLECT_RESULT_SUCCESS);
#if defined(SPIRV_REFLECT_HAS_VULKAN_H)
if (module.shader_stage == SPV_REFLECT_SHADER_STAGE_VERTEX_BIT) {
// Demonstrates how to generate all necessary data structures to populate
// a VkPipelineVertexInputStateCreateInfo structure, given the module's
// expected input variables.
//
// Simplifying assumptions:
// - All vertex input attributes are sourced from a single vertex buffer,
// bound to VB slot 0.
// - Each vertex's attribute are laid out in ascending order by location.
// - The format of each attribute matches its usage in the shader;
// float4 -> VK_FORMAT_R32G32B32A32_FLOAT, etc. No attribute compression
// is applied.
// - All attributes are provided per-vertex, not per-instance.
VkVertexInputBindingDescription binding_description = {};
binding_description.binding = 0;
binding_description.stride = 0; // computed below
binding_description.inputRate = VK_VERTEX_INPUT_RATE_VERTEX;
VkPipelineVertexInputStateCreateInfo vertex_input_state_create_info = {
VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO};
std::vector<VkVertexInputAttributeDescription> attribute_descriptions;
attribute_descriptions.reserve(input_vars.size());
for (size_t i_var = 0; i_var < input_vars.size(); ++i_var) {
const SpvReflectInterfaceVariable& refl_var = *(input_vars[i_var]);
// ignore built-in variables
if (refl_var.decoration_flags & SPV_REFLECT_DECORATION_BUILT_IN) {
continue;
}
VkVertexInputAttributeDescription attr_desc{};
attr_desc.location = refl_var.location;
attr_desc.binding = binding_description.binding;
attr_desc.format = static_cast<VkFormat>(refl_var.format);
attr_desc.offset = 0; // final offset computed below after sorting.
attribute_descriptions.push_back(attr_desc);
}
// Sort attributes by location
std::sort(std::begin(attribute_descriptions), std::end(attribute_descriptions),
[](const VkVertexInputAttributeDescription& a, const VkVertexInputAttributeDescription& b) {
return a.location < b.location;
});
// Compute final offsets of each attribute, and total vertex stride.
for (auto& attribute : attribute_descriptions) {
uint32_t format_size = FormatSize(attribute.format);
attribute.offset = binding_description.stride;
binding_description.stride += format_size;
}
// Nothing further is done with attribute_descriptions or
// binding_description in this sample. A real application would probably
// derive this information from its mesh format(s); a similar mechanism
// could be used to ensure mesh/shader compatibility.
}
#endif
// Log the interface variables to stdout
const char* t = " ";
const char* tt = " ";
PrintModuleInfo(std::cout, module);
std::cout << "\n\n";
std::cout << "Input variables:"
<< "\n";
for (size_t index = 0; index < input_vars.size(); ++index) {
auto p_var = input_vars[index];
// input variables can also be retrieved directly from the module, by
// location (unless the location is (uint32_t)-1, as is the case with
// built-in inputs)
auto p_var2 = spvReflectGetInputVariableByLocation(&module, p_var->location, &result);
if (p_var->location == UINT32_MAX) {
assert(result == SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
assert(p_var2 == nullptr);
} else {
assert(result == SPV_REFLECT_RESULT_SUCCESS);
assert(p_var == p_var2);
}
(void)p_var2;
// input variables can also be retrieved directly from the module, by
// semantic (if present)
p_var2 = spvReflectGetInputVariableBySemantic(&module, p_var->semantic, &result);
if (!p_var->semantic) {
assert(result == SPV_REFLECT_RESULT_ERROR_NULL_POINTER);
assert(p_var2 == nullptr);
} else if (p_var->semantic[0] != '\0') {
assert(result == SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
assert(p_var2 == nullptr);
} else {
assert(result == SPV_REFLECT_RESULT_SUCCESS);
assert(p_var == p_var2);
}
(void)p_var2;
std::cout << t << index << ":"
<< "\n";
PrintInterfaceVariable(std::cout, module.source_language, *p_var, tt);
std::cout << "\n\n";
}
std::cout << "Output variables:"
<< "\n";
for (size_t index = 0; index < output_vars.size(); ++index) {
auto p_var = output_vars[index];
// output variables can also be retrieved directly from the module, by
// location (unless the location is (uint32_t)-1, as is the case with
// built-in outputs)
auto p_var2 = spvReflectGetOutputVariableByLocation(&module, p_var->location, &result);
if (p_var->location == UINT32_MAX) {
assert(result == SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
assert(p_var2 == nullptr);
} else {
assert(result == SPV_REFLECT_RESULT_SUCCESS);
assert(p_var == p_var2);
}
(void)p_var2;
// output variables can also be retrieved directly from the module, by
// semantic (if present)
p_var2 = spvReflectGetOutputVariableBySemantic(&module, p_var->semantic, &result);
if (!p_var->semantic) {
assert(result == SPV_REFLECT_RESULT_ERROR_NULL_POINTER);
assert(p_var2 == nullptr);
} else if (p_var->semantic[0] != '\0') {
assert(result == SPV_REFLECT_RESULT_ERROR_ELEMENT_NOT_FOUND);
assert(p_var2 == nullptr);
} else {
assert(result == SPV_REFLECT_RESULT_SUCCESS);
assert(p_var == p_var2);
}
(void)p_var2;
std::cout << t << index << ":"
<< "\n";
PrintInterfaceVariable(std::cout, module.source_language, *p_var, tt);
std::cout << "\n\n";
}
spvReflectDestroyShaderModule(&module);
return 0;
}
|