Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

webgl-example

gandis071357MIT0.0.4TypeScript support: included

The examples are used on Gandis Blog

3d, webgl, mesh, image, volume, graphics, rendering

readme

webgl-example

Build Status npm-download npm-version-requirement yarn-version-requirement node-version-requirement

Introduction

webgl-example is an open source for implementing basic examples such as 3D Rendering, Image Processing, Light Effect, etc. It started for easily apply to a blog or web site.

Requirements

  • Node 14.15.4
  • NPM 6.14.10
  • YARN 1.22.0+

Concept

webgl-example has a very simple structure and has three representative components.

  • Renderer is responsible that rendering objects.
  • Action is responsible that for user interaction and control a view(Renderer) and objects.
  • Window has a renderer and an action, provides function APIs to the user.

How to use

  • Package Manager
    $ npm i webgl-example
    ~~~Javascript import SharpenImageWindow from 'webgl-example/src/window/SharpenImageWindow';

const imageWindow = new SharpenImageWindow(HTMLElement); const image = new Image(); image.src = "<Image resource address>"; image.addEventListener('load', function() { imageWindow.setImage(image); });


- **Bundle**
~~~HTML
<script src="./webgl-example.bundle.js"></script>
<script>
    window.addEventListener('load', function() {
        const divElement = document.getElementById("divElement");
        const imageWindow = new webglexample.window.EdgeImageWindow(divElement);
        const image = new Image();
        image.src = "<Image resource address>";
        image.addEventListener('load', function() {
            imageWindow.setImage(image);
        });
    });
</script>
<body>
    <div id="divElement"></div>
</body>

Configure

  • Webpack
    rules: [
      {
          test: /\.glsl$/,
          use: [ 'shader-loader' ]
      },
    ]

Examples