OFX::Private Namespace Reference

---

Detailed Description

OFX::Private namespace, for things private to the support library code here generally calls image effect class members.

Typedefs
typedef std::map< ContextEnum, ImageEffectDescriptor * >	EffectContextMap
	the set of descriptors, one per context used by kOfxActionDescribeInContext, 'eContextNone' is the one used by the kOfxActionDescribe
typedef std::map< std::string, EffectContextMap >	EffectDescriptorMap
Functions
OfxStatus	mainEntryStr (const char *actionRaw, const void *handleRaw, OfxPropertySetHandle inArgsRaw, OfxPropertySetHandle outArgsRaw, const char *plugname)
	The main entry point for the plugin.
OfxStatus	interactMainEntry (const char *actionRaw, const void *handleRaw, OfxPropertySetHandle inArgsRaw, OfxPropertySetHandle outArgsRaw, InteractDescriptor &desc)
	The main entry for image effect overlays.
void	fetchHostDescription (OfxHost *host)
	Creates the global host description and sets its properties.
OFX::PropertySet	fetchEffectProps (OfxImageEffectHandle handle)
	fetch the prop set from the effect handle
void	loadAction (void)
	Support lib function called on an ofx load action.
void	unloadAction (const char *id)
	Library side unload action, this fetches all the suite pointers.
ImageEffect *	retrieveImageEffectPointer (OfxImageEffectHandle handle)
	fetches our pointer out of the props on the handle
void	checkMainHandles (const std::string &action, const void *handle, OfxPropertySetHandle inArgsHandle, OfxPropertySetHandle outArgsHandle, bool handleCanBeNull, bool inArgsCanBeNull, bool outArgsCanBeNull)
	Checks the handles passed into the plugin's main entry point.
void	getRenderActionArguments (RenderArguments &args, OFX::PropertySet inArgs)
	Fetches the arguments used in a render action 'inargs' property set into a POD struct.
void	renderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render action, fetches relevant properties and calls the client code.
void	beginSequenceRenderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
void	endSequenceRenderAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
bool	isIdentityAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs)
	Library side render begin sequence render action, fetches relevant properties and calls the client code.
bool	regionOfDefinitionAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs)
	Library side get region of definition function.
bool	regionsOfInterestAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs, const char *plugname)
	Library side get regions of interest function.
bool	framesNeededAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs, OFX::PropertySet &outArgs, const char *plugname)
	local class to set the roi of a clip ctor did we set something ? set the RoI of the clip Library side frames needed action
bool	getTimeDomainAction (OfxImageEffectHandle handle, OFX::PropertySet &outArgs)
	local class to set the frames needed from a clip property set to set values in map holding a bunch of frame ranges, one for each clip ctor set the RoI of the clip write frameRanges_ back to the property set Library side get regions of interest function
bool	clipPreferencesAction (OfxImageEffectHandle handle, OFX::PropertySet &outArgs, const char *plugname)
	Library side get regions of interest function.
void	beginInstanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side begin instance changed action.
void	instanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side instance changed action.
void	endInstanceChangedAction (OfxImageEffectHandle handle, OFX::PropertySet inArgs)
	Library side end instance changed action.
void	setHost (OfxHost *host)
	The plugin function that gets passed the host structure.
Interact *	retrieveInteractPointer (OfxInteractHandle handle)
	fetches our pointer out of the props on the handle
OfxStatus	interactMainEntry (const std::string &action, OfxInteractHandle handle, PropertySet inArgs, PropertySet outArgs)
	The common entry point used by all interacts.
void	unloadAction (void)
	Support lib function called on an ofx unload action.
Variables
OfxHost *	gHost = 0
	Pointer to the host.
OfxImageEffectSuiteV1 *	gEffectSuite = 0
	Pointer to the effect suite.
OfxPropertySuiteV1 *	gPropSuite = 0
	Pointer to the property suite.
OfxInteractSuiteV1 *	gInteractSuite = 0
	Pointer to the interact suite.
OfxParameterSuiteV1 *	gParamSuite = 0
	Pointer to the parameter suite.
OfxMemorySuiteV1 *	gMemorySuite = 0
	Pointer to the general memory suite.
OfxMultiThreadSuiteV1 *	gThreadSuite = 0
	Pointer to the threading suite.
OfxMessageSuiteV1 *	gMessageSuite = 0
	Pointer to the message suite.
OfxProgressSuiteV1 *	gProgressSuite = 0
	Pointer to the optional progress suite.
OfxTimeLineSuiteV1 *	gTimeLineSuite = 0
	Pointer to the optional progress suite.
EffectDescriptorMap	gEffectDescriptors
int	gLoadCount = 0
	Keeps count of how many times load/unload have been called.

---

Typedef Documentation

typedef std::map<ContextEnum, ImageEffectDescriptor*> OFX::Private::EffectContextMap

the set of descriptors, one per context used by kOfxActionDescribeInContext, 'eContextNone' is the one used by the kOfxActionDescribe

typedef std::map<std::string, EffectContextMap> OFX::Private::EffectDescriptorMap

---

Function Documentation

void beginInstanceChangedAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side begin instance changed action.

void beginSequenceRenderAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side render begin sequence render action, fetches relevant properties and calls the client code.

void checkMainHandles (  const std::string &  action, const void *  handle, OfxPropertySetHandle  inArgsHandle, OfxPropertySetHandle  outArgsHandle, bool  handleCanBeNull, bool  inArgsCanBeNull, bool  outArgsCanBeNull )

Checks the handles passed into the plugin's main entry point.

bool clipPreferencesAction (  OfxImageEffectHandle  handle, OFX::PropertySet &  outArgs, const char *  plugname )

Library side get regions of interest function.

void endInstanceChangedAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side end instance changed action.

void endSequenceRenderAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side render begin sequence render action, fetches relevant properties and calls the client code.

OFX::PropertySet OFX::Private::fetchEffectProps (  OfxImageEffectHandle  handle  )

fetch the prop set from the effect handle

void fetchHostDescription (  OfxHost *  host  )

Creates the global host description and sets its properties.

bool framesNeededAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs, OFX::PropertySet &  outArgs, const char *  plugname )

local class to set the roi of a clip ctor did we set something ? set the RoI of the clip Library side frames needed action

void getRenderActionArguments (  RenderArguments &  args, OFX::PropertySet  inArgs )  [static]

Fetches the arguments used in a render action 'inargs' property set into a POD struct.

bool getTimeDomainAction (  OfxImageEffectHandle  handle, OFX::PropertySet &  outArgs )

local class to set the frames needed from a clip property set to set values in map holding a bunch of frame ranges, one for each clip ctor set the RoI of the clip write frameRanges_ back to the property set Library side get regions of interest function

void instanceChangedAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side instance changed action.

OfxStatus interactMainEntry (  const std::string &  action, OfxInteractHandle  handle, PropertySet  inArgs, PropertySet  outArgs )

The common entry point used by all interacts.

OfxStatus OFX::Private::interactMainEntry (  const char *  actionRaw, const void *  handleRaw, OfxPropertySetHandle  inArgsRaw, OfxPropertySetHandle  outArgsRaw, InteractDescriptor &  desc )

The main entry for image effect overlays.

bool isIdentityAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs, OFX::PropertySet &  outArgs )

Library side render begin sequence render action, fetches relevant properties and calls the client code.

void OFX::Private::loadAction (  void   )

Support lib function called on an ofx load action.

OfxStatus OFX::Private::mainEntryStr (  const char *  actionRaw, const void *  handleRaw, OfxPropertySetHandle  inArgsRaw, OfxPropertySetHandle  outArgsRaw, const char *  plugname )

The main entry point for the plugin.

bool regionOfDefinitionAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs, OFX::PropertySet &  outArgs )

Library side get region of definition function.

bool regionsOfInterestAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs, OFX::PropertySet &  outArgs, const char *  plugname )

Library side get regions of interest function.

void renderAction (  OfxImageEffectHandle  handle, OFX::PropertySet  inArgs )

Library side render action, fetches relevant properties and calls the client code.

ImageEffect * OFX::Private::retrieveImageEffectPointer (  OfxImageEffectHandle  handle  )

fetches our pointer out of the props on the handle

Interact* retrieveInteractPointer (  OfxInteractHandle  handle  )

fetches our pointer out of the props on the handle

void OFX::Private::setHost (  OfxHost *  host  )

The plugin function that gets passed the host structure.

void unloadAction (  void   )

Support lib function called on an ofx unload action.

void unloadAction (  const char *  id  )

Library side unload action, this fetches all the suite pointers.

---

Variable Documentation

EffectDescriptorMap OFX::Private::gEffectDescriptors

OfxImageEffectSuiteV1 * OFX::Private::gEffectSuite = 0

Pointer to the effect suite.

OfxHost * OFX::Private::gHost = 0

Pointer to the host.

OfxInteractSuiteV1 * OFX::Private::gInteractSuite = 0

Pointer to the interact suite.

int OFX::Private::gLoadCount = 0

Keeps count of how many times load/unload have been called.

OfxMemorySuiteV1 * OFX::Private::gMemorySuite = 0

Pointer to the general memory suite.

OfxMessageSuiteV1 * OFX::Private::gMessageSuite = 0

Pointer to the message suite.

OfxParameterSuiteV1 * OFX::Private::gParamSuite = 0

Pointer to the parameter suite.

OfxProgressSuiteV1 * OFX::Private::gProgressSuite = 0

Pointer to the optional progress suite.

OfxPropertySuiteV1 * OFX::Private::gPropSuite = 0

Pointer to the property suite.

OfxMultiThreadSuiteV1 * OFX::Private::gThreadSuite = 0

Pointer to the threading suite.

OfxTimeLineSuiteV1 * OFX::Private::gTimeLineSuite = 0

Pointer to the optional progress suite.

---