Property Sets Reference
This reference is auto-generated from property set definitions in the OpenFX source code. It provides an overview of property sets and their associated properties. For each property, a link to its detailed description in the Properties Reference is provided.
Regular Property Sets
These property sets represent collections of properties associated with various OpenFX objects.
Property Sets Quick Reference
ClipDescriptor
Write Access: plugin
Properties
OfxImageClipPropFieldExtraction - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropFieldExtraction)OfxImageClipPropIsMask - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropIsMask)OfxImageClipPropOptional - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropOptional)OfxImageEffectPropSupportedComponents - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedComponents)OfxImageEffectPropSupportsTiles - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsTiles)OfxImageEffectPropTemporalClipAccess - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropTemporalClipAccess)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
ClipInstance
Write Access: host
Properties
OfxImageClipPropColourspace - Type: string, Dimension: 1 (doc:
kOfxImageClipPropColourspace)OfxImageClipPropConnected - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropConnected)OfxImageClipPropContinuousSamples - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropContinuousSamples)OfxImageClipPropFieldExtraction - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropFieldExtraction)OfxImageClipPropFieldOrder - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropFieldOrder)OfxImageClipPropIsMask - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropIsMask)OfxImageClipPropOptional - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropOptional)OfxImageClipPropPreferredColourspaces - Type: string, Dimension: Variable (doc:
kOfxImageClipPropPreferredColourspaces)OfxImageClipPropUnmappedComponents - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropUnmappedComponents)OfxImageClipPropUnmappedPixelDepth - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropUnmappedPixelDepth)OfxImageEffectPropComponents - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropComponents)OfxImageEffectPropFrameRange - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropFrameRange)OfxImageEffectPropFrameRate - Type: double, Dimension: 1 (doc:
kOfxImageEffectPropFrameRate)OfxImageEffectPropPixelDepth - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropPixelDepth)OfxImageEffectPropPreMultiplication - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropPreMultiplication)OfxImageEffectPropSupportedComponents - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedComponents)OfxImageEffectPropSupportsTiles - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsTiles)OfxImageEffectPropTemporalClipAccess - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropTemporalClipAccess)OfxImageEffectPropUnmappedFrameRange - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropUnmappedFrameRange)OfxImageEffectPropUnmappedFrameRate - Type: double, Dimension: 1 (doc:
kOfxImageEffectPropUnmappedFrameRate)OfxImagePropPixelAspectRatio - Type: double, Dimension: 1 (doc:
kOfxImagePropPixelAspectRatio)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
EffectDescriptor
Write Access: plugin
Properties
OfxImageEffectPluginPropFieldRenderTwiceAlways - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPluginPropFieldRenderTwiceAlways)OfxImageEffectPluginPropGrouping - Type: string, Dimension: 1 (doc:
kOfxImageEffectPluginPropGrouping)OfxImageEffectPluginPropHostFrameThreading - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPluginPropHostFrameThreading)OfxImageEffectPluginPropObsolete - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPluginPropObsolete)OfxImageEffectPluginPropOverlayInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxImageEffectPluginPropOverlayInteractV1)OfxImageEffectPluginPropOverlayInteractV2 - Type: pointer, Dimension: 1 (doc:
kOfxImageEffectPluginPropOverlayInteractV2)OfxImageEffectPluginPropSingleInstance - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPluginPropSingleInstance)OfxImageEffectPluginRenderThreadSafety - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPluginRenderThreadSafety)OfxImageEffectPluginRenderThreadSafety - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPluginRenderThreadSafety)OfxImageEffectPropCPURenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropCPURenderSupported)OfxImageEffectPropClipPreferencesSlaveParam - Type: string, Dimension: Variable (doc:
kOfxImageEffectPropClipPreferencesSlaveParam)OfxImageEffectPropColourManagementAvailableConfigs - Type: string, Dimension: Variable (doc:
kOfxImageEffectPropColourManagementAvailableConfigs)OfxImageEffectPropColourManagementStyle - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropColourManagementStyle)OfxImageEffectPropMultipleClipDepths - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultipleClipDepths)OfxImageEffectPropNoSpatialAwareness - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropNoSpatialAwareness)OfxImageEffectPropOpenCLSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropOpenCLSupported)OfxImageEffectPropOpenGLRenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropOpenGLRenderSupported)OfxImageEffectPropSupportedContexts - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedContexts)OfxImageEffectPropSupportedPixelDepths - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedPixelDepths)OfxImageEffectPropSupportsMultiResolution - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultiResolution)OfxImageEffectPropSupportsMultipleClipPARs - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultipleClipPARs)OfxImageEffectPropSupportsTiles - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsTiles)OfxImageEffectPropTemporalClipAccess - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropTemporalClipAccess)OfxOpenGLPropPixelDepth - Type: enum, Dimension: Variable (doc:
kOfxOpenGLPropPixelDepth)OfxPluginPropFilePath - Type: string, Dimension: 1 (doc:
kOfxPluginPropFilePath)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropPluginDescription - Type: string, Dimension: 1 (doc:
kOfxPropPluginDescription)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)OfxPropVersion - Type: int, Dimension: Variable (doc:
kOfxPropVersion)OfxPropVersionLabel - Type: string, Dimension: 1 (doc:
kOfxPropVersionLabel)
EffectInstance
Write Access: host
Properties
OfxImageEffectInstancePropEffectDuration - Type: double, Dimension: 1 (doc:
kOfxImageEffectInstancePropEffectDuration)OfxImageEffectInstancePropSequentialRender - Type: bool, Dimension: 1 (doc:
kOfxImageEffectInstancePropSequentialRender)OfxImageEffectPropCPURenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropCPURenderSupported)OfxImageEffectPropColourManagementConfig - Type: string, Dimension: 1 (doc:
kOfxImageEffectPropColourManagementConfig)OfxImageEffectPropColourManagementStyle - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropColourManagementStyle)OfxImageEffectPropContext - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropContext)OfxImageEffectPropDisplayColourspace - Type: string, Dimension: 1 (doc:
kOfxImageEffectPropDisplayColourspace)OfxImageEffectPropFrameRate - Type: double, Dimension: 1 (doc:
kOfxImageEffectPropFrameRate)OfxImageEffectPropOCIOConfig - Type: string, Dimension: 1 (doc:
kOfxImageEffectPropOCIOConfig)OfxImageEffectPropOCIODisplay - Type: string, Dimension: 1 (doc:
kOfxImageEffectPropOCIODisplay)OfxImageEffectPropOCIOView - Type: string, Dimension: 1 (doc:
kOfxImageEffectPropOCIOView)OfxImageEffectPropOpenGLRenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropOpenGLRenderSupported)OfxImageEffectPropPixelAspectRatio - Type: double, Dimension: 1 (doc:
kOfxImageEffectPropProjectPixelAspectRatio)OfxImageEffectPropPluginHandle - Type: pointer, Dimension: 1 (doc:
kOfxImageEffectPropPluginHandle)OfxImageEffectPropProjectExtent - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropProjectExtent)OfxImageEffectPropProjectOffset - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropProjectOffset)OfxImageEffectPropProjectSize - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropProjectSize)OfxImageEffectPropSupportsTiles - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsTiles)OfxPropInstanceData - Type: pointer, Dimension: 1 (doc:
kOfxPropInstanceData)OfxPropIsInteractive - Type: bool, Dimension: 1 (doc:
kOfxPropIsInteractive)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
Image
Write Access: host
Properties
OfxImageEffectPropComponents - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropComponents)OfxImageEffectPropPixelDepth - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropPixelDepth)OfxImageEffectPropPreMultiplication - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropPreMultiplication)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropRenderScale)OfxImagePropBounds - Type: int, Dimension: 4 (doc:
kOfxImagePropBounds)OfxImagePropData - Type: pointer, Dimension: 1 (doc:
kOfxImagePropData)OfxImagePropField - Type: enum, Dimension: 1 (doc:
kOfxImagePropField)OfxImagePropPixelAspectRatio - Type: double, Dimension: 1 (doc:
kOfxImagePropPixelAspectRatio)OfxImagePropRegionOfDefinition - Type: int, Dimension: 4 (doc:
kOfxImagePropRegionOfDefinition)OfxImagePropRowBytes - Type: int, Dimension: 1 (doc:
kOfxImagePropRowBytes)OfxImagePropUniqueIdentifier - Type: string, Dimension: 1 (doc:
kOfxImagePropUniqueIdentifier)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
ImageEffectHost
Write Access: host
Properties
OfxImageEffectHostPropIsBackground - Type: bool, Dimension: 1 (doc:
kOfxImageEffectHostPropIsBackground)OfxImageEffectHostPropNativeOrigin - Type: enum, Dimension: 1 (doc:
kOfxImageEffectHostPropNativeOrigin)OfxImageEffectInstancePropSequentialRender - Type: bool, Dimension: 1 (doc:
kOfxImageEffectInstancePropSequentialRender)OfxImageEffectPropCPURenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropCPURenderSupported)OfxImageEffectPropColourManagementAvailableConfigs - Type: string, Dimension: Variable (doc:
kOfxImageEffectPropColourManagementAvailableConfigs)OfxImageEffectPropColourManagementStyle - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropColourManagementStyle)OfxImageEffectPropMultipleClipDepths - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultipleClipDepths)OfxImageEffectPropOpenCLSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropOpenCLSupported)OfxImageEffectPropOpenGLRenderSupported - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropOpenGLRenderSupported)OfxImageEffectPropRenderQualityDraft - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropRenderQualityDraft)OfxImageEffectPropSetableFielding - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSetableFielding)OfxImageEffectPropSetableFrameRate - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSetableFrameRate)OfxImageEffectPropSupportedComponents - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedComponents)OfxImageEffectPropSupportedContexts - Type: enum, Dimension: Variable (doc:
kOfxImageEffectPropSupportedContexts)OfxImageEffectPropSupportsMultiResolution - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultiResolution)OfxImageEffectPropSupportsMultipleClipPARs - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsMultipleClipPARs)OfxImageEffectPropSupportsOverlays - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsOverlays)OfxImageEffectPropSupportsTiles - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropSupportsTiles)OfxImageEffectPropTemporalClipAccess - Type: bool, Dimension: 1 (doc:
kOfxImageEffectPropTemporalClipAccess)OfxParamHostPropMaxPages - Type: int, Dimension: 1 (doc:
kOfxParamHostPropMaxPages)OfxParamHostPropMaxParameters - Type: int, Dimension: 1 (doc:
kOfxParamHostPropMaxParameters)OfxParamHostPropPageRowColumnCount - Type: int, Dimension: 2 (doc:
kOfxParamHostPropPageRowColumnCount)OfxParamHostPropSupportsBooleanAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsBooleanAnimation)OfxParamHostPropSupportsChoiceAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsChoiceAnimation)OfxParamHostPropSupportsCustomAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsCustomAnimation)OfxParamHostPropSupportsCustomInteract - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsCustomInteract)OfxParamHostPropSupportsParametricAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsParametricAnimation)OfxParamHostPropSupportsStrChoice - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsStrChoice)OfxParamHostPropSupportsStrChoiceAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsStrChoiceAnimation)OfxParamHostPropSupportsStringAnimation - Type: bool, Dimension: 1 (doc:
kOfxParamHostPropSupportsStringAnimation)OfxPropAPIVersion - Type: int, Dimension: Variable (doc:
kOfxPropAPIVersion)OfxPropHostOSHandle - Type: pointer, Dimension: 1 (doc:
kOfxPropHostOSHandle)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)OfxPropVersion - Type: int, Dimension: Variable (doc:
kOfxPropVersion)OfxPropVersionLabel - Type: string, Dimension: 1 (doc:
kOfxPropVersionLabel)
InteractDescriptor
Write Access: host
Properties
OfxInteractPropBitDepth - Type: int, Dimension: 1 (doc:
kOfxInteractPropBitDepth)OfxInteractPropHasAlpha - Type: bool, Dimension: 1 (doc:
kOfxInteractPropHasAlpha)
InteractInstance
Write Access: host
Properties
OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (doc:
kOfxInteractPropBackgroundColour)OfxInteractPropBitDepth - Type: int, Dimension: 1 (doc:
kOfxInteractPropBitDepth)OfxInteractPropHasAlpha - Type: bool, Dimension: 1 (doc:
kOfxInteractPropHasAlpha)OfxInteractPropPixelScale - Type: double, Dimension: 2 (doc:
kOfxInteractPropPixelScale)OfxInteractPropSlaveToParam - Type: string, Dimension: Variable (doc:
kOfxInteractPropSlaveToParam)OfxInteractPropSuggestedColour - Type: double, Dimension: 3 (doc:
kOfxInteractPropSuggestedColour)OfxPropEffectInstance - Type: pointer, Dimension: 1 (doc:
kOfxPropEffectInstance)OfxPropInstanceData - Type: pointer, Dimension: 1 (doc:
kOfxPropInstanceData)
ParamDouble1D
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDigits - Type: int, Dimension: 1 (doc:
kOfxParamPropDigits)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropDoubleType - Type: enum, Dimension: 1 (doc:
kOfxParamPropDoubleType)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropIncrement - Type: double, Dimension: 1 (doc:
kOfxParamPropIncrement)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropShowTimeMarker - Type: bool, Dimension: 1 (doc:
kOfxParamPropShowTimeMarker)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParameterSet
Write Access: plugin
Properties
OfxPluginPropParamPageOrder - Type: string, Dimension: Variable (doc:
kOfxPluginPropParamPageOrder)OfxPropParamSetNeedsSyncing - Type: bool, Dimension: 1 (doc:
kOfxPropParamSetNeedsSyncing)
ParamsByte
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsChoice
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropChoiceOption - Type: string, Dimension: Variable (doc:
kOfxParamPropChoiceOption)OfxParamPropChoiceOrder - Type: int, Dimension: Variable (doc:
kOfxParamPropChoiceOrder)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsCustom
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropCustomCallbackV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropCustomInterpCallbackV1)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsDouble2D3D
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDigits - Type: int, Dimension: 1 (doc:
kOfxParamPropDigits)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropDoubleType - Type: enum, Dimension: 1 (doc:
kOfxParamPropDoubleType)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropIncrement - Type: double, Dimension: 1 (doc:
kOfxParamPropIncrement)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsGroup
Write Access: plugin
Properties
OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropGroupOpen - Type: bool, Dimension: 1 (doc:
kOfxParamPropGroupOpen)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
ParamsInt2D3D
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDimensionLabel - Type: string, Dimension: 1 (doc:
kOfxParamPropDimensionLabel)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsNormalizedSpatial
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDefaultCoordinateSystem - Type: enum, Dimension: 1 (doc:
kOfxParamPropDefaultCoordinateSystem)OfxParamPropDigits - Type: int, Dimension: 1 (doc:
kOfxParamPropDigits)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropIncrement - Type: double, Dimension: 1 (doc:
kOfxParamPropIncrement)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsPage
Write Access: plugin
Properties
OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropPageChild - Type: string, Dimension: Variable (doc:
kOfxParamPropPageChild)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)
ParamsParametric
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropParametricDimension - Type: int, Dimension: 1 (doc:
kOfxParamPropParametricDimension)OfxParamPropParametricInteractBackground - Type: pointer, Dimension: 1 (doc:
kOfxParamPropParametricInteractBackground)OfxParamPropParametricRange - Type: double, Dimension: 2 (doc:
kOfxParamPropParametricRange)OfxParamPropParametricUIColour - Type: double, Dimension: Variable (doc:
kOfxParamPropParametricUIColour)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsStrChoice
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropChoiceEnum - Type: bool, Dimension: 1 (doc:
kOfxParamPropChoiceEnum)OfxParamPropChoiceOption - Type: string, Dimension: Variable (doc:
kOfxParamPropChoiceOption)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
ParamsString
Write Access: plugin
Properties
OfxParamPropAnimates - Type: bool, Dimension: 1 (doc:
kOfxParamPropAnimates)OfxParamPropCacheInvalidation - Type: enum, Dimension: 1 (doc:
kOfxParamPropCacheInvalidation)OfxParamPropCanUndo - Type: bool, Dimension: 1 (doc:
kOfxParamPropCanUndo)OfxParamPropDataPtr - Type: pointer, Dimension: 1 (doc:
kOfxParamPropDataPtr)OfxParamPropDefault - Type: int/double/string/pointer, Dimension: Variable (doc:
kOfxParamPropDefault)OfxParamPropDisplayMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMax)OfxParamPropDisplayMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropDisplayMin)OfxParamPropEnabled - Type: bool, Dimension: 1 (doc:
kOfxParamPropEnabled)OfxParamPropEvaluateOnChange - Type: bool, Dimension: 1 (doc:
kOfxParamPropEvaluateOnChange)OfxParamPropHasHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropHasHostOverlayHandle)OfxParamPropHint - Type: string, Dimension: 1 (doc:
kOfxParamPropHint)OfxParamPropInteractMinimumSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractMinimumSize)OfxParamPropInteractPreferedSize - Type: int, Dimension: 2 (doc:
kOfxParamPropInteractPreferedSize)OfxParamPropInteractSize - Type: double, Dimension: 2 (doc:
kOfxParamPropInteractSize)OfxParamPropInteractSizeAspect - Type: double, Dimension: 1 (doc:
kOfxParamPropInteractSizeAspect)OfxParamPropInteractV1 - Type: pointer, Dimension: 1 (doc:
kOfxParamPropInteractV1)OfxParamPropIsAnimating - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAnimating)OfxParamPropIsAutoKeying - Type: bool, Dimension: 1 (doc:
kOfxParamPropIsAutoKeying)OfxParamPropMax - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMax)OfxParamPropMin - Type: int/double, Dimension: Variable (doc:
kOfxParamPropMin)OfxParamPropParent - Type: string, Dimension: 1 (doc:
kOfxParamPropParent)OfxParamPropPersistant - Type: bool, Dimension: 1 (doc:
kOfxParamPropPersistant)OfxParamPropPluginMayWrite - Type: bool, Dimension: 1 (doc:
kOfxParamPropPluginMayWrite)OfxParamPropScriptName - Type: string, Dimension: 1 (doc:
kOfxParamPropScriptName)OfxParamPropSecret - Type: bool, Dimension: 1 (doc:
kOfxParamPropSecret)OfxParamPropStringFilePathExists - Type: bool, Dimension: 1 (doc:
kOfxParamPropStringFilePathExists)OfxParamPropStringMode - Type: enum, Dimension: 1 (doc:
kOfxParamPropStringMode)OfxParamPropType - Type: string, Dimension: 1 (doc:
kOfxParamPropType)OfxPropIcon - Type: string, Dimension: 2 (doc:
kOfxPropIcon)OfxPropLabel - Type: string, Dimension: 1 (doc:
kOfxPropLabel)OfxPropLongLabel - Type: string, Dimension: 1 (doc:
kOfxPropLongLabel)OfxPropName - Type: string, Dimension: 1 (doc:
kOfxPropName)OfxPropShortLabel - Type: string, Dimension: 1 (doc:
kOfxPropShortLabel)OfxPropType - Type: string, Dimension: 1 (doc:
kOfxPropType)kOfxParamPropUseHostOverlayHandle - Type: bool, Dimension: 1 (doc:
kOfxParamPropUseHostOverlayHandle)
Actions Property Sets
Actions in OFX have input and output property sets that are used to pass data between the host and plugin. For each action, the required input properties (passed from host to plugin) and output properties (set by the plugin for the host to read) are documented.
Actions Quick Reference
CustomParamInterpFunc
Input Arguments
OfxParamPropCustomValue - Type: string, Dimension: 2 (
kOfxParamPropCustomValue)OfxParamPropInterpolationTime - Type: double, Dimension: 2 (
kOfxParamPropInterpolationTime)OfxParamPropInterpolationAmount - Type: double, Dimension: 1 (
kOfxParamPropInterpolationAmount)
Output Arguments
OfxParamPropCustomValue - Type: string, Dimension: 2 (doc:
kOfxParamPropCustomValue)OfxParamPropInterpolationTime - Type: double, Dimension: 2 (doc:
kOfxParamPropInterpolationTime)
OfxActionBeginInstanceChanged
Input Arguments
OfxPropChangeReason - Type: enum, Dimension: 1 (
kOfxPropChangeReason)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxActionBeginInstanceEdit
– no in/out args –
OfxActionCreateInstance
– no in/out args –
OfxActionDescribe
– no in/out args –
OfxActionDestroyInstance
– no in/out args –
OfxActionEndInstanceChanged
Input Arguments
OfxPropChangeReason - Type: enum, Dimension: 1 (
kOfxPropChangeReason)
OfxActionEndInstanceEdit
– no in/out args –
OfxActionInstanceChanged
Input Arguments
OfxPropType - Type: string, Dimension: 1 (
kOfxPropType)OfxPropName - Type: string, Dimension: 1 (
kOfxPropName)OfxPropChangeReason - Type: enum, Dimension: 1 (
kOfxPropChangeReason)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxActionLoad
– no in/out args –
OfxActionPurgeCaches
– no in/out args –
OfxActionSyncPrivateData
– no in/out args –
OfxActionUnload
– no in/out args –
OfxImageEffectActionBeginSequenceRender
Input Arguments
OfxImageEffectPropFrameRange - Type: double, Dimension: 2 (
kOfxImageEffectPropFrameRange)OfxImageEffectPropFrameStep - Type: double, Dimension: 1 (
kOfxImageEffectPropFrameStep)OfxPropIsInteractive - Type: bool, Dimension: 1 (
kOfxPropIsInteractive)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropSequentialRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropSequentialRenderStatus)OfxImageEffectPropInteractiveRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropInteractiveRenderStatus)OfxImageEffectPropCudaEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropCudaEnabled)OfxImageEffectPropCudaRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaRenderSupported)OfxImageEffectPropCudaStream - Type: pointer, Dimension: 1 (
kOfxImageEffectPropCudaStream)OfxImageEffectPropCudaStreamSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaStreamSupported)OfxImageEffectPropMetalCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropMetalCommandQueue)OfxImageEffectPropMetalEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropMetalEnabled)OfxImageEffectPropMetalRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropMetalRenderSupported)OfxImageEffectPropOpenCLCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLCommandQueue)OfxImageEffectPropOpenCLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenCLEnabled)OfxImageEffectPropOpenCLImage - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLImage)OfxImageEffectPropOpenCLRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLRenderSupported)OfxImageEffectPropOpenCLSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLSupported)OfxImageEffectPropOpenGLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenGLEnabled)OfxImageEffectPropOpenGLTextureIndex - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureIndex)OfxImageEffectPropOpenGLTextureTarget - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureTarget)OfxImageEffectPropInteractiveRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropInteractiveRenderStatus)OfxImageEffectPropNoSpatialAwareness - Type: enum, Dimension: 1 (
kOfxImageEffectPropNoSpatialAwareness)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxImageEffectActionDescribeInContext
Input Arguments
OfxImageEffectPropContext - Type: enum, Dimension: 1 (
kOfxImageEffectPropContext)
OfxImageEffectActionEndSequenceRender
Input Arguments
OfxImageEffectPropFrameRange - Type: double, Dimension: 2 (
kOfxImageEffectPropFrameRange)OfxImageEffectPropFrameStep - Type: double, Dimension: 1 (
kOfxImageEffectPropFrameStep)OfxPropIsInteractive - Type: bool, Dimension: 1 (
kOfxPropIsInteractive)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropSequentialRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropSequentialRenderStatus)OfxImageEffectPropInteractiveRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropInteractiveRenderStatus)OfxImageEffectPropCudaEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropCudaEnabled)OfxImageEffectPropCudaRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaRenderSupported)OfxImageEffectPropCudaStream - Type: pointer, Dimension: 1 (
kOfxImageEffectPropCudaStream)OfxImageEffectPropCudaStreamSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaStreamSupported)OfxImageEffectPropMetalCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropMetalCommandQueue)OfxImageEffectPropMetalEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropMetalEnabled)OfxImageEffectPropMetalRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropMetalRenderSupported)OfxImageEffectPropOpenCLCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLCommandQueue)OfxImageEffectPropOpenCLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenCLEnabled)OfxImageEffectPropOpenCLImage - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLImage)OfxImageEffectPropOpenCLRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLRenderSupported)OfxImageEffectPropOpenCLSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLSupported)OfxImageEffectPropOpenGLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenGLEnabled)OfxImageEffectPropOpenGLTextureIndex - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureIndex)OfxImageEffectPropOpenGLTextureTarget - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureTarget)OfxImageEffectPropInteractiveRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropInteractiveRenderStatus)
OfxImageEffectActionGetClipPreferences
Output Arguments
OfxImageEffectPropFrameRate - Type: double, Dimension: 1 (doc:
kOfxImageEffectPropFrameRate)OfxImageClipPropFieldOrder - Type: enum, Dimension: 1 (doc:
kOfxImageClipPropFieldOrder)OfxImageEffectPropPreMultiplication - Type: enum, Dimension: 1 (doc:
kOfxImageEffectPropPreMultiplication)OfxImageClipPropContinuousSamples - Type: bool, Dimension: 1 (doc:
kOfxImageClipPropContinuousSamples)OfxImageEffectFrameVarying - Type: bool, Dimension: 1 (doc:
kOfxImageEffectFrameVarying)
OfxImageEffectActionGetFramesNeeded
Input Arguments
OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
Output Arguments
OfxImageEffectPropFrameRange - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropFrameRange)
OfxImageEffectActionGetOutputColourspace
Input Arguments
OfxImageClipPropPreferredColourspaces - Type: string, Dimension: Variable (
kOfxImageClipPropPreferredColourspaces)
Output Arguments
OfxImageClipPropColourspace - Type: string, Dimension: 1 (doc:
kOfxImageClipPropColourspace)
OfxImageEffectActionGetRegionOfDefinition
Input Arguments
OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
Output Arguments
OfxImageEffectPropRegionOfDefinition - Type: double, Dimension: 4 (doc:
kOfxImageEffectPropRegionOfDefinition)
OfxImageEffectActionGetRegionsOfInterest
Input Arguments
OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropRegionOfInterest - Type: double, Dimension: 4 (
kOfxImageEffectPropRegionOfInterest)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxImageEffectActionGetTimeDomain
Output Arguments
OfxImageEffectPropFrameRange - Type: double, Dimension: 2 (doc:
kOfxImageEffectPropFrameRange)
OfxImageEffectActionIsIdentity
Input Arguments
OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropFieldToRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropFieldToRender)OfxImageEffectPropRenderWindow - Type: int, Dimension: 4 (
kOfxImageEffectPropRenderWindow)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxImageEffectActionRender
Input Arguments
OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropSequentialRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropSequentialRenderStatus)OfxImageEffectPropInteractiveRenderStatus - Type: bool, Dimension: 1 (
kOfxImageEffectPropInteractiveRenderStatus)OfxImageEffectPropRenderQualityDraft - Type: bool, Dimension: 1 (
kOfxImageEffectPropRenderQualityDraft)OfxImageEffectPropCudaEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropCudaEnabled)OfxImageEffectPropCudaRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaRenderSupported)OfxImageEffectPropCudaStream - Type: pointer, Dimension: 1 (
kOfxImageEffectPropCudaStream)OfxImageEffectPropCudaStreamSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropCudaStreamSupported)OfxImageEffectPropMetalCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropMetalCommandQueue)OfxImageEffectPropMetalEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropMetalEnabled)OfxImageEffectPropMetalRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropMetalRenderSupported)OfxImageEffectPropOpenCLCommandQueue - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLCommandQueue)OfxImageEffectPropOpenCLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenCLEnabled)OfxImageEffectPropOpenCLImage - Type: pointer, Dimension: 1 (
kOfxImageEffectPropOpenCLImage)OfxImageEffectPropOpenCLRenderSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLRenderSupported)OfxImageEffectPropOpenCLSupported - Type: enum, Dimension: 1 (
kOfxImageEffectPropOpenCLSupported)OfxImageEffectPropOpenGLEnabled - Type: bool, Dimension: 1 (
kOfxImageEffectPropOpenGLEnabled)OfxImageEffectPropOpenGLTextureIndex - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureIndex)OfxImageEffectPropOpenGLTextureTarget - Type: int, Dimension: 1 (
kOfxImageEffectPropOpenGLTextureTarget)OfxImageEffectPropNoSpatialAwareness - Type: enum, Dimension: 1 (
kOfxImageEffectPropNoSpatialAwareness)OfxImageEffectPropThumbnailRender - Type: enum, Dimension: 1 (
kOfxImageEffectPropThumbnailRender)
OfxInteractActionDraw
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropDrawContext - Type: pointer, Dimension: 1 (
kOfxInteractPropDrawContext)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionGainFocus
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionKeyDown
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)kOfxPropKeySym - Type: int, Dimension: 1 (
kOfxPropKeySym)kOfxPropKeyString - Type: string, Dimension: 1 (
kOfxPropKeyString)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionKeyRepeat
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)kOfxPropKeySym - Type: int, Dimension: 1 (
kOfxPropKeySym)kOfxPropKeyString - Type: string, Dimension: 1 (
kOfxPropKeyString)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionKeyUp
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)kOfxPropKeySym - Type: int, Dimension: 1 (
kOfxPropKeySym)kOfxPropKeyString - Type: string, Dimension: 1 (
kOfxPropKeyString)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionLoseFocus
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)
OfxInteractActionPenDown
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxInteractPropPenPosition - Type: double, Dimension: 2 (
kOfxInteractPropPenPosition)OfxInteractPropPenViewportPosition - Type: int, Dimension: 2 (
kOfxInteractPropPenViewportPosition)OfxInteractPropPenPressure - Type: double, Dimension: 1 (
kOfxInteractPropPenPressure)
OfxInteractActionPenMotion
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxInteractPropPenPosition - Type: double, Dimension: 2 (
kOfxInteractPropPenPosition)OfxInteractPropPenViewportPosition - Type: int, Dimension: 2 (
kOfxInteractPropPenViewportPosition)OfxInteractPropPenPressure - Type: double, Dimension: 1 (
kOfxInteractPropPenPressure)
OfxInteractActionPenUp
Input Arguments
OfxPropEffectInstance - Type: pointer, Dimension: 1 (
kOfxPropEffectInstance)OfxInteractPropPixelScale - Type: double, Dimension: 2 (
kOfxInteractPropPixelScale)OfxInteractPropBackgroundColour - Type: double, Dimension: 3 (
kOfxInteractPropBackgroundColour)OfxPropTime - Type: double, Dimension: 1 (
kOfxPropTime)OfxImageEffectPropRenderScale - Type: double, Dimension: 2 (
kOfxImageEffectPropRenderScale)OfxInteractPropPenPosition - Type: double, Dimension: 2 (
kOfxInteractPropPenPosition)OfxInteractPropPenViewportPosition - Type: int, Dimension: 2 (
kOfxInteractPropPenViewportPosition)OfxInteractPropPenPressure - Type: double, Dimension: 1 (
kOfxInteractPropPenPressure)