[−][src]Crate shaderc
Rust binding for the shaderc library.
The shaderc library provides an API for compiling GLSL/HLSL source code to SPIRV modules. It has been shipping in the Android NDK since version r12b.
This library uses build.rs
to automatically check out
and compile a copy of native C++ shaderc and link to the generated
artifacts, which requires git
, cmake
, and python
existing in the
PATH
.
To turn off this feature, specify --no-default-features
when building.
But then you will need to place a copy of the shaderc_combined
static
library to the location (printed out in the warning message) that is
scanned by the linker.
The build script also tries to check whether Ninja
is available on PATH
. If true, Ninja is used to compile native C++
shaderc. It is generally faster that way, and it does not suffer from the
MAX_PATH
limitation that MSBuild, the default for building using MSVC,
has.
Examples
Compile a shader into SPIR-V binary module and assembly text:
use shaderc; let source = "#version 310 es\n void EP() {}"; let mut compiler = shaderc::Compiler::new().unwrap(); let mut options = shaderc::CompileOptions::new().unwrap(); options.add_macro_definition("EP", Some("main")); let binary_result = compiler.compile_into_spirv( source, shaderc::ShaderKind::Vertex, "shader.glsl", "main", Some(&options)).unwrap(); assert_eq!(Some(&0x07230203), binary_result.as_binary().first()); let text_result = compiler.compile_into_spirv_assembly( source, shaderc::ShaderKind::Vertex, "shader.glsl", "main", Some(&options)).unwrap(); assert!(text_result.as_text().starts_with("; SPIR-V\n"));
Structs
CompilationArtifact | An opaque object containing the results of compilation. |
CompileOptions | An opaque object managing options to compilation. |
Compiler | An opaque object managing all compiler states. |
ResolvedInclude | A representation of a successfully resolved include directive, containing the name of the include and its contents. |
Enums
Error | Error. |
GlslProfile | GLSL profile. |
IncludeType | Identifies the type of include directive. |
Limit | Resource limit. |
OptimizationLevel | Optimization level. |
ResourceKind | Resource kinds. |
ShaderKind | Shader kind. |
SourceLanguage | Source language. |
TargetEnv | Target environment. |
Functions
get_spirv_version | Returns the version and revision of the SPIR-V generated by this library. |
parse_version_profile | Parses the version and profile from the given |
Type Definitions
Result | Compilation status. |