How to use LYGIA with Three.js?

Install via npm or clone the repository, then include LYGIA functions in your shaders with #include statements. The README links to Three.js examples and recommends using build plugins for GLSL includes.

LYGIA vs ShaderToy for shader development?

LYGIA is a modular library for integrating shader functions into custom projects, while ShaderToy is a platform for writing and sharing complete shaders. LYGIA is better for production code, whereas ShaderToy excels in community-driven experimentation.

Is LYGIA compatible with Unity's Shader Graph?

No, LYGIA requires manual GLSL code inclusion and does not directly integrate with Unity's visual Shader Graph. It's designed for code-based shader development in Unity's surface shaders or custom HLSL.

How to reduce LYGIA's file size for a web project?

Use the prune.py script to keep only the necessary language files, such as GLSL for WebGL. The README provides commands like 'python prune.py --all --keep glsl' to minimize bundle size.

Can I use LYGIA in a commercial project without sponsoring?

No, the Prosperity License restricts commercial use. You need to become a sponsor or contributor to access the Patron License for commercial rights, as explained in the licensing section.

How to add a new function to LYGIA?

Follow the contribution guidelines in CONTRIBUTE.md, ensure the function is granular and multi-language, and submit a pull request. Contributors are automatically added to the commercial license.

Open-Awesome

Lygia

NOASSERTIONGLSL1.4.1

A granular, multi-language shader library for real-time graphics, supporting GLSL, HLSL, Metal, WGSL, and CUDA.

Visit Website GitHub

3.4k stars222 forks0 contributors

What is Lygia?

LYGIA is a granular and multi-language shader library designed for performance and flexibility in real-time graphics. It provides reusable functions across GLSL, HLSL, Metal, WGSL, and CUDA, enabling developers to prototype, port, and ship projects quickly. The library is battle-tested, cross-platform, and integrates with major engines and frameworks.

Target Audience

Graphics programmers, game developers, creative coders, and visual artists working with shaders in environments like Unity, Unreal Engine, Three.js, p5.js, and other real-time graphics platforms.

Value Proposition

Developers choose LYGIA for its extensive, granular function library that supports multiple shading languages out of the box, reducing boilerplate and accelerating shader development. Its flexibility and wide integration ecosystem make it a versatile tool for cross-platform graphics projects.

Overview

LYGIA, it's a granular and multi-language (GLSL, HLSL, Metal, WGSL, WEGL and CUDA) shader library designed for performance and flexibility

Use Cases

Best For

Rapid prototyping of visual effects in shader-based projects
Porting shaders between different graphics APIs and languages
Building real-time graphics applications with cross-platform support
Enhancing creative coding workflows in environments like p5.js or Processing
Developing custom shaders for game engines like Unity or Unreal Engine
Creating visual content for interactive installations or live performances

Not Ideal For

Projects relying on visual shader editors like Unity Shader Graph or Unreal's Material Editor that don't support custom GLSL includes
Applications with ultra-strict real-time performance requirements where shader compilation overhead must be minimized
Teams developing for a single graphics API who prefer native, engine-specific shader tools over a multi-language library

Pros & Cons

Pros

Multi-Language Support

Functions are available in GLSL, HLSL, Metal, WGSL, WEGL, and CUDA, enabling easy porting across different graphics APIs as highlighted in the key features.

Granular Function Design

Each file contains a single function, allowing developers to include only necessary code for performance optimization, as described in the library's philosophy.

Extensive Engine Integrations

Ready-to-use examples and integrations for Unity, Unreal Engine, Three.js, p5.js, and more, demonstrated in the gallery of supported platforms.

Flexible Configuration

Behavior can be customized using #define keywords before inclusion, such as changing Gaussian blur to 2D kernel mode, as shown in the design examples.

Cons

Complex Setup Process

Local usage requires configuring the environment to resolve #include dependencies, with multiple methods like cloning, submodules, or pruning that can be confusing for newcomers.

Restrictive Licensing Model

Dual-licensed under the Prosperity License and Patron License, requiring sponsorship or contributions for commercial use, which adds legal complexity compared to permissive licenses.

Server Dependency for Cloud

Cloud-based projects must use the LYGIA server for dependency resolution, introducing potential latency and reliability issues, as noted in the server usage section.

Frequently Asked Questions

Related Projects

Canvas-sketch

[beta] A framework for making generative artwork in JavaScript and the browser.

Stars5,273

Forks402

Last commit1 month ago

Fragment.tools

[alpha] A modern toolkit for creative coding

Stars933

Forks25

Last commit23 days ago

PixelKit

Live Graphics in Swift & Metal

Stars892

Forks67

Last commit3 years ago

AsyncGraphics

Edit images and video with Swift concurrency, powered by Metal.

Stars418

Forks21

Last commit21 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub