fnPublicOfxExtensions.h File Reference

#include "ofxImageEffect.h"

Include dependency graph for fnPublicOfxExtensions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	kOfxParamPropLayoutHint   "OfxParamPropLayoutHint"
	Layout hint for hierarchical layouts.
#define	kOfxParamPropLayoutHintNormal   0
#define	kOfxParamPropLayoutHintDivider   1
#define	kOfxParamPropLayoutHintNoNewLine   2
#define	kOfxParamPropLayoutPadWidth   "OfxParamPropLayoutPadWidth"
	Layout padding for hierarchical views, only pertinent with kOfxParamPropLayoutHint==2.
#define	kOfxPropOverlayColour   "OfxPropOverlayColour"
	The suggested colour of an overlay colour in an interact.
#define	kOfxPropVersionLabel   "OfxPropVersionLabel"
	Unique user readable version string for that identifies something from other versions.
#define	kOfxPropHostProductTitle   "OfxPropHostProductTitle"
	The displayed named of the host.
#define	kOfxPropHostMajorVersion   "OfxPropHostMajorVersion"
	The major version of the host.
#define	kOfxPropHostMinorVersion   "OfxPropHostMinorVersion"
	The minor version of the host.
#define	kOfxPropHostBuildVersion   "OfxPropHostBuildVersion"
	The build version of the host.
#define	kFnOfxParamPropGroupIsTab   "FnOfxParamPropGroupIsTab"
	Whether to display a group as a tab.

---

Define Documentation

#define kFnOfxParamPropGroupIsTab   "FnOfxParamPropGroupIsTab"

Whether to display a group as a tab.

• Type - int X 1
• Property Set - plugin parameter descriptor (read/write) and instance (read only)
• Default - 0
• Valid Values - 0 or 1

Definition at line 140 of file fnPublicOfxExtensions.h.

Referenced by OFX::GroupParamDescriptor::setAsTab().

#define kOfxParamPropLayoutHint   "OfxParamPropLayoutHint"

Layout hint for hierarchical layouts.

• Type - int X 1
• Property Set - plugin parameter descriptor (read/write) and instance (read only)
• Default - 0
• Valid Values - 0,1 or 2 0 - for a new line after the parameter 1 - for a seperator between this parameter and the one to follow 2 - for no new line, continue the next parameter on the same horizontal level

This is a property on parameters of type kOfxParamPropLayoutHint, and tells the group whether it should be open or closed by default.

Definition at line 54 of file fnPublicOfxExtensions.h.

Referenced by OFX::ParamDescriptor::setLayoutHint().

#define kOfxParamPropLayoutHintDivider   1

Definition at line 60 of file fnPublicOfxExtensions.h.

#define kOfxParamPropLayoutHintNoNewLine   2

Definition at line 63 of file fnPublicOfxExtensions.h.

#define kOfxParamPropLayoutHintNormal   0

Definition at line 57 of file fnPublicOfxExtensions.h.

#define kOfxParamPropLayoutPadWidth   "OfxParamPropLayoutPadWidth"

Layout padding for hierarchical views, only pertinent with kOfxParamPropLayoutHint==2.

• Type - int X 1
• Property Set - plugin parameter descriptor (read/write) and instance (read only)
• Default - 0
• Valid Values - any positive integer value

This is a property on parameters of type kOfxParamPropLayoutPadWidth It tells the host how much space (in pixels) to leave between the current parameter and the next parameter in horizontal layouts.

Definition at line 75 of file fnPublicOfxExtensions.h.

#define kOfxPropHostBuildVersion   "OfxPropHostBuildVersion"

The build version of the host.

• Type - string X 1
• Property Set - host descriptor (read only), plugin descriptor (read/write)
• Default - none
• Valid Values - ASCII string

Definition at line 131 of file fnPublicOfxExtensions.h.

#define kOfxPropHostMajorVersion   "OfxPropHostMajorVersion"

The major version of the host.

• Type - int X 1
• Property Set - param set instance (read/write)
• Default - none
• Valid Values - any positive integer values

Definition at line 113 of file fnPublicOfxExtensions.h.

#define kOfxPropHostMinorVersion   "OfxPropHostMinorVersion"

The minor version of the host.

• Type - int X 1
• Property Set - param set instance (read/write)
• Default - none
• Valid Values - any positive integer values

Definition at line 122 of file fnPublicOfxExtensions.h.

#define kOfxPropHostProductTitle   "OfxPropHostProductTitle"

The displayed named of the host.

• Type - string X 1
• Property Set - host descriptor (read only), plugin descriptor (read/write)
• Default - none
• Valid Values - ASCII string

Definition at line 104 of file fnPublicOfxExtensions.h.

#define kOfxPropOverlayColour   "OfxPropOverlayColour"

The suggested colour of an overlay colour in an interact.

• Type - double X 3
• Property Set - plugin parameter descriptor (read/write) and instance (read only)
• Default - 1.0
• Valid Values - greater than or equal to 0.0

This is a property of an overlay interact instance.

Definition at line 86 of file fnPublicOfxExtensions.h.

#define kOfxPropVersionLabel   "OfxPropVersionLabel"

Unique user readable version string for that identifies something from other versions.

• Type - string X 1
• Property Set - host descriptor (read only), plugin descriptor (read/write)
• Default - none, the host needs to set this
• Valid Values - ASCII string

Definition at line 95 of file fnPublicOfxExtensions.h.