Crate spirvcross

source ·
Expand description

spirv-cross

High and low level bindigns to the SPIRV-Cross API

Example

use spirvcross::{
    bytes_to_words,
    compiler::{glsl::GlslCompiler, Compiler},
    Result,
    Context,
};

fn compile(bytes: &[u8]) -> Result<()> {
    let words = bytes_to_words(bytes).unwrap();

    let mut context = Context::new()?;
    context.set_error_callback(|err| eprintln!("{}", err.to_string_lossy()));

    let compiler = GlslCompiler::new(&mut context, &words)?
        .vulkan_semantics(true)?;

    println!("{}", compiler.compile()?);
    return Ok(());
}

Supported Targets

  • Linux
  • macOS
  • Windows
  • WebAssembly (WASI)
    • Compiling to WebAssembly from a Windows machine currently doesn’t work.

Modules

  • compiler
    Implementations for the various supported compilers.
  • sys
    Raw bindings to the C API.

Structs

  • Context
    Manager of SPIRV-Cross resources
  • Error
    A SPIRV-Cross API error, alongside it’s error message.

Constants

  • SPVC_VERSION
    Semantic version of the underlying SPIRV-Cross API

Traits

  • Compiler
    A SPIRV-Cross compiler to an unkown target.

Functions

  • bytes_to_words
    Converts a byte slice into a word slice, avoiding a new allocation if possible.

Type Aliases