Module librashader::reflect

Available on crate feature reflect only.

Shader reflection and cross-compilation.

The type_alias_impl_trait nightly feature is required. You should choose your target shading language, and a compilation type.

#![feature(type_alias_impl_trait)]

use std::error::Error;
use librashader::preprocess::ShaderSource;
use librashader::presets::ShaderPreset;
use librashader::reflect::{CompileReflectShader, FromCompilation, CompilePresetTarget, ShaderPassArtifact};
use librashader::reflect::targets::SPIRV;
use librashader::reflect::semantics::ShaderSemantics;
use librashader_reflect::front::{ShaderInputCompiler, SpirvCompilation};
use librashader_reflect::reflect::cross::SpirvCross;
type Artifact = impl CompileReflectShader<SPIRV, SpirvCompilation, SpirvCross>;
type ShaderPassMeta = ShaderPassArtifact<Artifact>;

// Compile single shader
pub fn compile_spirv(
        source: &ShaderSource,
    ) -> Result<Artifact, Box<dyn Error>>
{
    let compilation = SpirvCompilation::compile(&source)?;
    let spirv = SPIRV::from_compilation(compilation)?;
    Ok(spirv)
}

// Compile preset
pub fn compile_preset(preset: ShaderPreset) -> Result<(Vec<ShaderPassMeta>, ShaderSemantics), Box<dyn Error>>
{
    let (passes, semantics) = SPIRV::compile_preset_passes::<SpirvCompilation, SpirvCross, Box<dyn Error>>(
    preset.shaders, &preset.textures)?;
    Ok((passes, semantics))
}

What’s with all the traits?

librashader-reflect is designed to be compiler-agnostic. In the future, we will allow usage of naga, a pure-Rust shader compiler, when it has matured enough to support the features librashader needs.

In the meanwhile, the only supported input compiler is SpirvCompilation, which does compilation of GLSL to SPIR-V via glslang.

Modules

• crossreflect-cross
  Reflection via SPIRV-Cross.
• dxilWindows and reflect-dxil
  DXIL reflection via spirv-to-dxil.
• nagareflect-naga
  Reflection via Naga
• semantics
  Shader semantics and reflection information.
• targets
  Supported shader compiler targets.

Structs

• BindingMeta
  Reflection metadata about the various bindings for this shader.
• CompilerBackend
  A wrapper for a compiler backend.
• ShaderCompilerOutput
  The output of the shader compiler.
• ShaderReflection
  Reflection information about a shader.
• SpirvCompilation
  A reflectable shader compilation via glslang.

Enums

• SemanticsErrorKind
  The error kind encountered when reflecting shader semantics.
• ShaderCompileError
  Error type for shader compilation.
• ShaderReflectError
  Error type for shader reflection.

Traits

• CompilePresetTarget
  Trait for target shading languages that can compile output with shader preset metdata.
• CompileReflectShader
  Marker trait for combinations of targets and compilations that can be reflected and compiled successfully.
• CompileShader
  A trait for objects that can be compiled into a shader.
• FromCompilation
  A trait for reflectable compilations that can be transformed into an object ready for reflection or compilation.
• OutputTarget
  Marker trait for shader compiler targets.
• ReflectShader
  A trait for compilation outputs that can provide reflection information.
• ShaderInputCompiler
  Trait for types that can compile shader sources into a compilation unit.
• ShaderReflectObject
  The output of a shader compiler that is reflectable.

Type Aliases

• ShaderPassArtifact
  Artifacts of a reflected and compiled shader pass.