curtainsjs

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 1,825)

curtains.js is a lightweight vanilla WebGL javascript library that turns HTML DOM elements into interactive textured planes.

curtainsjs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h2>What is it ?</h2>
<p>
    Shaders are the new front-end web developpment big thing, with the ability to create very powerful 3D interactions and animations. A lot of very good javascript libraries already handle WebGL but with most of them it's kind of a headache to position your meshes relative to the DOM elements of your web page.
</p>
<p>
    curtains.js was created with just that issue in mind. It is a small vanilla WebGL javascript library that converts HTML elements containing images and videos into 3D WebGL textured planes, allowing you to animate them via shaders.<br />
    You can define each plane size and position via CSS, which makes it super easy to add WebGL responsive planes all over your pages.
</p>
<p style="text-align: center;">
    <img src="https://github.com/martinlaxenaire/curtainsjs/blob/master/documentation/images/promo.gif" alt="curtains.js demo gif" width="300" height="225" />
</p>
<h2>Knowledge and technical requirements</h2>
<p>
    It is easy to use but you will of course have to possess good basics of HTML, CSS and javascript.
</p>
<p>
    If you've never heard about shaders, you may want to learn a bit more about them on <a href="https://thebookofshaders.com/" title="The Book of Shaders" >The Book of Shaders</a> for example. You will have to understand what are the vertex and fragment shaders, the use of uniforms as well as the GLSL syntax basics.
</p>
<h2>Installation and usage</h2>
<div>
    You can directly download the files and start using the ES6 modules:
    
```javascript
import {Curtains, Plane} from 'path/to/src/index.mjs';

const curtains = new Curtains({
    container: "canvas"
});

const plane = new Plane(curtains, document.querySelector("#plane"));
```
</div>
<div>
    Or you can use npm:

```
npm i curtainsjs
```

</div>
<div>
    Load ES6 modules:

```javascript
import {Curtains, Plane} from 'curtainsjs';
```

</div>
<div>
In a browser, you can use the UMD files located in the `dist` directory:
    
```html
<script src="dist/curtains.umd.min.js"></script>
```

```javascript
const curtains = new Curtains({
    container: "canvas"
});

const plane = new Plane(curtains, document.querySelector("#plane"));

// etc
```

</div>

<h3>Usage with React</h3>

Note that if you are using React, you might want to try <a href="https://github.com/martinlaxenaire/react-curtains">react-curtains</a>, curtains.js official React package.

<h2>Documentation</h2>

The library is split into classes modules. Most of them are used internally by the library but there are however a few classes meant to be used directly, exported in the [src/index.mjs](src/index.mjs) file.

<ul>
    <li>
        Curtains: appends a canvas to your container and instanciates the WebGL context. Also handles a few helpers like scroll and resize events, request animation frame loop, etc.
    </li>
    <li>
        Plane: creates a new Plane object bound to a HTML element.
    </li>
    <li>
        Textures: creates a new Texture object.
    </li>
</ul>

<h3>Frame Buffer Objects</h3>

<ul>
    <li>
        RenderTarget: creates a frame buffer object.
    </li>
    <li>
        ShaderPass: creates a post processing pass using a RenderTarget object.
    </li>
</ul>

<h3>Loader</h3>

<ul>
    <li>
        TextureLoader: loads HTML media elements such as images, videos or canvases and creates Texture objects using those sources.
    </li>
</ul>

<ul>
    <li>
        Vec2: creates a new Vector 2.
    </li>
    <li>
        Vec3: creates a new Vector 3.
    </li>
    <li>
        Mat4: creates a new Matrix 4.
    </li>
    <li>
        Quat: creates a new Quaternion.
    </li>
</ul>

<h3>Extras</h3>

<ul>
<li>
        PingPongPlane: creates a plane that uses FBOs ping pong to read/write a texture.
    </li>
    <li>
        FXAAPass: creates an antialiasing FXAA pass using a ShaderPass object.
    </li>
</ul>

<h3>Full documentation</h3>

<p>
    <a href="https://www.curtainsjs.com/get-started.html" title="Getting started" target="_blank">Getting started</a><br />
    <a href="https://www.curtainsjs.com/documentation.html" title="API docs" target="_blank">API docs</a><br />
    <a href="https://www.curtainsjs.com/index.html#examples">Examples</a>
</p>

<h2>Basic example</h2>

```html
<body>
    
    <div id="canvas"></div>
    
    
    <div class="plane">
    
        
        <img src="path/to/my-image.jpg" crossorigin="" />
    </div>
    
</body>
```

```css
body {
    /* make the body fits our viewport */
    position: relative;
    width: 100%;
    height: 100vh;
    margin: 0;
    overflow: hidden;
}

#canvas {
    /* make the canvas wrapper fits the document */
    position: absolute;
    top: 0;
    right: 0;
    bottom: 0;
    left: 0;
}

.plane {
    /* define the size of your plane */
    width: 80%;
    height: 80vh;
    margin: 10vh auto;
}

.plane img {
    /* hide the img element */
    display: none;
}
```

<h3>Javascript</h3>

```javascript
import {Curtains, Plane} from 'curtainsjs';

<h3>Shaders</h3>

<h4>Vertex shader</h4>

```glsl
<script id="plane-vs" type="x-shader/x-vertex">
    #ifdef GL_ES
    precision mediump float;
    #endif
    
    // those are the mandatory attributes that the lib sets
    attribute vec3 aVertexPosition;
    attribute vec2 aTextureCoord;
    
    // those are mandatory uniforms that the lib sets and that contain our model view and projection matrix
    uniform mat4 uMVMatrix;
    uniform mat4 uPMatrix;
    
    // our texture matrix that will handle image cover
    uniform mat4 uTextureMatrix0;
    
    // pass your vertex and texture coords to the fragment shader
    varying vec3 vVertexPosition;
    varying vec2 vTextureCoord;
    
    void main() {       
        gl_Position = uPMatrix * uMVMatrix * vec4(aVertexPosition, 1.0);
        
        // set the varyings
        // here we use our texture matrix to calculate the accurate texture coords
        vTextureCoord = (uTextureMatrix0 * vec4(aTextureCoord, 0.0, 1.0)).xy;
        vVertexPosition = aVertexPosition;
    }
</script> 
```

<h4>Fragment shader</h4>

```glsl
<script id="plane-fs" type="x-shader/x-fragment">
    #ifdef GL_ES
    precision mediump float;
    #endif
    
    // get our varyings
    varying vec3 vVertexPosition;
    varying vec2 vTextureCoord;
    
    // the uniform we declared inside our javascript
    uniform float uTime;
    
    // our texture sampler (default name, to use a different name please refer to the documentation)
    uniform sampler2D uSampler0;
    
    void main() {
        // get our texture coords from our varying
        vec2 textureCoord = vTextureCoord;
        
        // displace our pixels along the X axis based on our time uniform
        // textures coords are ranging from 0.0 to 1.0 on both axis
        textureCoord.x += sin(textureCoord.y * 25.0) * cos(textureCoord.x * 25.0) * (cos(uTime / 50.0)) / 25.0;
        
        // map our texture with the texture matrix coords
        gl_FragColor = texture2D(uSampler0, textureCoord);
    }
</script> 
```

<h2>Changelog</h2>

Complete [changelog](CHANGELOG.md) starting from version 7.1.0

curtainsjs

curtainsjs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

curtainsjs

curtainsjs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README