Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.13 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.13 KB
Raw

aframe-scrim-component

Version License

A Theatrical Scrim for A-Frame

For A-Frame.

API

Property Description Default Value
easing type of easing to use easeInOutCirc
durration length of time (ms) for fading 900

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.9.0/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-scrim-component/dist/aframe-scrim-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity scrim="durration: 700"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-scrim-component

Then require and use.

require('aframe');
require('aframe-scrim-component');