rfw

Documentation · Samples · Reference

2D rendering library for WebGL.

• Get started easily with apps, providing canvas context handling, resizing, etc.
• Fast, batched out-of-the-box renderers (textured mesh, lines, text, sprites)
• Scene (graphs)
• Low abstraction render tooling
• Change tracking: only render when you need to and save battery
• Performance in mind with batching, special data structures, and performance helpers
• Math utility modules
• Minimal dependencies

Getting Started

Install the package from npm:

npm install rfw2d
Copy

And import from rfw2d:

import { Vec2 } from 'rfw2d';
Copy

For more instructions and samples, check out the guide.

Contribute

Development

Use npm run dev <app path> to run any of the apps in a Vite dev web server. E.g.:

npm run dev samples/bunnymark
Copy

to run a sample.

Tests

Use npm run test to watch tests and npm run types:watch to continuously check types.

Docs

Use npm run docs:dev to start the doc dev web server. The benchmarks are available under benchmarks/.

The reference is built separately, with npm run reference:build and does not have a dev version.

License

MIT