FCam::Flash Class Reference

An abstract base class for camera flashes. More...

Inheritance diagram for FCam::Flash:

Collaboration diagram for FCam::Flash:

List of all members.

Classes
class	FireAction
	An action to fire the flash during an exposure. More...
class	Tags
	A flash adds the tags "flash.brightness", "flash.start", "flash.duration", and "flash.peak", as described below. More...
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
	What was the brightness of the flash at some time in the recent past.
virtual void	tagFrame (Frame)=0
	Attach tags describing the state of the flash during a frame to a Frame.

---

Detailed Description

An abstract base class for camera flashes.

---

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::N9::Flash.

virtual float FCam::Flash::maxBrightness

(

)

[pure virtual]

The maximum brightness setting the flash.

The units are platform specific.

Implemented in FCam::N9::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::N9::Flash.

virtual int FCam::Flash::fireLatency

(

)

[pure virtual]

How long after I call fire does the flash actually fire.

Implemented in FCam::N9::Flash.

virtual float FCam::Flash::getBrightness

(

Time

t

)

[pure virtual]

What was the brightness of the flash at some time in the recent past.

Implemented in FCam::N9::Flash.

virtual void FCam::Flash::tagFrame

(

Frame

)

[pure virtual]

Attach tags describing the state of the flash during a frame to a Frame.

You should never need to call this function - it's done for you by the Sensor.

Implements FCam::Device.

Implemented in FCam::N9::Flash.