ofxsCore.h File Reference

#include "ofxCore.h"
#include "ofxImageEffect.h"
#include "ofxInteract.h"
#include "ofxKeySyms.h"
#include "ofxMemory.h"
#include "ofxMessage.h"
#include "ofxMultiThread.h"
#include "ofxParam.h"
#include "ofxProperty.h"
#include <assert.h>
#include <vector>
#include <string>
#include <map>
#include <exception>
#include <stdexcept>
#include <sstream>

Go to the source code of this file.

Namespaces
namespace	OFX
namespace	OFX::Exception
namespace	OFX::Memory
Classes
struct	OfxRGBColourB
	Defines an 8 bit per component RGB pixel. More...
struct	OfxRGBColourS
	Defines a 16 bit per component RGB pixel. More...
struct	OfxRGBColourF
	Defines a floating point component RGB pixel. More...
struct	OfxRGBColourD
	Defines a double precision floating point component RGB pixel. More...
struct	Ofx3DPointI
	Defines an integer 3D point. More...
struct	Ofx3DPointD
	Defines a double precision 3D point. More...
class	OFX::Exception::Suite
	thrown when a suite returns a dud status code More...
class	OFX::Exception::PropertyUnknownToHost
	Exception indicating that a host doesn't know about a property that is should do. More...
class	OFX::Exception::PropertyValueIllegalToHost
	exception indicating that the host thinks a property has an illegal value More...
class	OFX::Exception::TypeRequest
	exception indicating a request for a named thing exists (eg: a param), but is of the wrong type, should never make it back to the main entry indicates a logical error in the code. Asserts are raised in debug code in these situations. More...
class	OFX::Exception::HostInadequate
	exception indicating a required host feature is missing More...
class	OFX::PropertySet
	This class wraps up an OFX property set. More...
Defines
#define	mDeclareProtectedAssignAndCC(CLASS)
	Nasty macro used to define empty protected copy ctors and assign ops.
Enumerations
enum	PropertyTypeEnum { ePointer, eInt, eString, eDouble }
	Enumerates the different types a property can be. More...
enum	InstanceChangeReason { eChangeUserEdit, eChangePluginEdit, eChangeTime }
	Enumerates the reasons a plug-in instance may have had one of its values changed. More...
Functions
char *	mapStatusToString (OfxStatus stat)
	maps status to a string
void	throwSuiteStatusException (OfxStatus stat) throw (OFX::Exception::Suite, std::bad_alloc)
	Throws an OFX::Exception depending on the status flag passed in.
void	throwHostMissingSuiteException (std::string name) throw (OFX::Exception::Suite)
void *	alloc (size_t nBytes, ImageEffect *handle=0) throw (std::bad_alloc)
	allocate n bytes, returns a pointer to it
void	free (void *ptr) throw ()
	free n previously allocated memory

---

Define Documentation

#define mDeclareProtectedAssignAndCC (  CLASS   )

Value: CLASS &operator=(const CLASS &v1) {assert(false); return *this;} \ CLASS(const CLASS &v) {assert(false); } Nasty macro used to define empty protected copy ctors and assign ops.

---

Enumeration Type Documentation

enum InstanceChangeReason

Enumerates the reasons a plug-in instance may have had one of its values changed. Enumeration values: eChangeUserEdit  A user actively editted something in the plugin, eg: changed the value of an integer param on an interface. eChangePluginEdit  The plugin's own code changed something in the instance, eg: a callback on on param settting the value of another. eChangeTime  The current value of a parameter has changed because the param animates and the current time has changed.

enum PropertyTypeEnum

Enumerates the different types a property can be. Enumeration values: ePointer  eInt  eString  eDouble

---

Function Documentation

void* alloc (  size_t  nBytes, ImageEffect *  handle = 0 )  throw (std::bad_alloc)

allocate n bytes, returns a pointer to it

void OFX::Memory::free (  void *  ptr  )  throw ()

free n previously allocated memory ptr - pointer previously returned by OFX::Memory::allocate

char * OFX::mapStatusToString (  OfxStatus  stat  )

maps status to a string

void OFX::throwHostMissingSuiteException (  std::string  name  )  throw (OFX::Exception::Suite)

void OFX::throwSuiteStatusException (  OfxStatus  stat  )  throw (OFX::Exception::Suite, std::bad_alloc)

Throws an OFX::Exception depending on the status flag passed in.

---