rspirv/
lib.rs

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
//! Library APIs for SPIR-V module processing functionalities.
//!
//! This library provides:
//!
//! * The whole SPIR-V [grammar](grammar/index.html) (instruction layouts
//!   and their operands)
//! * A [data representation](dr/index.html) of SPIR-V modules and its
//!   loader and builder
//! * A [structured representation](sr/index.html) of SPIR-V modules
//!   (under developing)
//! * SPIR-V [binary](binary/index.html) module decoding and parsing
//!   functionalities
//!
//! The data representation (DR) focuses on presenting the data within a
//! SPIR-V module; it uses plain vectors to hold data of SPIR-V instructions,
//! following the instructions' layouts defined in the grammar. DR has little
//! structure; only bare structures need for representing modules, functions,
//! and blocks are adopted.
//!
//! The structured representation (SR) focuses on presenting the structure
//! within a SPIR-V module; it tries to links as much information as possible.
//! Types, values, instructions, decorations and so on have their dedicated
//! structs. The purpose of SR is to facilitate SPIR-V analysis and
//! transformations.
//!
//! # Examples
//!
//! Building a SPIR-V module, assembling it, parsing it, and then
//! disassembling it:
//!
//! ```
//! use rspirv::binary::Assemble;
//! use rspirv::binary::Disassemble;
//!
//! // Building
//! let mut b = rspirv::dr::Builder::new();
//! b.memory_model(spirv::AddressingModel::Logical, spirv::MemoryModel::GLSL450);
//! let void = b.type_void();
//! let voidf = b.type_function(void, vec![void]);
//! b.begin_function(void,
//!                  None,
//!                  (spirv::FunctionControl::DONT_INLINE |
//!                   spirv::FunctionControl::CONST),
//!                  voidf)
//!  .unwrap();
//! b.begin_block(None).unwrap();
//! b.ret().unwrap();
//! b.end_function().unwrap();
//! let module = b.module();
//!
//! // Assembling
//! let code = module.assemble();
//! assert!(code.len() > 20);  // Module header contains 5 words
//! assert_eq!(spirv::MAGIC_NUMBER, code[0]);
//!
//! // Parsing
//! let mut loader = rspirv::dr::Loader::new();
//! rspirv::binary::parse_words(&code, &mut loader).unwrap();
//! let module = loader.module();
//!
//! // Disassembling
//! assert_eq!(module.disassemble(),
//!            "; SPIR-V\n\
//!             ; Version: 1.6\n\
//!             ; Generator: rspirv\n\
//!             ; Bound: 5\n\
//!             OpMemoryModel Logical GLSL450\n\
//!             %1 = OpTypeVoid\n\
//!             %2 = OpTypeFunction %1 %1\n\
//!             %3 = OpFunction  %1  DontInline|Const %2\n\
//!             %4 = OpLabel\n\
//!             OpReturn\n\
//!             OpFunctionEnd");
//! ```

pub use spirv;

pub mod binary;
pub mod dr;
pub mod grammar;
pub mod lift;
pub mod sr;

mod utils;