UNPKG

@jscad/regl-renderer

Version:

Renderer for JSCAD Geometries

openjscad.xyz

jscad/OpenJSCAD.org

74 lines (46 loc) • 2.78 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# @jscad-regl-renderer > Renderer for JSCAD geometries, both 2D and 3D [![NPM version](https://badge.fury.io/js/%40jscad%2Fregl-renderer.svg)](https://www.npmjs.com/package/@jscad/regl-renderer) [![NPM downloads](https://img.shields.io/npm/dw/@jscad/regl-renderer)](https://www.npmjs.com/package/@jscad/regl-renderer) [![Build Status](https://travis-ci.org/jscad/OpenJSCAD.org.svg?branch=master)](https://travis-ci.org/jscad/OpenJSCAD.org) [![Stability](https://img.shields.io/badge/stability-stable-success)](https://github.com/emersion/stability-badges#stable) [![License](https://img.shields.io/github/license/jscad/OpenJSCAD.org)](https://github.com/jscad/OpenJSCAD.org/blob/master/LICENSE) [![User Group](https://img.shields.io/badge/maintained%20by-user%20group-blue)](https://openjscad.nodebb.com/) [![Lerna](https://img.shields.io/badge/maintained%20with-lerna-blue)](https://lerna.js.org/) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-blue)](https://standardjs.com) [![Backers](https://img.shields.io/opencollective/backers/openjscad)](https://opencollective.com/openjscad) [![Sponsors](https://img.shields.io/opencollective/sponsors/openjscad)](https://opencollective.com/openjscad) <a href="https://opencollective.com/openjscad"><img src="https://opencollective.com/openjscad/donate/button.png?color=blue" alt="Open Collective"></a> ## What is it? - webgl renderer (barebones, uses regl) - small, compact, and fast - works in all browsers - works in Node.js projects (headless rendering to PNG images) ## Installation This package is published and available for download via [NPM](https://www.npmjs.com/org/jscad) ``` npm install @jscad/regl-renderer ``` In addition this package is hosted at [UNPKG](https://unpkg.com/), and can be imported directly into webpages. ``` <script language="javascript" src="https://unpkg.com/@jscad/regl-renderer"</script> ``` ## Usage ### Node.js (headless) Install the following packages manually. NOTE: There are issues with continous integration testing, so 'gl' is not installed initially. ``` npm install gl ``` Try the demo by running ```npm run demo-cli```. If all goes well you should end up with an image (test.png) that renders the demo design. The demo code can be found in 'demo-cli.js' ### Browsers From a browser, try opening the file 'demo.html'. This should show the demo design. ### Developers Run the development web server using ```npm run dev```, then open the URL shown. If all goes well you should end up with a web page with a rotating camera (no mouse controls) that displays the demo design (a few solids). After making changes, all tests must pass. Run ```npm test``` ## License [The MIT License (MIT)](../../../LICENSE) (unless specified otherwise)