https://github.com/takahirox/aframe-outline

Two-pass Outline effect component for A-Frame
https://github.com/takahirox/aframe-outline

a-frame aframe aframe-outline javascript outline vr website

Last synced: 3 months ago
JSON representation

Two-pass Outline effect component for A-Frame

• Host: GitHub
• URL: https://github.com/takahirox/aframe-outline
• Owner: takahirox
• License: mit
• Created: 2016-12-30T05:28:18.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-01T09:00:06.000Z (about 7 years ago)
• Last Synced: 2024-10-28T13:55:47.919Z (3 months ago)
• Topics: a-frame, aframe, aframe-outline, javascript, outline, vr, website
• Language: JavaScript
• Homepage: https://cdn.rawgit.com/takahirox/aframe-outline/v1.1.0/index.html
• Size: 479 KB
• Stars: 34
• Watchers: 4
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A-Frame Outline component

aframe-outline is two-pass Outline effect component for A-Frame.

![screenshot](./screenshot.png "screenshot")

## Demo

[Demo](https://rawgit.com/takahirox/aframe-outline/v1.1.1/index.html)

## Properties

### aframe-outline

| Properties  | type   | Default Value | Description |

| ----------- | ------ | ------------- | ----------- |

| thickness   | number | 0.003         | Outline thickness. |

| color       | color  | '#000'        | Outline color. |

| alpha       | number | 1.0           | Outline alpha. |

## Browser

### How to use

To apply outline effect in a scene, add `outline` attribute in `` like ``.

```html

  

  

  

    

      

    

    

    

  

```

## NPM

### How to install

```

$ npm install aframe-outline

```

### How to build

```

$ npm install

$ npm run all

```

### How to load

```

require('aframe');

require('aframe-outline');

```