Guide
This guide helps you build scenes with Chorama using practical, task-first steps.
Overview
Chorama is a modular WebGL2 rendering library focused on explicit control: you compose render behavior with plugins, build scenes from reusable object/material/light primitives, and keep direct visibility into the render flow.
[!WARNING] Chorama is currently experimental and is not recommended for production use. Expect API changes, behavior changes and breaking changes as the library evolves.
This guide is structured to take you from first render to production-style scene setup. Instead of covering every class in isolation first, each chapter is anchored to a concrete task and points you to full runnable examples.
By the end of this guide, you should be able to:
- Set up a render loop with
WebGLRenderDevice,CanvasTarget, andWebGLRenderer - Build and animate scene objects with camera, materials, and lights
- Load texture/model assets and handle async content safely
- Use render targets and view configuration for offscreen and multi-view scenarios
- Understand the plugin-driven pipeline enough to debug and extend behavior
Who This Guide Is For
Use this if you want direct WebGL2 control but still want reusable building blocks.
How To Use This Guide
- New to Chorama: follow the reading order from top to bottom.
- Migrating from another renderer: start at First Scene, then jump to Plugins and Render Pipeline.
- Looking for a specific API: use API Map as an index, then return to task pages for applied usage.
- Blocked on behavior: check Troubleshooting, then compare your setup against a matching example route.