31 releases

0.6.1 Oct 3, 2022
0.5.1 Apr 21, 2022
0.5.0 Feb 13, 2022
0.4.18 Nov 23, 2021
0.1.0 Dec 28, 2019

#45 in Graphics APIs

Download history 22/week @ 2022-08-15 86/week @ 2022-08-22 27/week @ 2022-08-29 54/week @ 2022-09-05 40/week @ 2022-09-12 21/week @ 2022-09-19 91/week @ 2022-09-26 147/week @ 2022-10-03 73/week @ 2022-10-10 42/week @ 2022-10-17 50/week @ 2022-10-24 90/week @ 2022-10-31 57/week @ 2022-11-07 48/week @ 2022-11-14 35/week @ 2022-11-21 109/week @ 2022-11-28

254 downloads per month
Used in fewer than 6 crates

MIT/Apache

150KB
3.5K SLoC

SPIR-Q

Build Status Crate Documentation

SPIR-Q is a light weight library for SPIR-V pipeline metadata query, supporting upto SPIR-V 1.5 specification aligned with Vulkan 1.2.

Why SPIR-Q?

Back in days of OpenGL, we have glGetActiveUniformsiv and other APIs to get pipeline metadata, so that we can determine the sizes, names, array strides and other information dynamically at runtime. However, the next-gen API, Vulkan, was deisgned not to support shader reflection so that the driver can be kept as thin as possible. SPIR-Q is an attempt to fill this gap.

SPIR-Q can be very useful for scenarios where we want some dynamic in pipeline construction, so that we don't have to refill those redundantly long VkXxxCreateInfos all the time. It can also be used to automate filler code generation at compile time.

It should be noted that SPIR-V is targeting at Vulkan so OpenCL binaries are not supported.

Usage

use spirq::*;
let entry_points = ReflectConfig::new()
    // Load SPIR-V data into `[u32]` buffer `spv_words`.
    .spv(spv_words)
    // Set this true if you want to reflect all resources no matter it's
    // used by an entry point or not.
    .ref_all_rscs(true)
    // Combine sampled image and separated sampler states if they are bound
    // to the same binding point.
    .combine_img_samplers(true)
    // Generate unique names for types and struct fields to help further
    // processing of the reflection data. Otherwise, the debug names are
    // assigned.
    .gen_unique_names(true)
    // Specialize the constant at `SpecID=3` with unsigned integer 7. The
    // constants specialized here won't be listed in the result entry point's
    // variable list.
    .specialize(3, ConstantValue::U32(7))
    // Do the work.
    .reflect()
    .unwrap();
// All extracted entry point data are available in `entry_points` now.

Please also refer to the attached examples:

  • walk: Enumerate offsets, symbols and types of all descriptor variables.
  • inspect: Customize shader reflection with your own inspector function.
  • gallery: All data types in GLSL.

Sample output are attached in the same directories as the code files.

License

This project is licensed under either of

at your option.

Dependencies

~0.5–1MB
~22K SLoC