librashader-reflect 0.12.0

RetroArch shaders for all.
Documentation 
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

use crate::reflect::semantics::UniformMemberBlock;
use thiserror::Error;

/// Error type for shader compilation.
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum ShaderCompileError {
    /// Compile error from naga.
    #[cfg(feature = "naga-in")]
    #[error("error when parsing wgsl: {0}")]
    NagaCompileError(#[from] naga::front::wgsl::ParseError),

    /// Compilation error from glslang.
    #[cfg(feature = "glslang-in")]
    #[error("error when compiling with glslang: {0}")]
    GlslangError(#[from] glslang::error::GlslangError),

    /// Error when initializing the glslang compiler.
    #[cfg(feature = "glslang-in")]
    #[error("error when initializing glslang")]
    CompilerInitError,

    /// Error when transpiling from spirv-cross.
    #[cfg(feature = "cross")]
    #[error("spirv-cross error: {0:?}")]
    SpirvCrossCompileError(#[from] spirv_cross2::SpirvCrossError),

    /// Error when transpiling from spirv-to-dxil
    #[cfg(all(target_os = "windows", feature = "dxil"))]
    #[error("spirv-to-dxil error: {0:?}")]
    SpirvToDxilCompileError(#[from] spirv_to_dxil::SpirvToDxilError),

    /// Error when transpiling from naga
    #[cfg(all(feature = "wgsl", feature = "naga"))]
    #[error("naga error when compiling wgsl: {0:?}")]
    NagaWgslError(#[from] naga::back::wgsl::Error),

    /// Error when transpiling from naga
    #[cfg(feature = "naga")]
    #[error("naga error when compiling spirv: {0:?}")]
    NagaSpvError(#[from] naga::back::spv::Error),

    /// Error when transpiling from naga
    #[cfg(all(feature = "naga", feature = "msl"))]
    #[error("naga error when compiling msl: {0:?}")]
    NagaMslError(#[from] naga::back::msl::Error),

    /// Error when transpiling from naga
    #[cfg(any(feature = "naga", feature = "wgsl"))]
    #[error("naga validation error: {0}")]
    NagaValidationError(#[from] naga::WithSpan<naga::valid::ValidationError>),
}

/// The error kind encountered when reflecting shader semantics.
#[derive(Debug)]
pub enum SemanticsErrorKind {
    /// The number of uniform buffers was invalid. Only one UBO is permitted.
    InvalidUniformBufferCount(usize),
    /// The number of push constant blocks was invalid. Only one push constant block is permitted.
    InvalidPushBufferCount(usize),
    /// The size of the push constant block was invalid.
    InvalidPushBufferSize(u32),
    /// The location of a varying was invalid.
    InvalidLocation(u32),
    /// The requested descriptor set was invalid. Only descriptor set 0 is available.
    InvalidDescriptorSet(u32),
    /// The number of inputs to the shader was invalid.
    InvalidInputCount(usize),
    /// The number of outputs declared was invalid.
    InvalidOutputCount(usize),
    /// Expected a binding but there was none.
    MissingBinding,
    /// The declared binding point was invalid.
    InvalidBinding(u32),
    /// The declared resource type was invalid.
    InvalidResourceType,
    /// The range of a struct member was invalid.
    InvalidRange(u32),
    /// The number of entry points in the shader was invalid.
    InvalidEntryPointCount(usize),
    /// The requested uniform or texture name was not provided semantics.
    UnknownSemantics(String),
    /// The type of the requested uniform was not compatible with the provided semantics.
    InvalidTypeForSemantic(String),
}

/// Error type for shader reflection.
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum ShaderReflectError {
    /// Reflection error from spirv-cross.
    #[cfg(feature = "cross")]
    #[error("spirv cross error: {0}")]
    SpirvCrossError(#[from] spirv_cross2::SpirvCrossError),
    /// Error when validating vertex shader semantics.
    #[error("error when verifying vertex semantics: {0:?}")]
    VertexSemanticError(SemanticsErrorKind),
    /// Error when validating fragment shader semantics.
    #[error("error when verifying texture semantics {0:?}")]
    FragmentSemanticError(SemanticsErrorKind),
    /// The vertex and fragment shader must have the same UBO binding location.
    #[error("vertex and fragment shader must have same UBO binding. declared {vertex} in vertex, got {fragment} in fragment")]
    MismatchedUniformBuffer { vertex: u32, fragment: u32 },
    /// The filter chain was found to be non causal. A pass tried to access the target output
    /// in the future.
    #[error("filter chain is non causal: tried to access target {target} in pass {pass}")]
    NonCausalFilterChain { pass: usize, target: usize },
    /// The offset of the given uniform did not match up in both the vertex and fragment shader.
    #[error("the offset of {semantic} was declared as {expected} but found as {received} in pass {pass}")]
    MismatchedOffset {
        semantic: String,
        expected: usize,
        received: usize,
        ty: UniformMemberBlock,
        pass: usize,
    },
    /// The size of the given uniform did not match up in both the vertex and fragment shader.
    #[error("the size of {semantic} was found declared as {vertex} in vertex shader but found as {fragment} in fragment in pass {pass}")]
    MismatchedSize {
        semantic: String,
        vertex: u32,
        fragment: u32,
        pass: usize,
    },
    /// The binding number is already in use.
    #[error("binding {0} is already in use")]
    BindingInUse(u32),
    /// Error when transpiling from naga
    #[cfg(feature = "naga")]
    #[error("naga spirv error: {0}")]
    NagaInputError(#[from] naga::front::spv::Error),
    /// Error when transpiling from naga
    #[cfg(feature = "naga")]
    #[error("naga validation error: {0}")]
    NagaReflectError(#[from] naga::WithSpan<naga::valid::ValidationError>),
}