Properties on the Image Effect Host

	•	 •	kOfxPropAPIVersion - (read only) the version of the API implemented by the host, if not present, it is safe to assume "1.0" SUPPORTED
	•	 •	kOfxPropType - (read only) set to "host" SUPPORTED
	•	 •	kOfxPropName - (read only) the globally unique name of the application, eg: "com.acmesofware.funkyCompositor" SUPPORTED
	•	 •	kOfxPropLabel - (read only) the user visible name of the appliaction, SUPPORTED
	•	 •	kOfxPropVersion - (read only) the version number of the host  SUPPORTED
	•	 •	kOfxPropVersionLabel - (read only) a user readable version label SUPPORTED
	•	 •	kOfxImageEffectHostPropIsBackground - (read only) is the application a background renderrer SUPPORTED
	•	 •	kOfxImageEffectPropSupportsOverlays - (read only) does the application support overlay interactive GUIs SUPPORTED
	•	 •	kOfxImageEffectPropSupportsMultiResolution - (read only) does the application support images of different sizes SUPPORTED
	•	 •	kOfxImageEffectPropSupportsTiles - (read only) does the application support image tiling SUPPORTED
	•	 •	kOfxImageEffectPropTemporalClipAccess - (read only) does the application allow random temporal access to source images SUPPORTED
	•	 •	kOfxImageEffectPropSupportedComponents - (read only) a list of supported colour components SUPPORTED : RGBA
	•	 •	kOfxImageEffectPropSupportedContexts - (read only) a list of supported effect contexts SUPPORTED : Generator,Filter,General
	•	 •	kOfxImageEffectPropSupportsMultipleClipDepths - (read only) does the application allow inputs and output clips to have differing bit depths SUPPORTED: FLOAT
	•	 •	kOfxImageEffectPropSupportsMultipleClipPARs - (read only) does the application allow inputs and output clips to have differing pixel aspect ratios  UNSUPPORTED
	•	 •	kOfxImageEffectPropSetableFrameRate - (read only) does the application allow an effect to change the frame rate of the output clip UNSUPPORTED
	•	 •	kOfxImageEffectPropSetableFielding - (read only) does the application allow an effect to change the fielding of the output clip UNSUPPORTED
	•	 •	kOfxParamHostPropSupportsCustomInteract - (read only) does the application SUPPORTED ( are we talking about overlays here ? if so yes)
	•	 •	kOfxParamHostPropSupportsStringAnimation - (read only) does the application allow the animation of string parameters SUPPORTED
	•	 •	kOfxParamHostPropSupportsChoiceAnimation - (read only) does the application allow the animation of choice parameters SUPPORTED
	•	 •	kOfxParamHostPropSupportsBooleanAnimation - (read only does the application allow the animation of boolean parameters) SUPPORTED
	•	 •	kOfxParamHostPropSupportsCustomAnimation - (read only) does the application allow the animation of custom parameters SUPPORTED
	•	 •	kOfxParamHostPropMaxParameters - (read only) the maximum number of parameters the application allows a plug-in to have SUPPORTED
	•	 •	kOfxParamHostPropMaxPages - (read only) the maximum number of parameter pages the application allows a plug-in to have SUPPORTED
	•	 •	kOfxParamHostPropPageRowColumnCount - (read only) the number of rows and columns on a page parameter  SUPPORTED
	•	 •	kOfxPropHostOSHandle - (read only) a pointer to an OS specific application handle (eg: the root hWnd on Windows) UNSUPPORTED
	•	 •	kOfxParamHostPropSupportsParametricAnimation - (read only) does the host support animation of parametric parameters UNSUPPORTED
Properties on an Effect Descriptor
An image effect plugin (ie: that thing passed to the initial 'describe' action) has the following properties, these can only be set inside the 'describe' actions ...
	•	 •	kOfxPropType - (read only) SUPPORTED
	•	 •	kOfxPropLabel - (read/write) SUPPORTED
	•	 •	kOfxPropShortLabel - (read/write) SUPPORTED
	•	 •	kOfxPropLongLabel - (read/write) SUPPORTED
	•	 •	kOfxPropVersion - (read only) the version number of the plugin SUPPORTED
	•	 •	kOfxPropVersionLabel - (read only) a user readable version label SUPPORTED
	•	 •	kOfxPropPluginDescription - (read/write), a short description of the plugin SUPPORTED
	•	 •	kOfxImageEffectPropSupportedContexts - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginPropGrouping - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginPropSingleInstance - (read/write)  UNSUPPORTED
	•	 •	kOfxImageEffectPluginRenderThreadSafety - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginPropHostFrameThreading - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginPropOverlayInteractV1 - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportsMultiResolution - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportsTiles - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropTemporalClipAccess - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportedPixelDepths - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginPropFieldRenderTwiceAlways - (read/write) UNSUPPORTED
	•	 •	kOfxImageEffectPropSupportsMultipleClipDepths - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportsMultipleClipPARs - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPluginRenderThreadSafety - (read/write)  SUPPORTED
	•	 •	kOfxImageEffectPropClipPreferencesSlaveParam - (read/write) SUPPORTED
	•	 •	kOfxPluginPropFilePath (read only) SUPPORTED
