Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
cinder::Capture Class Reference

#import <Capture.h>

List of all members.

Classes

class  Device
struct  Obj

Public Types

typedef std::shared_ptr< DeviceDeviceRef
typedef std::string DeviceIdentifier
typedef int DeviceIdentifier

Public Member Functions

() - Capture
() - Capture
() - ~Capture
(void) - start
 Begin capturing video.
(void) - stop
 Stop capturing video.
(bool) - isCapturing
 Is the device capturing video.
(bool) - checkNewFrame
 Returns whether there is a new video frame available since the last call to checkNewFrame
(int32_t) - getWidth
 Returns the width of the captured image in pixels.
(int32_t) - getHeight
 Returns the height of the captured image in pixels.
(Vec2i- getSize
 Returns the size of the captured image in pixels.
(float) - getAspectRatio
 Returns the aspect ratio of the capture imagee, which is its width / height.
(Area- getBounds
 Returns the bounding rectangle of the capture imagee, which is Area( 0, 0, width, height )
(Surface8u- getSurface
 Returns a Surface representing the current captured frame.
(const Capture::DeviceRef- getDevice
 Returns the associated Device for this instace of Capture.

Static Public Member Functions

(static const std::vector
< DeviceRef > &) 
+ getDevices
 Returns a vector of all Devices connected to the system. If forceRefresh then the system will be polled for connected devices.
(static DeviceRef+ findDeviceByName
 Finds a particular device based on its name.
(static DeviceRef+ findDeviceByNameContains
 Finds the first device whose name contains the string nameFragment.

Protected Attributes

std::shared_ptr< ObjmObj
typedef std::shared_ptr< Obj >
Capture::* 
unspecified_bool_type
 Emulates shared_ptr-like behavior.
() - operator unspecified_bool_type
 Emulates shared_ptr-like behavior.
(void) - reset
 Emulates shared_ptr-like behavior.

Member Typedef Documentation

- (typedef shared_ptr<Device>) cinder:
- (typedef string) cinder:
- (typedef int) Capture:
- (typedef shared_ptr<Obj>) Capture:

Emulates shared_ptr-like behavior.


Constructor & Destructor Documentation

- cinder:
- cinder: (int32_t)  width
(int32_t)  height
(const DeviceRef device = DeviceRef() 
- cinder:

Member Function Documentation

- (void) Capture:

Begin capturing video.

- (void) Capture:

Stop capturing video.

- (bool) Capture:

Is the device capturing video.

- (bool) Capture: const

Returns whether there is a new video frame available since the last call to checkNewFrame

- (int32_t) Capture: const

Returns the width of the captured image in pixels.

- (int32_t) Capture: const

Returns the height of the captured image in pixels.

- (Vec2i) Capture: const

Returns the size of the captured image in pixels.

- (float) Capture: const

Returns the aspect ratio of the capture imagee, which is its width / height.

- (Area) Capture: const

Returns the bounding rectangle of the capture imagee, which is Area( 0, 0, width, height )

- (Surface8u) Capture: const

Returns a Surface representing the current captured frame.

- (const DeviceRef) cinder: const

Returns the associated Device for this instace of Capture.

+ (const vector< DeviceRef > &) cinder: (bool)  forceRefresh = false

Returns a vector of all Devices connected to the system. If forceRefresh then the system will be polled for connected devices.

+ Capture: (const std::string &)  name

Finds a particular device based on its name.

+ Capture: (const std::string &)  nameFragment

Finds the first device whose name contains the string nameFragment.

- cinder: const

Emulates shared_ptr-like behavior.

- (void) Capture:

Emulates shared_ptr-like behavior.


Member Data Documentation

- std: [protected]

The documentation for this class was generated from the following files: