Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taichi-dev/taichi_glsl
A Taichi extension library providing a set of GLSL-alike helper functions
https://github.com/taichi-dev/taichi_glsl
graphics math-library python rendering taichi
Last synced: about 2 months ago
JSON representation
A Taichi extension library providing a set of GLSL-alike helper functions
- Host: GitHub
- URL: https://github.com/taichi-dev/taichi_glsl
- Owner: taichi-dev
- Created: 2020-06-07T08:32:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-22T12:52:57.000Z (almost 3 years ago)
- Last Synced: 2024-11-09T06:18:13.946Z (about 2 months ago)
- Topics: graphics, math-library, python, rendering, taichi
- Language: Python
- Homepage: https://taichi-glsl.readthedocs.io
- Size: 271 KB
- Stars: 70
- Watchers: 5
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Taichi GLSL
===========
Taichi GLSL is an extension library of the [Taichi Programming Language](https://github.com/taichi-dev/taichi), which provides a set of useful helper functions including but not limited to:
1. Handy scalar functions like ``clamp``, ``smoothstep``, ``mix``, ``round``.
2. GLSL-alike vector functions like ``normalize``, ``distance``, ``reflect``.
3. Well-behaved random generators including ``randUnit3D``, ``randNDRange``.
4. Handy vector and matrix initializer: ``vec`` and ``mat``.
5. Handy vector component shuffle accessor like ``v.xy``.
6. Handy field sampler including ``bilerp`` and ``sample``.
7. Useful physics helper functions like ``boundReflect``.
8. Shadertoy-alike inputed GUI base class ``Animation``.
[[Clike me for documentation]](https://taichi-glsl.readthedocs.io)
[](https://github.com/taichi-dev/taichi_glsl/actions?query=workflow%3A%22Persubmit+Checks%22)
[](https://taichi-glsl.readthedocs.io/en/latest)
[](https://codecov.io/gh/taichi-dev/taichi_glsl)
[](https://pepy.tech/project/taichi-glsl/month)
[](https://github.com/taichi-dev/taichi_glsl/releases)
Installation
------------
Install Taichi and Taichi GLSL with `pip`:
```bash
# Python 3.6/3.7/3.8 (64-bit)
pip install taichi taichi_glsl
```
How to play
-----------
First, import Taichi and Taichi GLSL:
```py
import taichi as ti
import taichi_glsl as ts
```
---
Then, use `ts.xxx` helper functions in your Taichi kernels like this:
```py
@ti.kernel
def kern():
a = ts.vec(2.2, -3.3) # deduced to be vec2
b = ts.normalize(a) # get normalized vector
c = ts.clamp(a) # element-wise, clamp to range [0, 1]
d = int(a) # cast to ivec2, vector of integers
print(b, c, d) # [0.554700, -0.832050] [1.000000, 0.000000] [2, -3]
```
Hints
-----
If you don't like the `ts.` prefix, import using:
```py
from taichi_glsl import *
@ti.kernel
def kern():
a = vec(2.33, 6.66)
b = normalize(a)
...
```
Note that this will import `taichi` as name `ti` as well.
---
`vec2`, `vec3` and `vec4` are simply `vec` in Taichi GLSL:
```py
v = vec(2.0, 3.0) # vec2
v = vec(2.0, 3.0, 4.0) # vec3
v = vec(2.0, 3.0, 4.0, 5.0) # vec4
v = vec(2, 3) # ivec2 (since 2 is an integer)
```
Thanks to the python syntax of `vec(*args)`.
Example
-------
The following codes shows up an [Shadertoy](https://shadertoy.com/new)-style rainbow UV
in the window:
```py
import taichi as ti
import taichi_glsl as ts
ti.init()
class MyAnimation(ts.Animation):
def on_init(self):
self.img = ti.Vector(3, ti.f32, (512, 512))
self.define_input()
@ti.kernel
def on_render(self):
for I in ti.grouped(self.img):
uv = I / self.iResolution
self.img[I] = ti.cos(uv.xyx + self.iTime +
ts.vec(0, 2, 4)) * 0.5 + 0.5
MyAnimation().start()
```
Check out more examples in the `examples/` folder.
Links
-----
* [Taichi Main Repo](https://github.com/taichi-dev/taichi)
* [Taichi GLSL Documentation](https://taichi-glsl.readthedocs.io)
* [Taichi THREE Repo](https://github.com/taichi-dev/taichi_three)
* [Taichi Documentation](https://taichi.readthedocs.io/en/stable)
* [Taichi 中文文档](https://taichi.readthedocs.io/zh_CN/stable)
* [Forum Thread for Taichi GLSL](https://forum.taichi.graphics/t/taichi-glsl-a-handy-extension-library-for-taichi/867)