include-shader is a procedural macro. It will run at compile time and transform your program's source code.

Adding `include-shader` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add include-shader

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

include-shader = "0.2.0"

You may need to import the macro(s) with use include_shader::*.

Read the include_shader documentation.

Back to the crate overview.

Readme

include-shader

A Rust macro for including shader files as string with dependencies support.

Setup

Although this library works on stable, detection of shader file changes is not guaranteed due to caching. Therefore, it is recommended to use nightly along with the track-path feature enabled until the track_path API stabilizes.

Nightly toolchain (recommended)

For the best experience, use nightly to gain access to extra features:

File tracking
Relative path resolution

Add the following to your Cargo.toml manifest file:

[dependencies]
include-shader = { version = "0.2.0", features = ["relative-path", "track-path"] }

Stable toolchain

Add the following to your Cargo.toml manifest file:

[dependencies]
include-shader = "0.2.0"

Example

use include_shader::include_shader;

fn main() {
   // ...
   let frag_shader = compile_shader(
       &context,
       WebGl2RenderingContext::FRAGMENT_SHADER,
       include_shader!("src/shaders/fragment_shader.glsl"),
   )?;
   // ...
}

Documentation

For more details on how to use this macro, see the documentation.

License

Distributed under the terms of both the MIT license and the Apache License (Version 2.0).

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.

Adding include-shader macro(s) as a dependency

Adding `include-shader` macro(s) as a dependency