ofTypesfile

Typedefs

ofMutex typedef

Poco::FastMutex ofMutex

A typedef for a cross-platform mutex.

A mutex is used to lock data when it is accessible from multiple threads. Locking data with a mutex prevents data-races, deadlocks and other problems associated with concurrent access to data.

The mutex can be locked with a call to ofMutex::lock(). All calls to ofMutex::lock() must be paired with a call to ofMutex::unlock().

ofMutex myMutex; // Your member mutex.
int mySharedData; // Your member shared data.
// ...
// A method to modify some shared data.
void modifyMySharedData() {
    myMutex.lock(); // Lock the mutex.
    mySharedData++; // Modify the shared data.
    myMutex.unlock(); // Unlock the mutex;
}

Warning: Currently ofMutex is a typedef for Poco::FastMutex a fast cross- platform mutex. In a future version of OF, Poco::FastMutex will be replaced by std::mutex.

See Also: http://www.cplusplus.com/reference/mutex/mutex/; http://www.appinf.com/docs/poco/Poco.FastMutex.html

ofScopedLock typedef

Poco::FastMutex::ScopedLock ofScopedLock

A typedef for a cross-platform scoped mutex.

Normally ofMutex requres explicit calls to ofMutex::lock() and ofMutex::unlock() to lock and release the mutex. Sometimes, despite best efforts, developers forget to unlock a mutex, leaving the data inaccessible. ofScopedLock makes ofMutex easier to use by calling ofMutex::unlock when the scoped lock's destructor is called. Since the destructor is called when a variable goes out of scope, we call this a "scoped lock". A "scoped lock" is sometimes known as a "lock guard" as well.

ofScopedLock is used to lock and unlock an existing ofMutex.

ofMutex myMutex; // Your member mutex.
int mySharedData; // Your member shared data.
// ...
// A method to modify some shared data.
void modifyMySharedData() {
    ofScopedLock lock(myMutex); // Lock the mutex.
    mySharedData++; // Modify the shared data.
    // `lock` will unlock the mutex when it goes out of scope. 
}

Warning: Currently ofScopedLock is a typedef for Poco::FastMutex::ScopedLock a convenient wrapper fo Poco::FastMutex. In a future version of OF, Poco::FastMutex::ScopedLock by std::lock_guard.

See Also: http://en.cppreference.com/w/cpp/thread/lock_guard; http://www.appinf.com/docs/poco/Poco.ScopedLock.html; ofMutex

Functions

dynamic_pointer_cast ()

ofPtr dynamic_pointer_cast(const ofPtr< _Tp1 > &__r)

ofSerialDeviceInfoclass

Describes a Serial device, including ID, name and path.

Friends

ofSerial friend

friend class ofSerial

undefined

Functions

ofSerialDeviceInfo ()

ofSerialDeviceInfo(string devicePathIn, string deviceNameIn, int deviceIDIn)

Construct an ofSerialDeviceInfo with parameters.

Parameters

devicePathIn	The path to the device.
deviceNameIn	The name of the device.
deviceIDIn	The ID of the device.

ofSerialDeviceInfo()

Construct an undefined serial device.

getDevicePath ()

string getDevicePath()

Gets the path to the device.

Example: /dev/tty.cu/usbdevice-a440.

Returns: the device path.

getDeviceName ()

string getDeviceName()

Gets the name of the device.

Example: usbdevice-a440 or COM4.

Returns: the device name.

getDeviceID ()

int getDeviceID()

Gets the ID of the device.

Example: 0,1,2,3 etc.

Returns: the device ID.

ofStyleclass

Contains general information about the style of ofGraphics elements such as color, line width and others.

Attributes

color variable

ofColor color

The color used when rendering.

This style depends on the state of the ofStyle::bFill.

bgColor variable

ofColor bgColor

The background color used when rendering.

polyMode variable

ofPolyWindingMode polyMode

The current rendering mode for polygons.

ofPolyWindingMode determines how ovelapping parts of the same polygon are rendered.

See Also: ofPolyWindingMode

rectMode variable

ofRectMode rectMode

Determine how some shapes are anchored (e.g. ofDrawEllipse).

The rectMode applies to several shapes, including ofDrawRectangle and ofDrawEllipse. If the current rectMode is OF_RECTMODE_CENTER, the rendered shape will be drawn with x, y in the center of the shape. If the current rectMode is OF_RECTMODE_CORNER, the rendered shape will be drawn with the x, y in the upper-left-hand corner of the shape.

bFill variable

bool bFill

True if the renderer should fill a rendered shape.

If true, the renderer will fill the rendered shape. If false, the renderer will draw the outline of the rendered shape.

drawBitmapMode variable

ofDrawBitmapMode drawBitmapMode

The render mode for bitmaps (e.g. ofDrawBitmapString).

See Also: ofDrawBitmapString(const T& textString, float x, float y)

blendingMode variable

ofBlendMode blendingMode

The blending mode.

smoothing variable

bool smoothing

True if anti-aliasing is enabled.

circleResolution variable

int circleResolution

sphereResolution variable

int sphereResolution

curveResolution variable

int curveResolution

lineWidth variable

float lineWidth

The width of rendered lines.

Warning: This is not currently implemented in modern OF renderers.

Functions

ofStyle ()

ofStyle()

Create a default ofStyle.

~ofStyle ()

~ofStyle()

Destroy the ofStyle.

ofVideoFormatclass

A structure describing attributes of a video format.

An ofVideoFormat is used to describe the size, pixel format and frame rates offered by a video device.

See Also: ofVideoDevice

Attributes

pixelFormat variable

ofPixelFormat pixelFormat

The pixel format of the video format.

width variable

int width

The width of the video format in pixels.

height variable

int height

The height of the video format in pixels.

framerates variable

vector< float > framerates

A list of framerates for this video format in frames per second.

ofVideoDeviceclass

A structure describing attributes of a video device.

An ofVideoDevice can represent a camera, grabber or other frame source.

Attributes

id variable

int id

The video device ID.

deviceName variable

string deviceName

The video device name.

hardwareName variable

string hardwareName

The video device hardware name.

formats variable

ofVideoFormat formats

A list of video device formats provided by the device.

See Also: ofVideoFormat

bAvailable variable

bool bAvailable

Is true if this video device is available.

ofPtrclass

Functions

ofPtr () Use std::shared_ptr instead

void ofPtr()

void ofPtr(Tp1 *__p)

ofPtr(Tp1 *__p, _Deleter __d)

ofPtr(Tp1 *__p, _Deleter __d, const _Alloc &__a)

ofPtr(const ofPtr< Tp1 > &__r, T *__p)

ofPtr(const ofPtr< Tp1 > &__r)

ofPtr(const std::shared_ptr< Tp1 > &__r)

ofPtr(const std::weak_ptr< Tp1 > &__r)

ofPtr(const ofPtr< Tp1 > &__r, std::__dynamic_cast_tag)

ofPtr()

ofPtr(Tp1 *__p)