Comparing version 0.0.117 to 1.0.0
{ | ||
"name": "ogl", | ||
"version": "0.0.117", | ||
"version": "1.0.0", | ||
"description": "WebGL Library", | ||
"exports": "./src/index.mjs", | ||
"main": "./src/index.js", | ||
"exports": "./src/index.js", | ||
"type": "module", | ||
@@ -7,0 +8,0 @@ "sideEffects": false, |
@@ -23,4 +23,2 @@ <p align="center"> | ||
⚠️ *Note: currently in alpha, so expect breaking changes.* | ||
[See the Examples!](https://oframe.github.io/ogl/examples) | ||
@@ -36,7 +34,5 @@ | ||
⚠️ *Note: Typescript users may be interested in using a [TS fork of the library](https://github.com/nshen/ogl-typescript), kindly maintained by [nshen](https://github.com/nshen).* | ||
## Install | ||
[Download](https://github.com/oframe/ogl/archive/master.zip) | ||
[Download](https://github.com/oframe/ogl/archive/master.zip) | ||
@@ -65,8 +61,8 @@ **or** | ||
Component | Size (minzipped) | ||
------------ | -------------: | ||
Core | 8kb | ||
Math | 6kb | ||
Extras | 15kb | ||
Total | 29kb | ||
| Component | Size (minzipped) | | ||
| --------- | ---------------: | | ||
| Core | 8kb | | ||
| Math | 6kb | | ||
| Extras | 15kb | | ||
| Total | 29kb | | ||
@@ -80,12 +76,15 @@ With tree-shaking applied in a build step, one can expect the final size to be much lighter than the values above. | ||
```js | ||
import { ... } from './path/to/src/index.mjs'; | ||
import { ... } from './path/to/src/index.js'; | ||
``` | ||
Else if using a bundler or import maps with node modules, then import directly from the installed node module. | ||
```js | ||
import { ... } from 'ogl'; | ||
``` | ||
By default, the ES source modules are loaded (`src/index.mjs`). | ||
By default, the ES source modules are loaded (`src/index.js`). | ||
As another alternative, you could load from a CDN, using either the jsdelivr, unpkg or skypack services. | ||
```js | ||
@@ -96,2 +95,3 @@ import { ... } from 'https://cdn.jsdelivr.net/npm/ogl'; | ||
``` | ||
If you take this route, I would highly recommend defining a specific version (append `@x.x.x`) to avoid code breaking, rather than fetching the latest version, as per the above links. | ||
@@ -156,2 +156,3 @@ | ||
``` | ||
Here you can play with the above template live in a codesandbox | ||
@@ -230,11 +231,12 @@ https://codesandbox.io/s/ogl-5i69p | ||
The **Core** is made up of the following: | ||
- Geometry.js | ||
- Program.js | ||
- Renderer.js | ||
- Camera.js | ||
- Transform.js | ||
- Mesh.js | ||
- Texture.js | ||
- RenderTarget.js | ||
- Geometry.js | ||
- Program.js | ||
- Renderer.js | ||
- Camera.js | ||
- Transform.js | ||
- Mesh.js | ||
- Texture.js | ||
- RenderTarget.js | ||
Any additional layers of abstraction will be included as **Extras**, and not part of the core as to reduce bloat. These provide a wide breadth of functionality, ranging from simple to advanced. | ||
@@ -267,2 +269,2 @@ | ||
For more information, please refer to <https://unlicense.org> | ||
For more information, please refer to <https://unlicense.org> |
@@ -550,3 +550,3 @@ const EPSILON = 0.000001; | ||
export const getRotation = (function () { | ||
const temp = [0, 0, 0]; | ||
const temp = [1, 1, 1]; | ||
@@ -553,0 +553,0 @@ return function (out, mat) { |
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
0
263
335838