Skip to content

Commit 2520d27

Browse files
committed
add README
1 parent db572cf commit 2520d27

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# aframe-htmltexture-component
2+
3+
[![Version](https://img.shields.io/npm/v/aframe-htmltexture-component.svg)](https://preview.npmjs.com/package/aframe-htmltexture-component)
4+
[![Repo on GitHub](https://img.shields.io/badge/repo-GitHub-3D76C2.svg)](https://github.com/scenevr/aframe-htmltexture-component)
5+
6+
HTML Texture component for A-Frame VR.
7+
8+
![](./examples/example.png)
9+
10+
## Usage
11+
12+
Register `aframe-draw-component` first and import `aframe-htmltexture-component`
13+
14+
```js
15+
import drawComponent from 'aframe-draw-component'
16+
AFRAME.registerComponent("draw", drawComponent.component);
17+
18+
import 'aframe-htmltexture-component'
19+
```
20+
21+
In your template :
22+
23+
```html
24+
<div id="hello">
25+
Hello <b>World !</b>
26+
</div>
27+
28+
<a-entity geometry="primitive: box" htmltexture="asset: #hello" position="0 2 -4" draw="width: 128; height: 512;"></a-entity>
29+
```
30+
31+
## See also
32+
33+
- [aframe-draw-component](https://github.com/maxkrieger/aframe-draw-component)
34+
- [aframe-html-shader](https://github.com/mayognaise/aframe-html-shader)
35+
36+

examples/example.png

36.9 KB
Loading

0 commit comments

Comments
 (0)