glsl-include 0.2.2

A library for expanding #include directives in GLSL source strings

glsl-include   Build Status Build Status-win Latest Version Rustc Version 1.15+

glsl-include is a rust library for expanding #include directives in GLSL source strings


Quick Start

Cargo.toml:

[dependencies]
glsl-include = "0.2"

main.rs:

extern crate glsl_include;
use glsl_include::Context;

fn main () {
    let main = r"
        #version 410
        #include <platform.glsl>
        #include <common.glsl>
        out vec4 fragColor;
        void main () {
            fragColor = vec4(1.0);
        }";
    let platform = "void platform_fn() {}";
    let common = "uniform float iTime;";
    let (expanded_src, source_map) = Context::new()
        .include("platform.glsl", platform)
        .include("common.glsl",common)
        .expand_to_string(main).unwrap();
}

Benchmarks

Benchmarking makes use of the optional criterion dependency, which depends on rust 1.23

cargo bench --features "criterion"

The workflow I currently use for benchmarking a changeset:

git checkout master; cargo bench --features "criterion"
git checkout feature-branch; cargo bench --features "criterion"

For the best results with criterion, install gnuplot (macos: brew install gnuplot)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.