Properties on an Effect Instance
An image effect instance has the following properties, all but kOfxPropInstanceData and kOfxImageEffectInstancePropSequentialRender are read only...
	•	 •	kOfxPropType - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropContext - (read only) SUPPORTED
	•	 •	kOfxPropInstanceData - (read and write) SUPPORTED
	•	 •	kOfxImageEffectPropProjectSize - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropProjectOffset - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropProjectExtent - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropProjectPixelAspectRatio - (read only) SUPPORTED
	•	 •	kOfxImageEffectInstancePropEffectDuration - (read only) UNSUPPORTED
	•	 •	kOfxImageEffectInstancePropSequentialRender - (read and write) SUPPORTED
	•	 •	kOfxImageEffectPropFrameRate - (read only) SUPPORTED
	•	 •	kOfxPropIsInteractive - (read only) SUPPORTED
Properties on a Clip Descriptor
All OfxImageClipHandle accessed inside the kOfxActionDescribe or kOfxActionDescribeInContext are clip descriptors, used to describe the behaviour of clips in a specific context.
	•	 •	kOfxPropType - (read only) set to SUPPORTED
	•	 •	kOfxPropName - (read only) the name the clip was created with SUPPORTED
	•	 •	kOfxPropLabel - (read/write) the user visible label for the clip SUPPORTED
	•	 •	kOfxPropShortLabel - (read/write) SUPPORTED
	•	 •	kOfxPropLongLabel - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportedComponents - (read/write)  SUPPORTED
	•	 •	kOfxImageEffectPropTemporalClipAccess - (read/write) SUPPORTED
	•	 •	kOfxImageClipPropOptional - (read/write) SUPPORTED
	•	 •	kOfxImageClipPropFieldExtraction - (read/write) UNSUPPORTED
	•	 •	kOfxImageClipPropIsMask - (read/write) SUPPORTED
	•	 •	kOfxImageEffectPropSupportsTiles - (read/write) SUPPORTED
Properties on a Clip Instance
	•	 •	kOfxPropType - (read only) SUPPORTED
	•	 •	kOfxPropName - (read only) SUPPORTED
	•	 •	kOfxPropLabel - (read only)  SUPPORTED
	•	 •	kOfxPropShortLabel - (read only) SUPPORTED
	•	 •	kOfxPropLongLabel - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropSupportedComponents - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropTemporalClipAccess - (read only) SUPPORTED
	•	 •	kOfxImageClipPropOptional - (read only) SUPPORTED
	•	 •	kOfxImageClipPropFieldExtraction - (read only) UNSUPPORTED
	•	 •	kOfxImageClipPropIsMask - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropSupportsTiles - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropPixelDepth - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropComponents - (read only) SUPPORTED
	•	 •	kOfxImageClipPropUnmappedPixelDepth - (read only) SUPPORTED
	•	 •	kOfxImageClipPropUnmappedComponents - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropPreMultiplication - (read only) SUPPORTED
	•	 •	kOfxImagePropPixelAspectRatio - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropFrameRate - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropFrameRange - (read only) SUPPORTED
	•	 •	kOfxImageClipPropFieldOrder - (read only) UNSUPPORTED
	•	 •	kOfxImageClipPropConnected - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropUnmappedFrameRange - (read only)* SUPPORTED
	•	 •	kOfxImageEffectPropUnmappedFrameRate - (read only)* SUPPORTED
	•	 •	kOfxImageClipPropContinuousSamples - (read only) SUPPORTED
Properties on an Image
All images are instances, there is no such thing as an image descriptor.
	•	 •	kOfxPropType - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropPixelDepth - (read only) SUPPORTED - FLOAT
	•	 •	kOfxImageEffectPropComponents - (read only) SUPPORTED - RGBA
	•	 •	kOfxImageEffectPropPreMultiplication - (read only) SUPPORTED
	•	 •	kOfxImageEffectPropRenderScale - (read only) SUPPORTED
	•	 •	kOfxImagePropPixelAspectRatio - (read only) SUPPORTED
	•	 •	kOfxImagePropData - (read only) SUPPORTED
	•	 •	kOfxImagePropBounds - (read only) SUPPORTED
	•	 •	kOfxImagePropRegionOfDefinition - (read only) * SUPPORTED
	•	 •	kOfxImagePropRowBytes - (read only) SUPPORTED
	•	 •	kOfxImagePropField - (read only)  UNSUPPORTED
	•	 •	kOfxImagePropUniqueIdentifier - (read only) SUPPORTED
Properties on Parameter Set Instances
<listitem>kOfxPropParamSetNeedsSyncing, which indicates if private data is dirty and may need re-syncing to a parameter set</listitem> SUPPORTED
Properties on Parameter Descriptors and Instances
Properties Common to All Parameters
The following properties are common to all parameters....
 •	kOfxPropType, which will always be kOfxTypeParameter(read only) SUPPORTED
 •	kOfxPropName read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxPropLabel read/write in the descriptor and instance  SUPPORTED
 •	kOfxPropShortLabel read/write in the descriptor and instance SUPPORTED
 •	kOfxPropLongLabel read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropTyperead only in the descriptor and instance, the value is set on construction SUPPORTED
 •	kOfxParamPropSecret read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropCanUndo read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropHint read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropScriptName read/write in the descriptor, read only on an instance UNSUPPORTED
 •	kOfxParamPropParent read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropEnabled read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropDataPtr read/write in the descriptor and instance SUPPORTED
 •	kOfxPropIcon, read/write on a descriptor, read only on an instance UNSUPPORTED
