PENGUINLIONG / spirq-rs

Light weight SPIR-V reflection library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

spirq

Crate Documentation

spirq is a shader reflection tool to help you process SPIR-V binary and assembly for Vulkan. You can use spirq to query host-shader interfaces including descriptor bindings, pipeline inputs and outputs, specialization constants.

You can also use the commandline (CLI) tool shader-reflect to use spirq without programming in Rust.

Note: spirq- family of crates have been moved to spq.

Usage

See the crate level readme for detail.

What's different from other crates?

Compared with spirq, rspirv has more strict requirements on SPIR-V physical layout, which makes it impossible to process bad test cases for other projects. spirv-reflect is a broadly used reflection tool and it's a wrapper crate of Khronos' official SPIRV-Reflect tool. SPIRV-Reflect, however, was developed in pretty early days and it has some legacy bad designs (like a limit of 16 descriptors). SPIRV-Tools provides Khronos' official assembler and disassembler, while it's hard to be integrated to other Rust projects.

On the other hand, the tools in spirq are more tolerant of the input quality. They don't check the semantics strictly to the spec. They won't stop processing unless there is a fatal structural problem making the input totally indecipherable. As a result, you might have to be familiar with the SPIR-V specification so that it serves you well, if you are developing other tools based on spirq.

License

This project is licensed under either of

at your option.

About

Light weight SPIR-V reflection library

License:Apache License 2.0


Languages

Language:Rust 90.6%Language:GLSL 8.8%Language:PowerShell 0.6%