https://github.com/paratron/shaderboy
A library that makes pixel-based animation of images in websites like eating candy
https://github.com/paratron/shaderboy
Last synced: 7 months ago
JSON representation
A library that makes pixel-based animation of images in websites like eating candy
- Host: GitHub
- URL: https://github.com/paratron/shaderboy
- Owner: Paratron
- License: mit
- Created: 2017-01-30T17:50:02.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-11T22:30:33.000Z (almost 9 years ago)
- Last Synced: 2024-10-19T01:18:40.391Z (about 1 year ago)
- Language: JavaScript
- Size: 223 KB
- Stars: 21
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Shaderboy
=========
This library makes it easy to use GLSL shaders on your websites to create really fast, pixel-based animations for images.
Simply place an `![]()
` tag somewhere, write a GLSL shader for it and connect them with shaderboy.
Here`s a demo: https://wearekiss.com/preview/shaderboy/test.html
## Changelog
- __Version 1.1__: Now passing mouse-related data to the shaders
## Basic usage
First, download `shaderboy.js` or `shaderboy.min.js` and load it in your html document.
````javascript
````
You need to write a GLSL shader to manipulate the pixeldata of your images. You can either store your shader(s) in
separate files on your server, or embed them in script tags into your document - its totally up to you.
To advise shaderboy which images it should manipulate and how to do that, you need to apply some `data-*` attributes
to your `![]()
` elements.
The easiest way to attach a GLSL shader to an `![]()
` element is this:
````html
````
Shaderboy will try to load the file `./myshader.glsl` via AJAX and will start to animate the image as soon as it has been loaded.
If you have embedded your shader directly into the HTML document, you need to apply an id to the script tag and tell
shaderboy to use the shader with the given id:
````html
// SHADER DATA
````
The `#` symbol tells shaderboy that `data-shader` should be treated as an id reference rather than a url.
## Whats happening next
Shaderboy will replace the `![]()
` element with a `` element. If you have placed
any css classnames on the image, they will be copied over to the canvas element.
After the image has been replaced, the WebGL context will be created by shaderboy, any additional
textures are being loaded and the animation is started.
## Using multiple textures
A modern shader can utilize multiple textures to be used as masks or data sources to compose
complicated effects. Shaderboy allows you as well to load multiple textures to be used to
animate _one_ image tag. Define them like so:
````html
````
Currently, shaderboy allows you to load up to 6 additional texures (together with your original images data)
into your shaders. Simply place the attributes `data-texture0` to `data-texture5`.
All loaded image data - the information of your original `![]()
` tag, as well as any
additionally loaded textures are made available inside your GLSL shaders.
Read more about how to access them, below.
## GLSL variables
Shaderboy provides a couple of variables you may access inside your GLSL shaders:
````glsl
uniform sampler2D image;
uniform sampler2D texture0;
uniform sampler2D texture1;
# ... up to texture5
uniform float time;
varying vec2 pixelCoords;
uniform vec2 mouseCoords;
uniform int mouseDownLeft;
uniform int mouseDownRight;
````
The original images data is provided as a texture named `image`, all additionally loaded texures
can be accessed through `texture0` to `texture5`.
Together with the image data, shaderboy will pass a `time` variable to enable you to change your shaders appearance
over time, as well as a vector named `pixelCoords` that contains the coordinates of the currently rendered pixel.
Mouse data has been added in version 1.1 - you can grab a vec2 with `mouseCoords` that
are already mapped to the WebGL coordinates space (x from 0 to 1, y from 1 to 0).
The uniforms `mouseDownLeft` and `mouseDownRight` are either 0 or 1 - depending on if one of those
mouse buttons have been pressed.
## How the hell do I write GLSL shaders?
Well, there are a lot of books out there that help you learn "GLSL es" - the version of GLSL that is used
by WebGL.
If you want to have a free introduction into the topic, I recommend [The book of shaders](https://thebookofshaders.com/) - I also recommend you to donate something to the author,
because he had a lot of work creating this great book!
Have fun with shaderboy - and don't forget to share your creations with me :)