{"id":15287951,"url":"https://github.com/sakitam-gis/vis-engine","last_synced_at":"2025-04-13T06:09:17.751Z","repository":{"id":65540821,"uuid":"568340286","full_name":"sakitam-gis/vis-engine","owner":"sakitam-gis","description":"A sample gl render engine toolkit.","archived":false,"fork":false,"pushed_at":"2024-11-11T06:00:20.000Z","size":27064,"stargazers_count":15,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T06:08:57.504Z","etag":null,"topics":["gis","mapbox-gl-js","maptalks","rollup","threejs","typescript","vite","webgl","webgl2"],"latest_commit_sha":null,"homepage":"https://sakitam-gis.github.io/vis-engine","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sakitam-gis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-20T08:03:00.000Z","updated_at":"2025-04-09T10:23:11.000Z","dependencies_parsed_at":"2023-11-19T09:24:05.945Z","dependency_job_id":"3594086c-9207-4e96-b458-0715f86e3f4f","html_url":"https://github.com/sakitam-gis/vis-engine","commit_stats":{"total_commits":151,"total_committers":2,"mean_commits":75.5,"dds":"0.17880794701986757","last_synced_commit":"bd960a64139d188b13ad8aa46a89e04055b58570"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sakitam-gis%2Fvis-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sakitam-gis%2Fvis-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sakitam-gis%2Fvis-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sakitam-gis%2Fvis-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sakitam-gis","download_url":"https://codeload.github.com/sakitam-gis/vis-engine/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670435,"owners_count":21142904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gis","mapbox-gl-js","maptalks","rollup","threejs","typescript","vite","webgl","webgl2"],"created_at":"2024-09-30T15:39:56.117Z","updated_at":"2025-04-13T06:09:17.718Z","avatar_url":"https://github.com/sakitam-gis.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## vis-engine\n\n**vis-engine** 是一个简单的 `webgl` 渲染引擎工具包，它的设计受到了 [threejs](https://threejs.org/) 和 [ogl](https://github.com/oframe/ogl) 的启发。\n\n它的定位介于 WebGL 封装和渲染引擎之间，包含了相机，Mesh 和 Shader 模块化以及 webgl 状态管理。\n\n[![CI](https://github.com/sakitam-gis/vis-engine/actions/workflows/ci.yml/badge.svg)](https://github.com/sakitam-gis/vis-engine/actions/workflows/ci.yml) [![npm version](https://badgen.net/npm/v/@sakitam-gis/vis-engine)](https://npm.im/@sakitam-gis/vis-engine) [![npm downloads](https://badgen.net/npm/dm/@sakitam-gis/vis-engine)](https://npm.im/@sakitam-gis/vis-engine) [![Coverage Status](https://coveralls.io/repos/github/sakitam-gis/vis-engine/badge.svg?branch=master)](https://coveralls.io/github/sakitam-gis/vis-engine?branch=master)\n\n### Install\n\n```bash\nyarn add @sakitam-gis/vis-engine -S\n\npnpm i @sakitam-gis/vis-engine\n\nimport { Renderer, Raf, Scene, PerspectiveCamera, Geometry, Mesh, Program } from '@sakitam-gis/vis-engine';\n```\n\n### Usage\n\n#### Renderer\n\n创建渲染器：\n\n```ts\nconst renderer = new Renderer(canvas, {\n  alpha: true,\n});\n```\n\n#### Camera\n\n创建相机：\n\n```ts\nconst fov = 15;\nconst nearZ = 0.1;\n\nconst farZ = 100;\nconst camera = new PerspectiveCamera(fov, canvas.width / canvas.height, nearZ, farZ);\ncamera.position.z = fov;\n```\n\n#### Scene\n\n创建场景：\n\n```ts\nconst scene = new Scene();\n```\n\n#### Geometry\n\n创建几何体对象：\n\n```ts\nconst geometry = new Geometry(renderer, {\n  position: {\n    size: 3,\n    data: new Float32Array([\n      -1.6, 1.5, 0,\n      -1, -1, 0,\n      1, -1, 0,\n      -1, -1, 0,\n      1, -1, 0,\n      1.6, 1.5, 0,\n    ])\n  },\n});\n```\n\n#### Program\n\n创建着色器资源：\n\n```ts\nconst program = new Program(renderer, {\n  vertexShader: `\n    attribute vec2 uv;\n    attribute vec3 position;\n    uniform mat4 modelViewMatrix;\n    uniform mat4 projectionMatrix;\n\n    varying vec2 vUv;\n\n    void main() {\n        vUv = uv;\n\n        gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);\n\n        // gl_PointSize only applicable for gl.POINTS draw mode\n        gl_PointSize = 5.0;\n    }\n    `,\n  fragmentShader: `\n    precision highp float;\n\n    uniform float uTime;\n    varying vec2 vUv;\n\n    void main() {\n        gl_FragColor.rgb = 0.5 + 0.3 * sin(vUv.yxx + uTime) + vec3(0.2, 0.0, 0.1);\n        gl_FragColor.a = 1.0;\n    }\n    `,\n  uniforms: {\n    uTime: { value: 0 },\n  },\n});\n```\n\n#### Mesh\n\n创建 Mesh：\n\n```ts\nconst triangles = new Mesh(renderer, { mode: renderer.gl.TRIANGLES, geometry, program });\n```\n\n#### 添加到场景\n\n```ts\nscene.add(triangles);\n```\n\n#### 渲染\n\n更新 uniform 变量并渲染场景：\n\n```ts\nconst raf = new Raf((t) =\u003e {\n  program.setUniform('uTime', t);\n  renderer.render({ scene, camera });\n});\n```\n\n### Types\n\nvis-engine 完全采用 Typescript 编写\n\n### Roadmap\n\n📢注意：这是一个玩具项目，不是为了替代什么，但是我会尽力完善它，它最大的方向可能是和各类地图引擎结合例如 mapbox-gl/maptalks/leaflet 等，所以暂时没有固定的路线图。\n\n- [mapbox-gl adapters](https://github.com/sakitam-gis/vis-engine/tree/master/adapters/mapbox)\n- [maptalks adapters](https://github.com/sakitam-gis/vis-engine/tree/master/adapters/maptalks)\n\n### License\n\n[BSD 3-Clause](https://github.com/sakitam-gis/vis-engine/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsakitam-gis%2Fvis-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsakitam-gis%2Fvis-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsakitam-gis%2Fvis-engine/lists"}