FCam::Flash Class Reference
An abstract base class for camera flashes. More...
#include <Flash.h>
Public Member Functions | |
| virtual int | minDuration ()=0 |
| Minimum flash duration in microseconds. | |
| virtual int | maxDuration ()=0 |
| Maximum flash duration in microseconds. | |
| virtual float | minBrightness ()=0 |
| The minimum brightness setting of the flash. | |
| virtual float | maxBrightness ()=0 |
| The maximum brightness setting the flash. | |
| virtual void | fire (float brightness, int duration)=0 |
| Fire the flash with a given brightness for a given number of microseconds. | |
| virtual int | fireLatency ()=0 |
| How long after I call fire does the flash actually fire. | |
| virtual float | getBrightness (Time t)=0 |
| How much light (in lumens) was the flash adding to the scene at some time in the recent past. | |
| virtual float | getBrightness (Time t1, Time t2)=0 |
| How much photometric energy (in lumen-seconds, or Talbots), did the flash add to the scene between the two given times. | |
| virtual void | tagFrame (Frame *)=0 |
| Add tags to a frame describing if the flash fired during that frame, and how much photometric energy it added if it did. | |
Classes | |
| class | FireAction |
| An action to fire the flash during an exposure. More... | |
| class | Tags |
| The tags which a flash attaches to a frame. More... | |
Detailed Description
An abstract base class for camera flashes.
Definition at line 15 of file Flash.h.
Member Function Documentation
| virtual float FCam::Flash::minBrightness | ( | ) | [pure virtual] |
The minimum brightness setting of the flash.
The units are platform specific.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
| virtual float FCam::Flash::maxBrightness | ( | ) | [pure virtual] |
The maximum brightness setting the flash.
The units are platform specific.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
| virtual void FCam::Flash::fire | ( | float | brightness, | |
| int | duration | |||
| ) | [pure virtual] |
Fire the flash with a given brightness for a given number of microseconds.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
| virtual int FCam::Flash::fireLatency | ( | ) | [pure virtual] |
How long after I call fire does the flash actually fire.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
| virtual float FCam::Flash::getBrightness | ( | Time | t | ) | [pure virtual] |
How much light (in lumens) was the flash adding to the scene at some time in the recent past.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
How much photometric energy (in lumen-seconds, or Talbots), did the flash add to the scene between the two given times.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
| virtual void FCam::Flash::tagFrame | ( | Frame * | ) | [pure virtual] |
Add tags to a frame describing if the flash fired during that frame, and how much photometric energy it added if it did.
Implements FCam::Device.
Implemented in FCam::F2::Flash, and FCam::N900::Flash.
The documentation for this class was generated from the following files:
