aframe-lensflare-component
A component to add a configurable lens-flare (and optional light) to an entity that wraps THREE.JS Lensflares.
Examples: See Here
For A-Frame.
API
Property | Description | Default Value |
---|---|---|
src | Asset Image to use | none |
createLight | Whether to create a light along with this flare | true |
position | This is the position of the flare. | true |
relative | Whether to position this flare relative to the parent entity (The position property above becomes an offset ) | true |
target | DOM id of the object to point the Flare's spotlight at | none |
size | Size of the flare graphic (Use power of 2 images for best results) | 500 |
intensity | If using createLight:true , this is the intensity of the light emitted |
5 |
lightType | If using createLight:true , this is a string corresponding to A-Frame light types. Either 'directional', 'point', 'spot' |
'spot' |
lightColor | If createLight:true , Color of the light and (currently) flare tint |
'rgb(255, 255, 255)' |
lightDistance | Distance of the light (if enabled) | 500 |
lightAngle | Maximum extent of the light in radians (from its direction). Valid for directional and spotlight type lights | PI/3 |
lightPenumbra | If using createLight:true : Percent of the light cone that is attenuated due to penumbra. Takes values between zero and 1. Valid only for spotlights |
0.077 |
lightDecay | If using createLight:true : The amount the light dims along the light's distance |
1 |
Installation
Browser
Install and use by directly including the browser files:
My A-Frame Scene
### npm
Install via npm:
npm install aframe-lensflare-component
Then require and use.
;; //Or if supported by your stack (babel, webpack): ;;
TODO
- Seperate Flare colorisation and Light Color