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