Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martinlaxenaire/gpu-curtains
gpu-curtains is a 3D WebGPU rendering engine. It can be used as a standalone 3D engine, but also includes extra classes focused on mapping 3d objects to DOM elements; It allows users to synchronize values such as position, sizing, or scale between them.
https://github.com/martinlaxenaire/gpu-curtains
3d canvas curtains curtainsjs dom html5 javascript webgpu
Last synced: 1 day ago
JSON representation
gpu-curtains is a 3D WebGPU rendering engine. It can be used as a standalone 3D engine, but also includes extra classes focused on mapping 3d objects to DOM elements; It allows users to synchronize values such as position, sizing, or scale between them.
- Host: GitHub
- URL: https://github.com/martinlaxenaire/gpu-curtains
- Owner: martinlaxenaire
- License: mit
- Created: 2023-05-26T08:42:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-08T13:58:50.000Z (14 days ago)
- Last Synced: 2025-01-20T11:45:26.250Z (2 days ago)
- Topics: 3d, canvas, curtains, curtainsjs, dom, html5, javascript, webgpu
- Language: TypeScript
- Homepage: https://martinlaxenaire.github.io/gpu-curtains/
- Size: 182 MB
- Stars: 94
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# gpu-curtains
[Website](https://martinlaxenaire.github.io/gpu-curtains/) - [Documentation](https://martinlaxenaire.github.io/gpu-curtains/docs/) - [Examples](https://martinlaxenaire.github.io/gpu-curtains/examples/)
---
>
> :warning: WIP
>
---
### DOM 2 WebGPU rendering engine
gpu-curtains is a small, lightweight 3D WebGPU rendering engine library.
It can be used as a standalone 3D engine, but also includes extra classes designed to turn HTML elements into textured planes or meshes, allowing you to animate them via WGSL shaders.
The project was initially conceived as a WebGPU port of [curtains.js](https://github.com/martinlaxenaire/curtainsjs). It turned out to be a complete rewrite of the library instead, but with a very similar API.
## Usage
You can directly download the files and start using the ES6 modules:
#### ES modules
```javascript
import { GPUCurtains } from 'path/to/dist/esm/index.mjs'
window.addEventListener('load', async () => {
// set our main GPUCurtains instance
// it will handle everything we need
// a WebGPU device and a renderer with its scene,
// requestAnimationFrame, resize and scroll events...
const gpuCurtains = new GPUCurtains({
container: '#canvas'
})
// set the GPU device
// note this is asynchronous
await gpuCurtains.setDevice()
// now create some magic!
})
```
You can also use one of your favorite package manager:
#### npm
```
npm i gpu-curtains
```
#### yarn
```
yarn add gpu-curtains
```
Finally, you can load the library from a CDN. You should always target a specific version (append `@x.x.x`) rather than the latest one in order to avoid breaking changes.
```javascript
import { ... } from 'https://esm.run/gpu-curtains'
// or
import { ... } from 'https://cdn.skypack.dev/gpu-curtains'
// or use another cdn...
```
#### UMD files
In a browser, you can use the UMD files located in the `dist` directory:
```html
```
Or use a CDN:
```html
```
## Documentation and examples
- [API documentation](https://martinlaxenaire.github.io/gpu-curtains/docs/)
- [Official examples](https://martinlaxenaire.github.io/gpu-curtains/examples/)
- [Website](https://martinlaxenaire.github.io/gpu-curtains/)
## Basic example
### HTML
```html
```
### CSS
```css
body {
position: relative;
width: 100%;
height: 100%;
margin: 0;
overflow: hidden;
}
#canvas {
/* make the canvas wrapper fits the viewport */
position: fixed;
top: 0;
right: 0;
width: 100%;
height: 100lvh;
}
```
### Javascript
```javascript
import { GPUDeviceManager, GPUCameraRenderer, Mesh } from 'gpu-curtains';
window.addEventListener('load', async () => {
// first, we need a WebGPU device, that's what GPUDeviceManager is for
const gpuDeviceManager = new GPUDeviceManager({
label: 'Custom device manager',
})
// we need to wait for the device to be created
// note this is asynchronous
await gpuDeviceManager.init()
// create a camera renderer
const gpuCameraRenderer = new GPUCameraRenderer({
deviceManager: gpuDeviceManager,
container: document.querySelector('#canvas'),
})
// create a cube mesh
const mesh = new Mesh(gpuCameraRenderer, {
geometry: new BoxGeometry(),
})
// this callback is executed
// before the scene actually updates the matrix stack
mesh.onBeforeRender(() => {
// make it rotate
mesh.rotation.x += 0.01
mesh.rotation.y += 0.02
})
})
```
## Limitations
gpu-curtains is a slowly evolving 3D engine but may lack some common features.
If you need a more robust 3D engine that could handle complex glTF or advanced lighting, shading or rendering mechanics, then you should probably go with another library like [three.js](https://github.com/mrdoob/three.js) or [Babylon.js](https://github.com/BabylonJS).
## Debugging
If you need to debug your scenes, understand in which order they are rendered or inspect your textures, I strongly recommend you to have a look at [Brendan Duncan's WebGPU inspector extension](https://github.com/brendan-duncan/webgpu_inspector).
## Contributing
Contribution are more than welcome! Please refer to the [contribution guidelines](CONTRIBUTING.md).
## Acknowledgements
Some parts of the code (mostly the math classes) have been ported or adapted from other existing open source libraries like [three.js](https://github.com/mrdoob/three.js) and [glmatrix](https://github.com/toji/gl-matrix).
Some examples are also ported and/or inspired by other online open-source WebGL or WebGPU examples. In any case the source should always be credited in the code. If a credit is missing, feel free to reach out or make a PR.
The [WebGPU samples](https://github.com/webgpu/webgpu-samples), [WebGPU fundamentals](https://webgpufundamentals.org/) and [WebGPU best practices](https://toji.dev/webgpu-best-practices/) were very helpful to help with the basic concepts of WebGPU. If you want to understand a bit more how it's working under the hood, do not hesitate to check those.
A big thanks to the members of the [WebGPU matrix chan](https://matrix.to/#/#WebGPU:matrix.org) that were always super kinds and very helpful as well.
## Changelog and roadmap
- [Releases](https://github.com/martinlaxenaire/gpu-curtains/releases)
- See the [roadmap](ROADMAP.md) for details on the current work in progress and possible improvements.