ClayGL 开源项目教程

2024-09-14 14:45:09作者：余洋婵Anita

1. 项目介绍

ClayGL 是一个用于构建可扩展 Web3D 应用程序的 WebGL 图形库。它易于使用，并且可以通过配置实现高质量的图形效果。ClayGL 的模块化设计使得它可以轻松地集成到各种项目中，并且可以通过树摇（tree shaking）技术将基本 3D 应用程序的体积缩小到仅 22k（gzip 压缩后）。

2. 项目快速启动

创建一个旋转的立方体

以下是一个简单的示例，展示如何使用 ClayGL 创建一个旋转的立方体。

<!DOCTYPE html>
<html lang="en">
<head>
    <script src="lib/claygl.js"></script>
</head>
<body>
    <canvas id="main"></canvas>
    <script>
        clay.application.create('#main', {
            width: window.innerWidth,
            height: window.innerHeight,
            init(app) {
                // 创建相机
                this._camera = app.createCamera([0, 2, 5], [0, 0, 0]);
                
                // 创建一个红色的立方体
                this._cube = app.createCube({ color: '#f00' });
                
                // 创建光源
                this._mainLight = app.createDirectionalLight([-1, -1, -1]);
            },
            loop(app) {
                this._cube.rotation.rotateY(app.frameTime / 1000);
            }
        });
    </script>
</body>
</html>

最小化打包示例

以下示例展示了如何使用 Webpack 4.0 打包一个仅 22k（gzip 压缩后）的 ClayGL 应用程序。

import { Renderer, GeometryBase, Shader, Material } from 'claygl';

const vsCode = `
    attribute vec3 position;
    void main() {
        gl_Position = vec4(position, 1.0);
    }
`;

const fsCode = `
    void main() {
        gl_FragColor = vec4(1.0, 0.0, 1.0, 1.0);
    }
`;

const renderer = new Renderer({
    canvas: document.getElementById('main')
});
renderer.resize(400, 400);

const geometry = new GeometryBase();
geometry.createAttribute('position', 'float', 3);
geometry.attributes.position.fromArray([
    [-0.5, -0.5, 0],
    [0.5, -0.5, 0],
    [0, 0.5, 0]
]);

const material = new Material({
    shader: new Shader(vsCode, fsCode)
});

renderer.renderPass([
    [geometry, material]
]);