grimoire   ![BUILD-img] ![CRATES-img] ![MIT-img] ![APACHE-img]

What?

grimoire is a cross-platform (Windows, MacOS, "Linux") live-coding tool for creating GLSL shader demos in the style of shadertoy and vertexshaderart. See some examples to get started:

• shadertoy new: cargo run -- ./examples/shadertoy-new
• video: cargo run -- ./examples/video
• webcam: cargo run -- ./examples/webcam

Read the spec for a complete description of the configuration schema and runtime behavior.

Install

You need to build and install grimoire from source using rust and install the required system dependencies:

• SDL2 for window and input handling
• GStreamer for video, webcam, audio, microphone, and kinect2 inputs
• OpenGL 3.3+, but uses a subset of OpenGL accessible from GLES 3.0

grimoire currently builds against rust stable 1.33, 2018 edition.

MacOS

console $ curl https://sh.rustup.rs -sSf | sh $ brew install sdl2 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav

Linux

console $ curl https://sh.rustup.rs -sSf | sh $ apt-get install libsdl2-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav

Windows

• Download and run msys2
• Use the x86_64-pc-windows-gnu toolchain: rustup default stable-x86_64-pc-windows-gnu
• Install the required dependencies /w pacman

console $ pacman -S mingw-w64-x86_64-pkg-config mingw-w64-x86_64-SDL2 mingw-w64-x86_64-GStreamer mingw-w64-x86_64-gst-plugins-base mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav - Manually copy the SDL2.dll to the top-level grimoire source directory (the one containing Cargo.toml) before running

Note that you need to ensure that your PATH contains the mingw64/bin directory, and that your PKG_CONFIG_PATH lists the directory containing all the .pc files. Since I installed msys2 with scoop, my .bash_profile contains the following lines:

PATH="$PATH:/c/Users/jshrake/scoop/apps/msys2/current/mingw64/bin" PKG_CONFIG_PATH="/c/Users/jshrake/scoop/apps/msys2/current/mingw64/lib/pkgconfig"

Breadcrumbs: - https://github.com/sdroege/GStreamer-rs#windows

Resources

fragment shaders

• Ray Marching and Signed Distance Functions
• Modeling with Signed Distance Functions
• Ray Marching Distance Fields
• The Book of Shaders

vertex shaders

• vertexshaderart lessons
• perspective projection matrix

Inspiration

• shadertoy
• vertexshaderart
• bonzomatic
• interactiveshaderformat
• the book of shaders
• https://shadertoyunofficial.wordpress.com/

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (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.