Skip to content
WebGL library for 2gis projects
JavaScript GLSL
Branch: master
Clone or download

Latest commit

Latest commit 0fc9beb Dec 2, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
test
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
buildShaders.js
index.d.ts
jsdoc.json
package.json
webpack.config.js

README.md

2gl Build Status Coverage Status

Узкоспециализированная библиотека WebGL для использования в проектах 2GIS

Документация

  • Для работы с матрицами и векторами используется библиотека glMatrix
  • Работа с геометрическими объектами, например, Plane, Line3, Ray, взята из three.js

На данный момент может работать со следующими типами объектов для отображения:

  1. Basic mesh - меш, закрашивается в один цвет
  2. Complex mesh - меш, для которого можно устанавить: цвета для каждой из вершин, освещение, текстуру и определять для какой из вершин будет использоваться текстура
  3. Sprite - спрайт, к камере расположен всегда одной гранью, удалённость не влияет на размеры изображения
  4. MultiSprite - мультиспрайт представляет собой множество спрайтов, которые рисуются в один draw call

Examples

Установка

  • npm install 2gl

Подключение

Есть несколько способов подключения библиотеки:

  • Напрямую через тег, скрипт 2gl.js лежит в папке dist и содержит все компоненты библиотеки:
<script src="2gl.js"></script>
  • Если вы используете сборщики, например, browserify или webpack:
var dgl = require('2gl'); // CommonJS
import dgl from '2gl'; // ES6
  • Можно подключать только нужные компоненты для уменьшения размера:
var Mesh = require('2gl/Mesh');
var AmbientLight = require('2gl/lights/AmbientLight');

Development

  • npm install
  • npm start

Release

  • npm version patch - поднять патч версию
  • npm run pub - собрать проект, отправить в npm, вернуть в исходное состояние
You can’t perform that action at this time.