shader-slang

Rust bindings for the Slang shader language compiler

Supports both the modern compilation and reflection API.

Currently mostly reflects the needs of our own engine but contributions are more than welcome.

Example

let global_session = slang::GlobalSession::new().unwrap();

let search_path = std::ffi::CString::new("shaders/directory").unwrap();

// All compiler options are available through this builder.
let session_options = slang::CompilerOptions::default()
	.optimization(slang::OptimizationLevel::High)
	.matrix_layout_row(true);

let target_desc = slang::TargetDesc::default()
	.format(slang::CompileTarget::Spirv)
	.profile(global_session.find_profile("glsl_450"));

let targets = [target_desc];
let search_paths = [search_path.as_ptr()];

let session_desc = slang::SessionDesc::default()
	.targets(&targets)
	.search_paths(&search_paths)
	.options(&session_options);

let session = global_session.create_session(&session_desc).unwrap();
let module = session.load_module("filename.slang").unwrap();
let entry_point = module.find_entry_point_by_name("main").unwrap();

let program = session.create_composite_component_type(&[
	module.downcast().clone(), entry_point.downcast().clone(),
]).unwrap();

let linked_program = program.link().unwrap();

// Entry point to the reflection API.
let reflection = linked_program.layout(0).unwrap();

let shader_bytecode = linked_program.entry_point_code(0, 0).unwrap();

Installation

Add shader-slang to the [dependencies] section of your Cargo.toml.

Point this library to a Slang installation. An easy way is by installing the LunarG Vulkan SDK which comes bundled with the Slang compiler. During installation VULKAN_SDK is added to the PATH and automatically picked up by this library.

Alternatively, download Slang from their releases page and manually set the SLANG_DIR environment variable to the path of your Slang directory. Copy slang.dll to your executable's directory. To compile to DXIL bytecode, also copy dxil.dll and dxcompiler.dll from the Microsoft DirectXShaderCompiler to your executable's directory.

To specify the include and lib directories separately, set the SLANG_INCLUDE_DIR and SLANG_LIB_DIR environment variables.

Credits

Maintained by Lauro Oyen (@laurooyen).

Licensed under MIT or Apache-2.0.