glsl-include 0.2.2

A library for expanding #include directives in GLSL source strings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# glsl-include   [![Build Status]][travis] [![Build Status-win]][appveyor] [![Latest Version]][crates.io] [![Rustc Version 1.15+]][rustc]

[Build Status]: https://travis-ci.org/jshrake/glsl-include.svg?branch=master
[travis]: https://travis-ci.org/jshrake/glsl-include
[Build Status-win]: https://ci.appveyor.com/api/projects/status/3btnmxtpmabotj26?svg=true
[appveyor]: https://ci.appveyor.com/project/jshrake/glsl-include
[Latest Version]: https://img.shields.io/crates/v/glsl-include.svg
[crates.io]: https://crates.io/crates/glsl-include
[Rustc Version 1.15+]: https://img.shields.io/badge/rustc-1.15+-lightgray.svg
[rustc]: https://blog.rust-lang.org/2017/02/02/Rust-1.15.html

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

---

## Quick Start

Cargo.toml:
```toml
[dependencies]
glsl-include = "0.2"
```

main.rs:

```rust
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

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.