Properties On Group Parameters
 •	kOfxParamPropGroupOpen read/write in the descriptor, read only on an instance SUPPORTED
Properties Common to All But Group and Page Parameters
 •	kOfxParamPropInteractV1 read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropInteractSize read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropInteractSizeAspect read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropInteractMinimumSize read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropInteractPreferedSize read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropHasHostOverlayHandle read only in the descriptor and instance SUPPORTED
 •	kOfxParamPropUseHostOverlayHandle read/write in the descriptor and read only in the in stance SUPPORTED
Properties Common to All Parameters That Hold Values
	•	 •	kOfxParamPropDefault read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropAnimates read/write in the descriptor, read only on an instance SUPPORTED – NOT STRINGS
	•	 •	kOfxParamPropIsAnimating read/write in the descriptor, read only on an instance  SUPPORTED
	•	 •	kOfxParamPropIsAutoKeying read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropPersistant read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropEvaluateOnChange read/write in the descriptor and instance SUPPORTED
	•	 •	kOfxParamPropPluginMayWrite read/write in the descriptor, read only on an instance UNSUPPORTED
	•	 •	kOfxParamPropCacheInvalidation read/write in the descriptor, read only on an instance  UNSUPPORTED
	•	 •	kOfxParamPropCanUndo read/write in the descriptor, read only on an instance SUPPORTED
Properties Common to All Numeric Parameters
 •	kOfxParamPropMin read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropMax read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropDisplayMin read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropDisplayMax read/write in the descriptor and instance SUPPORTED
Properties Common to All Double Parameters
 •	kOfxParamPropIncrement read/write in the descriptor and instance SUPPORTED
 •	kOfxParamPropDigits read/write in the descriptor and instance SUPPORTED
Properties On 1D Double Parameters
	•	 •	kOfxParamPropShowTimeMarker read/write in the descriptor and instance UNSUPPORTED
	•	 •	kOfxParamPropDoubleType read/write in the descriptor, read only on an instance SUPPORTED
Properties On 2D and 3D Double Parameters
	•	 •	kOfxParamPropDoubleType read/write in the descriptor, read only on an instance SUPPORTED
Properties On Non Normalised Spatial Double Parameters
	•	 •	kOfxParamPropDefaultCoordinateSystem read/write in the descriptor, read only on an instance SUPPORTED
Properties On 2D and 3D Integer Parameters 
	•	 •	kOfxParamPropDimensionLabel read/write in the descriptor, read only on an instance SUPPORTED
Properties On String Parameters
 •	kOfxParamPropStringMode read/write in the descriptor, read only on an instance SUPPORTED
 •	kOfxParamPropStringFilePathExists read/write in the descriptor, read only on an instance SUPPORTED
Properties On Choice Parameters
 •	kOfxParamPropChoiceOption read/write in the descriptor and instance SUPPORTED
Properties On Custom Parameters
	•	 •	kOfxParamPropCustomInterpCallbackV1 read/write in the descriptor, read only on an instance SUPPORTED
Properties On Page Parameters
	•	 •	kOfxParamPropPageChild read/write in the descriptor, read only on an instance SUPPORTED
On Parametric Parameters
	•	 •	kOfxParamPropAnimates read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropIsAnimating read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropIsAutoKeying read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropPersistant read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropEvaluateOnChange read/write in the descriptor and instance SUPPORTED
	•	 •	kOfxParamPropPluginMayWrite read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropCacheInvalidation read/write in the descriptor, read only on an instance UNSUPPORTED
	•	 •	kOfxParamPropCanUndo read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropParametricDimension read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropParametricUIColour read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropParametricInteractBackground read/write in the descriptor, read only on an instance SUPPORTED
	•	 •	kOfxParamPropParametricRange read/write in the descriptor, read only on an instance SUPPORTED
Properties on Interact Descriptors
 •	kOfxInteractPropHasAlpha read only SUPPORTED
 •	kOfxInteractPropBitDepth read only SUPPORTED
Properties on Interact Instances
 •	kOfxPropEffectInstance read only SUPPORTED
 •	kOfxPropInstanceData read/write only SUPPORTED
 •	kOfxInteractPropPixelScale read only SUPPORTED
 •	kOfxInteractPropBackgroundColour read only SUPPORTED
 •	kOfxInteractPropViewportSize read only SUPPORTED
 •	kOfxInteractPropHasAlpha read only SUPPORTED
 •	kOfxInteractPropBitDepth read only SUPPORTED
 •	kOfxInteractPropSlaveToParam read/write SUPPORTED
 •	kOfxInteractPropSuggestedColour read only SUPPORTED