-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c8fe213
commit 03d5193
Showing
4 changed files
with
110 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Panorama Renderer | ||
|
||
The panorama-renderer is a lightweight package that allows you to render equirectangular panoramas using WebGL. | ||
|
||
## Getting started | ||
|
||
### Installing | ||
|
||
Add `@mediamonks/panorama-renderer` to your project: | ||
|
||
```sh | ||
npm i @mediamonks/panorama-renderer | ||
``` | ||
## Basic usage | ||
|
||
Simple panorama rendering on canvas. Make sure the image is loaded before creating the renderer. | ||
|
||
```ts | ||
import { PanoramaRenderer } from '@mediamonks/panorama-renderer'; | ||
|
||
const renderer = PanoramaRenderer(wrapperElement, image, { loop: true }); | ||
``` | ||
|
||
## Building | ||
|
||
In order to build seng-event, ensure that you have [Git](http://git-scm.com/downloads) | ||
and [Node.js](http://nodejs.org/) installed. | ||
|
||
Clone a copy of the repo: | ||
```sh | ||
git clone https://github.com/mediamonks/panorama-renderer.git | ||
``` | ||
|
||
Change to the image-effect-renderer directory: | ||
```sh | ||
cd panorama-renderer | ||
``` | ||
|
||
Install dev dependencies: | ||
```sh | ||
npm i | ||
``` | ||
|
||
Build package: | ||
```sh | ||
npm run build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,14 @@ | ||
{ | ||
"name": "@mediamonks/panorama-renderer", | ||
"version": "1.0.0", | ||
"description": "The image-effect-renderer is lightweight package that allows you to run WebGL fragment shaders in your website using WebGL. It can be used to apply effects to HTML image or video sources.", | ||
"description": "The panorama-renderer is a lightweight package that allows you to render equirectangular panoramas using WebGL.", | ||
"keywords": [ | ||
"fragment shader", | ||
"webgl", | ||
"image", | ||
"video", | ||
"effect", | ||
"shadertoy", | ||
"glsl", | ||
"shader", | ||
"oneshader" | ||
"panorama", | ||
"360", | ||
"equirectangular", | ||
"equirectangular panorama" | ||
], | ||
"repository": "[email protected]:mediamonks/panorama-renderer.git", | ||
"author": "Reinder Nijhoff <[email protected]>", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters