Awesome
shadertoy
Shadertoy implementation based on wgpu-py.
Introduction
This library provides an easy to use python utility to run shader programs from the website Shadertoy.com. It provides the compatibility to let users copy code from the website directly and run it with the various GUIs that are supported in wgpu-py. Including Jupyter notebooks.
Shadertoys translated to wgsl are also supported using the uniforms i_resolution
, i_time
, etc.
This project is not affiliated with shadertoy.com.
Installation
pip install wgpu-shadertoy
To use the Shadertoy.com API, please setup an environment variable with the key SHADERTOY_KEY
. See How To for instructions.
Usage
The main Shadertoy
class takes shader code as a string.
from wgpu_shadertoy import Shadertoy
shader_code = """
void mainImage( out vec4 fragColor, in vec2 fragCoord )
{
vec2 uv = fragCoord/iResolution.xy;
vec3 col = 0.5 + 0.5*cos(iTime+uv.xyx+vec3(0,2,4));
fragColor = vec4(col,1.0);
}
"""
shader = Shadertoy(shader_code, resolution=(800, 450))
if __name__ == "__main__":
shader.show()
Texture inputs are supported by using the ShadertoyChannel
class. Up to 4 channels are supported.
from wgpu_shadertoy import Shadertoy, ShadertoyChannel
from PIL import Image
shader_code = """
void mainImage( out vec4 fragColor, in vec2 fragCoord )
{
vec2 uv = fragCoord/iResolution.xy;
vec4 c0 = texture(iChannel0, 2.0*uv + iTime * 0.2);
fragColor = c0;
}
"""
img = Image.open("./examples/screenshots/shadertoy_star.png")
channel0 = ShadertoyChannel(img, wrap="repeat")
shader = Shadertoy(shader_code, resolution=(800, 450), inputs=[channel0])
To easily load shaders from the website make use of the .from_id
or .from_json
classmethods. This will also download supported input media.
shader = Shadertoy.from_id("NslGRN")
When passing off_screen=True
the .snapshot()
method allows you to render specific frames.
shader = Shadertoy(shader_code, resolution=(800, 450), off_screen=True)
frame0_data = shader.snapshot()
frame10_data = shader.snapshot(10.0)
frame0_img = Image.fromarray(np.asarray(frame0_data))
frame0_img.save("frame0.png")
For more examples see examples.
CLI Usage
A basic command line interface is provided as wgpu-shadertoy
.
To display a shader from the website, simply provide its ID or url.
> wgpu-shadertoy tsXBzS --resolution 1024 640
Status
This project is still in development. Some functionality from the Shadertoy website is missing and new features are being added. See the issues to follow the development or contribute yourself! For progress see the changelog.
License
This code is distributed under the 2-clause BSD license.
Code of Conduct
Our code of conduct can be found here: Code of Conduct