README.md

parallax-scene-js

Create raw WebGL parallax scenes with only 1 draw call. The aim of the project is to create parallax scenes can run smoothly even very low-end mobile devices.

Supports WebGL 1 & 2. Bundle size < 20 kb.

Parallax.Scene.JS.mp4

Live: https://yunusbayraktaroglu.github.io/parallax-scene-js/

Usage

const parallaxScene = [
    // The first object in the array represents the bottom-most layer
    { 
        imageUrl: 'images/parallax-1.png',
        fit: {
            h: 1.5 // Scale the layer to 1.5 times the height of the canvas while maintaining its ratio
        },
        parallax: {
            x: 0.3,
            y: 1 // Move the layer without it moving out of the canvas.
        },
        translate: {
            x: -0.25, // Position the layer respective to its size
        }
    },
    items...
];

<div data-parallax-scene='[{"imageUrl":"images/parallax-1.png","parallax":{"x":0.3,"y":1},"fit":{"h":1.075}},{"imageUrl":"images/parallax-2.png","parallax":{"x":0.6,"y":1},"fit":{"h":1.05}},{"imageUrl":"images/parallax-3.png","parallax":{"x":0.6,"y":1},"fit":{"h":1.05}},{"imageUrl":"images/parallax-motor.png","parallax":{"x":1,"y":1},"fit":{"h":1.025}},{"imageUrl":"images/parallax-light.png","parallax":{"x":1,"y":1},"translate":{"x":-0.25},"fit":{"h":1.5}}]'></div>

Import & Setup

<script src="./parallax-scene.umd.cjs"></script>

const canvas = document.getElementById( "canvas" );
const parallaxManager = new window.ParallaxManager( canvas );

// Collects all ['data-parallax-scene']
parallaxManager.setup( () => {
	parallaxManager.activateScene( 0 );
	parallaxManager.start();

	window.addEventListener( "resize", () => {
		parallaxManager.updateResolution();
	} );
} );