.. _propertiesReferenceGenerated: Properties Reference ==================== This reference is auto-generated from property definitions in the OpenFX source code. It provides a structured view of properties with their types, dimensions, and where they are used. For each property, a link to the detailed Doxygen documentation is provided when available. For each property, the **Used in Property Sets** field shows which property sets include it, along with which side (host or plugin) is responsible for writing the property in that set. The other side has read-only access. Integer (Boolean) Properties ---------------------------- .. _prop_OfxImageClipPropConnected: **OfxImageClipPropConnected** ^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropConnected` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropConnected`. .. _prop_OfxImageClipPropContinuousSamples: **OfxImageClipPropContinuousSamples** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropContinuousSamples` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropContinuousSamples`. .. _prop_OfxImageClipPropIsMask: **OfxImageClipPropIsMask** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropIsMask` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropIsMask`. .. _prop_OfxImageClipPropOptional: **OfxImageClipPropOptional** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropOptional` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropOptional`. .. _prop_OfxImageEffectFrameVarying: **OfxImageEffectFrameVarying** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectFrameVarying` - **Type**: bool - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectFrameVarying`. .. _prop_OfxImageEffectHostPropIsBackground: **OfxImageEffectHostPropIsBackground** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectHostPropIsBackground` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectHostPropIsBackground`. .. _prop_OfxImageEffectInstancePropSequentialRender: **OfxImageEffectInstancePropSequentialRender** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectInstancePropSequentialRender` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectInstancePropSequentialRender`. .. _prop_OfxImageEffectPluginPropFieldRenderTwiceAlways: **OfxImageEffectPluginPropFieldRenderTwiceAlways** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropFieldRenderTwiceAlways` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropFieldRenderTwiceAlways`. .. _prop_OfxImageEffectPluginPropHostFrameThreading: **OfxImageEffectPluginPropHostFrameThreading** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropHostFrameThreading` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropHostFrameThreading`. .. _prop_OfxImageEffectPluginPropObsolete: **OfxImageEffectPluginPropObsolete** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropObsolete` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropObsolete`. .. _prop_OfxImageEffectPluginPropSingleInstance: **OfxImageEffectPluginPropSingleInstance** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropSingleInstance` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropSingleInstance`. .. _prop_OfxImageEffectPropCudaEnabled: **OfxImageEffectPropCudaEnabled** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropCudaEnabled` - **Type**: bool - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropCudaEnabled`. .. _prop_OfxImageEffectPropInAnalysis: **OfxImageEffectPropInAnalysis** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropInAnalysis` - **Type**: bool - **Dimension**: 1 - **Deprecated in**: version 1.4 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropInAnalysis`. .. _prop_OfxImageEffectPropInteractiveRenderStatus: **OfxImageEffectPropInteractiveRenderStatus** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropInteractiveRenderStatus` - **Type**: bool - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropInteractiveRenderStatus`. .. _prop_OfxImageEffectPropMetalEnabled: **OfxImageEffectPropMetalEnabled** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropMetalEnabled` - **Type**: bool - **Dimension**: 1 - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropMetalEnabled`. .. _prop_OfxImageEffectPropMultipleClipDepths: **OfxImageEffectPropMultipleClipDepths** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportsMultipleClipDepths` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportsMultipleClipDepths`. .. _prop_OfxImageEffectPropOpenCLEnabled: **OfxImageEffectPropOpenCLEnabled** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenCLEnabled` - **Type**: bool - **Dimension**: 1 - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenCLEnabled`. .. _prop_OfxImageEffectPropOpenGLEnabled: **OfxImageEffectPropOpenGLEnabled** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenGLEnabled` - **Type**: bool - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenGLEnabled`. .. _prop_OfxImageEffectPropRenderQualityDraft: **OfxImageEffectPropRenderQualityDraft** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropRenderQualityDraft` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropRenderQualityDraft`. .. _prop_OfxImageEffectPropSequentialRenderStatus: **OfxImageEffectPropSequentialRenderStatus** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSequentialRenderStatus` - **Type**: bool - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSequentialRenderStatus`. .. _prop_OfxImageEffectPropSetableFielding: **OfxImageEffectPropSetableFielding** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSetableFielding` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSetableFielding`. .. _prop_OfxImageEffectPropSetableFrameRate: **OfxImageEffectPropSetableFrameRate** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSetableFrameRate` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSetableFrameRate`. .. _prop_OfxImageEffectPropSupportsMultiResolution: **OfxImageEffectPropSupportsMultiResolution** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportsMultiResolution` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportsMultiResolution`. .. _prop_OfxImageEffectPropSupportsMultipleClipPARs: **OfxImageEffectPropSupportsMultipleClipPARs** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportsMultipleClipPARs` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportsMultipleClipPARs`. .. _prop_OfxImageEffectPropSupportsOverlays: **OfxImageEffectPropSupportsOverlays** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportsOverlays` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportsOverlays`. .. _prop_OfxImageEffectPropSupportsTiles: **OfxImageEffectPropSupportsTiles** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportsTiles` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`EffectInstance ` (host), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportsTiles`. .. _prop_OfxImageEffectPropTemporalClipAccess: **OfxImageEffectPropTemporalClipAccess** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropTemporalClipAccess` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropTemporalClipAccess`. .. _prop_OfxInteractPropHasAlpha: **OfxInteractPropHasAlpha** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropHasAlpha` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`InteractDescriptor ` (host), :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropHasAlpha`. .. _prop_OfxParamHostPropSupportsBooleanAnimation: **OfxParamHostPropSupportsBooleanAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsBooleanAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsBooleanAnimation`. .. _prop_OfxParamHostPropSupportsChoiceAnimation: **OfxParamHostPropSupportsChoiceAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsChoiceAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsChoiceAnimation`. .. _prop_OfxParamHostPropSupportsCustomAnimation: **OfxParamHostPropSupportsCustomAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsCustomAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsCustomAnimation`. .. _prop_OfxParamHostPropSupportsCustomInteract: **OfxParamHostPropSupportsCustomInteract** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsCustomInteract` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsCustomInteract`. .. _prop_OfxParamHostPropSupportsParametricAnimation: **OfxParamHostPropSupportsParametricAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsParametricAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsParametricAnimation`. .. _prop_OfxParamHostPropSupportsStrChoice: **OfxParamHostPropSupportsStrChoice** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsStrChoice` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsStrChoice`. .. _prop_OfxParamHostPropSupportsStrChoiceAnimation: **OfxParamHostPropSupportsStrChoiceAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsStrChoiceAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsStrChoiceAnimation`. .. _prop_OfxParamHostPropSupportsStringAnimation: **OfxParamHostPropSupportsStringAnimation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropSupportsStringAnimation` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropSupportsStringAnimation`. .. _prop_OfxParamPropAnimates: **OfxParamPropAnimates** ^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropAnimates` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropAnimates`. .. _prop_OfxParamPropCanUndo: **OfxParamPropCanUndo** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropCanUndo` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropCanUndo`. .. _prop_OfxParamPropChoiceEnum: **OfxParamPropChoiceEnum** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropChoiceEnum` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsStrChoice ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropChoiceEnum`. .. _prop_OfxParamPropEnabled: **OfxParamPropEnabled** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropEnabled` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropEnabled`. .. _prop_OfxParamPropEvaluateOnChange: **OfxParamPropEvaluateOnChange** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropEvaluateOnChange` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropEvaluateOnChange`. .. _prop_OfxParamPropGroupOpen: **OfxParamPropGroupOpen** ^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropGroupOpen` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsGroup ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropGroupOpen`. .. _prop_OfxParamPropHasHostOverlayHandle: **OfxParamPropHasHostOverlayHandle** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropHasHostOverlayHandle` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropHasHostOverlayHandle`. .. _prop_OfxParamPropIsAnimating: **OfxParamPropIsAnimating** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropIsAnimating` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (host), :ref:`ParamsByte ` (host), :ref:`ParamsChoice ` (host), :ref:`ParamsCustom ` (host), :ref:`ParamsDouble2D3D ` (host), :ref:`ParamsInt2D3D ` (host), :ref:`ParamsNormalizedSpatial ` (host), :ref:`ParamsParametric ` (host), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (host), :ref:`ParamsString ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropIsAnimating`. .. _prop_OfxParamPropIsAutoKeying: **OfxParamPropIsAutoKeying** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropIsAutoKeying` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (host), :ref:`ParamsByte ` (host), :ref:`ParamsChoice ` (host), :ref:`ParamsCustom ` (host), :ref:`ParamsDouble2D3D ` (host), :ref:`ParamsInt2D3D ` (host), :ref:`ParamsNormalizedSpatial ` (host), :ref:`ParamsParametric ` (host), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (host), :ref:`ParamsString ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropIsAutoKeying`. .. _prop_OfxParamPropPersistant: **OfxParamPropPersistant** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropPersistant` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropPersistant`. .. _prop_OfxParamPropPluginMayWrite: **OfxParamPropPluginMayWrite** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropPluginMayWrite` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Deprecated in**: version 1.4 - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropPluginMayWrite`. .. _prop_OfxParamPropSecret: **OfxParamPropSecret** ^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropSecret` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropSecret`. .. _prop_OfxParamPropShowTimeMarker: **OfxParamPropShowTimeMarker** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropShowTimeMarker` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropShowTimeMarker`. .. _prop_OfxParamPropStringFilePathExists: **OfxParamPropStringFilePathExists** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropStringFilePathExists` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropStringFilePathExists`. .. _prop_OfxPropIsInteractive: **OfxPropIsInteractive** ^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropIsInteractive` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropIsInteractive`. .. _prop_OfxPropParamSetNeedsSyncing: **OfxPropParamSetNeedsSyncing** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropParamSetNeedsSyncing` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParameterSet ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropParamSetNeedsSyncing`. .. _prop_kOfxParamPropUseHostOverlayHandle: **kOfxParamPropUseHostOverlayHandle** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropUseHostOverlayHandle` - **Type**: bool - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropUseHostOverlayHandle`. Double Properties ----------------- .. _prop_OfxImageEffectInstancePropEffectDuration: **OfxImageEffectInstancePropEffectDuration** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectInstancePropEffectDuration` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectInstancePropEffectDuration`. .. _prop_OfxImageEffectPropFrameRange: **OfxImageEffectPropFrameRange** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropFrameRange` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropFrameRange`. .. _prop_OfxImageEffectPropFrameRate: **OfxImageEffectPropFrameRate** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropFrameRate` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host), :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropFrameRate`. .. _prop_OfxImageEffectPropFrameStep: **OfxImageEffectPropFrameStep** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropFrameStep` - **Type**: double - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropFrameStep`. .. _prop_OfxImageEffectPropPixelAspectRatio: **OfxImageEffectPropPixelAspectRatio** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropProjectPixelAspectRatio` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropProjectPixelAspectRatio`. .. _prop_OfxImageEffectPropProjectExtent: **OfxImageEffectPropProjectExtent** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropProjectExtent` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropProjectExtent`. .. _prop_OfxImageEffectPropProjectOffset: **OfxImageEffectPropProjectOffset** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropProjectOffset` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropProjectOffset`. .. _prop_OfxImageEffectPropProjectSize: **OfxImageEffectPropProjectSize** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropProjectSize` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropProjectSize`. .. _prop_OfxImageEffectPropRegionOfDefinition: **OfxImageEffectPropRegionOfDefinition** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropRegionOfDefinition` - **Type**: double - **Dimension**: 4 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropRegionOfDefinition`. .. _prop_OfxImageEffectPropRegionOfInterest: **OfxImageEffectPropRegionOfInterest** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropRegionOfInterest` - **Type**: double - **Dimension**: 4 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropRegionOfInterest`. .. _prop_OfxImageEffectPropRenderScale: **OfxImageEffectPropRenderScale** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropRenderScale` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropRenderScale`. .. _prop_OfxImageEffectPropUnmappedFrameRange: **OfxImageEffectPropUnmappedFrameRange** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropUnmappedFrameRange` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropUnmappedFrameRange`. .. _prop_OfxImageEffectPropUnmappedFrameRate: **OfxImageEffectPropUnmappedFrameRate** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropUnmappedFrameRate` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropUnmappedFrameRate`. .. _prop_OfxImagePropPixelAspectRatio: **OfxImagePropPixelAspectRatio** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropPixelAspectRatio` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host), :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropPixelAspectRatio`. .. _prop_OfxInteractPropBackgroundColour: **OfxInteractPropBackgroundColour** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropBackgroundColour` - **Type**: double - **Dimension**: 3 - **Used in Property Sets**: :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropBackgroundColour`. .. _prop_OfxInteractPropPenPosition: **OfxInteractPropPenPosition** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropPenPosition` - **Type**: double - **Dimension**: 2 - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropPenPosition`. .. _prop_OfxInteractPropPenPressure: **OfxInteractPropPenPressure** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropPenPressure` - **Type**: double - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropPenPressure`. .. _prop_OfxInteractPropPixelScale: **OfxInteractPropPixelScale** ^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropPixelScale` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropPixelScale`. .. _prop_OfxInteractPropSuggestedColour: **OfxInteractPropSuggestedColour** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropSuggestedColour` - **Type**: double - **Dimension**: 3 - **Used in Property Sets**: :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropSuggestedColour`. .. _prop_OfxParamPropDefault: **OfxParamPropDefault** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDefault` - **Type**: Multiple types: int, double, string, pointer - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDefault`. .. _prop_OfxParamPropDisplayMax: **OfxParamPropDisplayMax** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDisplayMax` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDisplayMax`. .. _prop_OfxParamPropDisplayMin: **OfxParamPropDisplayMin** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDisplayMin` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDisplayMin`. .. _prop_OfxParamPropIncrement: **OfxParamPropIncrement** ^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropIncrement` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropIncrement`. .. _prop_OfxParamPropInteractMinimumSize: **OfxParamPropInteractMinimumSize** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInteractMinimumSize` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInteractMinimumSize`. .. _prop_OfxParamPropInteractSize: **OfxParamPropInteractSize** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInteractSize` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInteractSize`. .. _prop_OfxParamPropInteractSizeAspect: **OfxParamPropInteractSizeAspect** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInteractSizeAspect` - **Type**: double - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInteractSizeAspect`. .. _prop_OfxParamPropInterpolationAmount: **OfxParamPropInterpolationAmount** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInterpolationAmount` - **Type**: double - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInterpolationAmount`. .. _prop_OfxParamPropInterpolationTime: **OfxParamPropInterpolationTime** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInterpolationTime` - **Type**: double - **Dimension**: 2 - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInterpolationTime`. .. _prop_OfxParamPropMax: **OfxParamPropMax** ^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropMax` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropMax`. .. _prop_OfxParamPropMin: **OfxParamPropMin** ^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropMin` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropMin`. .. _prop_OfxParamPropParametricRange: **OfxParamPropParametricRange** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropParametricRange` - **Type**: double - **Dimension**: 2 - **Used in Property Sets**: :ref:`ParamsParametric ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropParametricRange`. .. _prop_OfxParamPropParametricUIColour: **OfxParamPropParametricUIColour** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropParametricUIColour` - **Type**: double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamsParametric ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropParametricUIColour`. .. _prop_OfxPropTime: **OfxPropTime** ^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropTime` - **Type**: double - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxPropTime`. Enumeration Properties ---------------------- .. _prop_OfxImageClipPropFieldExtraction: **OfxImageClipPropFieldExtraction** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropFieldExtraction` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host) - **Valid Values**: - ``OfxImageFieldNone`` - ``OfxImageFieldLower`` - ``OfxImageFieldUpper`` - ``OfxImageFieldBoth`` - ``OfxImageFieldSingle`` - ``OfxImageFieldDoubled`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropFieldExtraction`. .. _prop_OfxImageClipPropFieldOrder: **OfxImageClipPropFieldOrder** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropFieldOrder` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Valid Values**: - ``OfxImageFieldNone`` - ``OfxImageFieldLower`` - ``OfxImageFieldUpper`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropFieldOrder`. .. _prop_OfxImageClipPropUnmappedComponents: **OfxImageClipPropUnmappedComponents** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropUnmappedComponents` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Valid Values**: - ``OfxImageComponentNone`` - ``OfxImageComponentRGBA`` - ``OfxImageComponentRGB`` - ``OfxImageComponentAlpha`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropUnmappedComponents`. .. _prop_OfxImageClipPropUnmappedPixelDepth: **OfxImageClipPropUnmappedPixelDepth** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropUnmappedPixelDepth` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Valid Values**: - ``OfxBitDepthNone`` - ``OfxBitDepthByte`` - ``OfxBitDepthShort`` - ``OfxBitDepthHalf`` - ``OfxBitDepthFloat`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropUnmappedPixelDepth`. .. _prop_OfxImageEffectHostPropNativeOrigin: **OfxImageEffectHostPropNativeOrigin** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectHostPropNativeOrigin` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``OfxImageEffectHostPropNativeOriginBottomLeft`` - ``OfxImageEffectHostPropNativeOriginTopLeft`` - ``OfxImageEffectHostPropNativeOriginCenter`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectHostPropNativeOrigin`. .. _prop_OfxImageEffectPluginRenderThreadSafety: **OfxImageEffectPluginRenderThreadSafety** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginRenderThreadSafety` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`EffectDescriptor ` (plugin) - **Valid Values**: - ``OfxImageEffectRenderUnsafe`` - ``OfxImageEffectRenderInstanceSafe`` - ``OfxImageEffectRenderFullySafe`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginRenderThreadSafety`. .. _prop_OfxImageEffectPropCPURenderSupported: **OfxImageEffectPropCPURenderSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropCPURenderSupported` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`EffectInstance ` (host), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``false`` - ``true`` - **Introduced in**: version 1.5.1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropCPURenderSupported`. .. _prop_OfxImageEffectPropColourManagementStyle: **OfxImageEffectPropColourManagementStyle** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropColourManagementStyle` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`EffectInstance ` (host), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``OfxImageEffectPropColourManagementNone`` - ``OfxImageEffectPropColourManagementBasic`` - ``OfxImageEffectPropColourManagementCore`` - ``OfxImageEffectPropColourManagementFull`` - ``OfxImageEffectPropColourManagementOCIO`` - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropColourManagementStyle`. .. _prop_OfxImageEffectPropComponents: **OfxImageEffectPropComponents** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropComponents` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host), :ref:`Image ` (host) - **Valid Values**: - ``OfxImageComponentNone`` - ``OfxImageComponentRGBA`` - ``OfxImageComponentRGB`` - ``OfxImageComponentAlpha`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropComponents`. .. _prop_OfxImageEffectPropContext: **OfxImageEffectPropContext** ^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropContext` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Valid Values**: - ``OfxImageEffectContextGenerator`` - ``OfxImageEffectContextFilter`` - ``OfxImageEffectContextTransition`` - ``OfxImageEffectContextPaint`` - ``OfxImageEffectContextGeneral`` - ``OfxImageEffectContextRetimer`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropContext`. .. _prop_OfxImageEffectPropCudaRenderSupported: **OfxImageEffectPropCudaRenderSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropCudaRenderSupported` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``false`` - ``true`` - ``needed`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropCudaRenderSupported`. .. _prop_OfxImageEffectPropCudaStreamSupported: **OfxImageEffectPropCudaStreamSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropCudaStreamSupported` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``false`` - ``true`` - ``needed`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropCudaStreamSupported`. .. _prop_OfxImageEffectPropFieldToRender: **OfxImageEffectPropFieldToRender** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropFieldToRender` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``OfxImageFieldNone`` - ``OfxImageFieldBoth`` - ``OfxImageFieldLower`` - ``OfxImageFieldUpper`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropFieldToRender`. .. _prop_OfxImageEffectPropMetalRenderSupported: **OfxImageEffectPropMetalRenderSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropMetalRenderSupported` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``false`` - ``true`` - ``needed`` - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropMetalRenderSupported`. .. _prop_OfxImageEffectPropNoSpatialAwareness: **OfxImageEffectPropNoSpatialAwareness** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropNoSpatialAwareness` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Valid Values**: - ``false`` - ``true`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropNoSpatialAwareness`. .. _prop_OfxImageEffectPropOpenCLRenderSupported: **OfxImageEffectPropOpenCLRenderSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenCLRenderSupported` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``false`` - ``true`` - ``needed`` - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenCLRenderSupported`. .. _prop_OfxImageEffectPropOpenCLSupported: **OfxImageEffectPropOpenCLSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenCLSupported` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``false`` - ``true`` - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenCLSupported`. .. _prop_OfxImageEffectPropOpenGLRenderSupported: **OfxImageEffectPropOpenGLRenderSupported** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenGLRenderSupported` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`EffectInstance ` (host), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``false`` - ``true`` - ``needed`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenGLRenderSupported`. .. _prop_OfxImageEffectPropPixelDepth: **OfxImageEffectPropPixelDepth** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropPixelDepth` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host), :ref:`Image ` (host) - **Valid Values**: - ``OfxBitDepthNone`` - ``OfxBitDepthByte`` - ``OfxBitDepthShort`` - ``OfxBitDepthHalf`` - ``OfxBitDepthFloat`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropPixelDepth`. .. _prop_OfxImageEffectPropPreMultiplication: **OfxImageEffectPropPreMultiplication** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropPreMultiplication` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host), :ref:`Image ` (host) - **Valid Values**: - ``OfxImageOpaque`` - ``OfxImagePreMultiplied`` - ``OfxImageUnPreMultiplied`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropPreMultiplication`. .. _prop_OfxImageEffectPropSupportedComponents: **OfxImageEffectPropSupportedComponents** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportedComponents` - **Type**: enum - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``OfxImageComponentNone`` - ``OfxImageComponentRGBA`` - ``OfxImageComponentRGB`` - ``OfxImageComponentAlpha`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportedComponents`. .. _prop_OfxImageEffectPropSupportedContexts: **OfxImageEffectPropSupportedContexts** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportedContexts` - **Type**: enum - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Valid Values**: - ``OfxImageEffectContextGenerator`` - ``OfxImageEffectContextFilter`` - ``OfxImageEffectContextTransition`` - ``OfxImageEffectContextPaint`` - ``OfxImageEffectContextGeneral`` - ``OfxImageEffectContextRetimer`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportedContexts`. .. _prop_OfxImageEffectPropSupportedPixelDepths: **OfxImageEffectPropSupportedPixelDepths** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropSupportedPixelDepths` - **Type**: enum - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Valid Values**: - ``OfxBitDepthNone`` - ``OfxBitDepthByte`` - ``OfxBitDepthShort`` - ``OfxBitDepthHalf`` - ``OfxBitDepthFloat`` - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropSupportedPixelDepths`. .. _prop_OfxImageEffectPropThumbnailRender: **OfxImageEffectPropThumbnailRender** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropThumbnailRender` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``false`` - ``true`` - **Introduced in**: version 1.5.1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropThumbnailRender`. .. _prop_OfxImagePropField: **OfxImagePropField** ^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropField` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`Image ` (host) - **Valid Values**: - ``OfxImageFieldNone`` - ``OfxImageFieldBoth`` - ``OfxImageFieldLower`` - ``OfxImageFieldUpper`` - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropField`. .. _prop_OfxOpenGLPropPixelDepth: **OfxOpenGLPropPixelDepth** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxOpenGLPropPixelDepth` - **Type**: enum - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Valid Values**: - ``OfxBitDepthNone`` - ``OfxBitDepthByte`` - ``OfxBitDepthShort`` - ``OfxBitDepthHalf`` - ``OfxBitDepthFloat`` - **Doc**: For detailed doc, see :c:macro:`kOfxOpenGLPropPixelDepth`. .. _prop_OfxParamPropCacheInvalidation: **OfxParamPropCacheInvalidation** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropCacheInvalidation` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Valid Values**: - ``OfxParamInvalidateValueChange`` - ``OfxParamInvalidateValueChangeToEnd`` - ``OfxParamInvalidateAll`` - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropCacheInvalidation`. .. _prop_OfxParamPropDefaultCoordinateSystem: **OfxParamPropDefaultCoordinateSystem** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDefaultCoordinateSystem` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsNormalizedSpatial ` (plugin) - **Valid Values**: - ``OfxParamCoordinatesCanonical`` - ``OfxParamCoordinatesNormalised`` - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDefaultCoordinateSystem`. .. _prop_OfxParamPropDoubleType: **OfxParamPropDoubleType** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDoubleType` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsDouble2D3D ` (plugin) - **Valid Values**: - ``OfxParamDoubleTypePlain`` - ``OfxParamDoubleTypeAngle`` - ``OfxParamDoubleTypeScale`` - ``OfxParamDoubleTypeTime`` - ``OfxParamDoubleTypeAbsoluteTime`` - ``OfxParamDoubleTypeX`` - ``OfxParamDoubleTypeXAbsolute`` - ``OfxParamDoubleTypeY`` - ``OfxParamDoubleTypeYAbsolute`` - ``OfxParamDoubleTypeXY`` - ``OfxParamDoubleTypeXYAbsolute`` - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDoubleType`. .. _prop_OfxParamPropStringMode: **OfxParamPropStringMode** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropStringMode` - **Type**: enum - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsString ` (plugin) - **Valid Values**: - ``OfxParamStringIsSingleLine`` - ``OfxParamStringIsMultiLine`` - ``OfxParamStringIsFilePath`` - ``OfxParamStringIsDirectoryPath`` - ``OfxParamStringIsLabel`` - ``OfxParamStringIsRichTextFormat`` - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropStringMode`. .. _prop_OfxPropChangeReason: **OfxPropChangeReason** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropChangeReason` - **Type**: enum - **Dimension**: 1 - **Valid Values**: - ``OfxChangeUserEdited`` - ``OfxChangePluginEdited`` - ``OfxChangeTime`` - **Doc**: For detailed doc, see :c:macro:`kOfxPropChangeReason`. Integer Properties ------------------ .. _prop_OfxImageEffectPropOpenGLTextureIndex: **OfxImageEffectPropOpenGLTextureIndex** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenGLTextureIndex` - **Type**: int - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenGLTextureIndex`. .. _prop_OfxImageEffectPropOpenGLTextureTarget: **OfxImageEffectPropOpenGLTextureTarget** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenGLTextureTarget` - **Type**: int - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenGLTextureTarget`. .. _prop_OfxImageEffectPropRenderWindow: **OfxImageEffectPropRenderWindow** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropRenderWindow` - **Type**: int - **Dimension**: 4 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropRenderWindow`. .. _prop_OfxImagePropBounds: **OfxImagePropBounds** ^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropBounds` - **Type**: int - **Dimension**: 4 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropBounds`. .. _prop_OfxImagePropRegionOfDefinition: **OfxImagePropRegionOfDefinition** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropRegionOfDefinition` - **Type**: int - **Dimension**: 4 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropRegionOfDefinition`. .. _prop_OfxImagePropRowBytes: **OfxImagePropRowBytes** ^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropRowBytes` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropRowBytes`. .. _prop_OfxInteractPropBitDepth: **OfxInteractPropBitDepth** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropBitDepth` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`InteractDescriptor ` (host), :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropBitDepth`. .. _prop_OfxInteractPropPenViewportPosition: **OfxInteractPropPenViewportPosition** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropPenViewportPosition` - **Type**: int - **Dimension**: 2 - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropPenViewportPosition`. .. _prop_OfxInteractPropViewport: **OfxInteractPropViewport** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropViewportSize` - **Type**: int - **Dimension**: 2 - **Deprecated in**: version 1.3 - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropViewportSize`. .. _prop_OfxParamHostPropMaxPages: **OfxParamHostPropMaxPages** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropMaxPages` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropMaxPages`. .. _prop_OfxParamHostPropMaxParameters: **OfxParamHostPropMaxParameters** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropMaxParameters` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropMaxParameters`. .. _prop_OfxParamHostPropPageRowColumnCount: **OfxParamHostPropPageRowColumnCount** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamHostPropPageRowColumnCount` - **Type**: int - **Dimension**: 2 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxParamHostPropPageRowColumnCount`. .. _prop_OfxParamPropChoiceOrder: **OfxParamPropChoiceOrder** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropChoiceOrder` - **Type**: int - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamsChoice ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropChoiceOrder`. .. _prop_OfxParamPropDefault: **OfxParamPropDefault** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDefault` - **Type**: Multiple types: int, double, string, pointer - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDefault`. .. _prop_OfxParamPropDigits: **OfxParamPropDigits** ^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDigits` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDigits`. .. _prop_OfxParamPropDisplayMax: **OfxParamPropDisplayMax** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDisplayMax` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDisplayMax`. .. _prop_OfxParamPropDisplayMin: **OfxParamPropDisplayMin** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDisplayMin` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDisplayMin`. .. _prop_OfxParamPropInteractPreferedSize: **OfxParamPropInteractPreferedSize** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInteractPreferedSize` - **Type**: int - **Dimension**: 2 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInteractPreferedSize`. .. _prop_OfxParamPropMax: **OfxParamPropMax** ^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropMax` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropMax`. .. _prop_OfxParamPropMin: **OfxParamPropMin** ^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropMin` - **Type**: Multiple types: int, double - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropMin`. .. _prop_OfxParamPropParametricDimension: **OfxParamPropParametricDimension** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropParametricDimension` - **Type**: int - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsParametric ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropParametricDimension`. .. _prop_OfxPropAPIVersion: **OfxPropAPIVersion** ^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropAPIVersion` - **Type**: int - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropAPIVersion`. .. _prop_OfxPropVersion: **OfxPropVersion** ^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropVersion` - **Type**: int - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropVersion`. .. _prop_kOfxPropKeySym: **kOfxPropKeySym** ^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropKeySym` - **Type**: int - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxPropKeySym`. Pointer Properties ------------------ .. _prop_OfxImageEffectPluginPropOverlayInteractV1: **OfxImageEffectPluginPropOverlayInteractV1** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropOverlayInteractV1` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropOverlayInteractV1`. .. _prop_OfxImageEffectPluginPropOverlayInteractV2: **OfxImageEffectPluginPropOverlayInteractV2** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropOverlayInteractV2` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropOverlayInteractV2`. .. _prop_OfxImageEffectPropCudaStream: **OfxImageEffectPropCudaStream** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropCudaStream` - **Type**: pointer - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropCudaStream`. .. _prop_OfxImageEffectPropMetalCommandQueue: **OfxImageEffectPropMetalCommandQueue** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropMetalCommandQueue` - **Type**: pointer - **Dimension**: 1 - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropMetalCommandQueue`. .. _prop_OfxImageEffectPropOpenCLCommandQueue: **OfxImageEffectPropOpenCLCommandQueue** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenCLCommandQueue` - **Type**: pointer - **Dimension**: 1 - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenCLCommandQueue`. .. _prop_OfxImageEffectPropOpenCLImage: **OfxImageEffectPropOpenCLImage** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOpenCLImage` - **Type**: pointer - **Dimension**: 1 - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOpenCLImage`. .. _prop_OfxImageEffectPropPluginHandle: **OfxImageEffectPropPluginHandle** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropPluginHandle` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropPluginHandle`. .. _prop_OfxImagePropData: **OfxImagePropData** ^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropData` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropData`. .. _prop_OfxInteractPropDrawContext: **OfxInteractPropDrawContext** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropDrawContext` - **Type**: pointer - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropDrawContext`. .. _prop_OfxParamPropCustomCallbackV1: **OfxParamPropCustomCallbackV1** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropCustomInterpCallbackV1` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsCustom ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropCustomInterpCallbackV1`. .. _prop_OfxParamPropDataPtr: **OfxParamPropDataPtr** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDataPtr` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDataPtr`. .. _prop_OfxParamPropDefault: **OfxParamPropDefault** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDefault` - **Type**: Multiple types: int, double, string, pointer - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDefault`. .. _prop_OfxParamPropInteractV1: **OfxParamPropInteractV1** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropInteractV1` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropInteractV1`. .. _prop_OfxParamPropParametricInteractBackground: **OfxParamPropParametricInteractBackground** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropParametricInteractBackground` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsParametric ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropParametricInteractBackground`. .. _prop_OfxPropEffectInstance: **OfxPropEffectInstance** ^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropEffectInstance` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropEffectInstance`. .. _prop_OfxPropHostOSHandle: **OfxPropHostOSHandle** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropHostOSHandle` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropHostOSHandle`. .. _prop_OfxPropInstanceData: **OfxPropInstanceData** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropInstanceData` - **Type**: pointer - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host), :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropInstanceData`. String Properties ----------------- .. _prop_OfxImageClipPropColourspace: **OfxImageClipPropColourspace** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropColourspace` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropColourspace`. .. _prop_OfxImageClipPropPreferredColourspaces: **OfxImageClipPropPreferredColourspaces** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageClipPropPreferredColourspaces` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ClipInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageClipPropPreferredColourspaces`. .. _prop_OfxImageEffectPluginPropGrouping: **OfxImageEffectPluginPropGrouping** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPluginPropGrouping` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPluginPropGrouping`. .. _prop_OfxImageEffectPropClipPreferencesSlaveParam: **OfxImageEffectPropClipPreferencesSlaveParam** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropClipPreferencesSlaveParam` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropClipPreferencesSlaveParam`. .. _prop_OfxImageEffectPropColourManagementAvailableConfigs: **OfxImageEffectPropColourManagementAvailableConfigs** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropColourManagementAvailableConfigs` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropColourManagementAvailableConfigs`. .. _prop_OfxImageEffectPropColourManagementConfig: **OfxImageEffectPropColourManagementConfig** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropColourManagementConfig` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropColourManagementConfig`. .. _prop_OfxImageEffectPropDisplayColourspace: **OfxImageEffectPropDisplayColourspace** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropDisplayColourspace` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropDisplayColourspace`. .. _prop_OfxImageEffectPropOCIOConfig: **OfxImageEffectPropOCIOConfig** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOCIOConfig` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOCIOConfig`. .. _prop_OfxImageEffectPropOCIODisplay: **OfxImageEffectPropOCIODisplay** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOCIODisplay` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOCIODisplay`. .. _prop_OfxImageEffectPropOCIOView: **OfxImageEffectPropOCIOView** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImageEffectPropOCIOView` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectInstance ` (host) - **Introduced in**: version 1.5 - **Doc**: For detailed doc, see :c:macro:`kOfxImageEffectPropOCIOView`. .. _prop_OfxImagePropUniqueIdentifier: **OfxImagePropUniqueIdentifier** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxImagePropUniqueIdentifier` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`Image ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxImagePropUniqueIdentifier`. .. _prop_OfxInteractPropSlaveToParam: **OfxInteractPropSlaveToParam** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxInteractPropSlaveToParam` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`InteractInstance ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxInteractPropSlaveToParam`. .. _prop_OfxParamPropChoiceOption: **OfxParamPropChoiceOption** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropChoiceOption` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamsChoice ` (plugin), :ref:`ParamsStrChoice ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropChoiceOption`. .. _prop_OfxParamPropCustomValue: **OfxParamPropCustomValue** ^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropCustomValue` - **Type**: string - **Dimension**: 2 - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropCustomValue`. .. _prop_OfxParamPropDefault: **OfxParamPropDefault** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDefault` - **Type**: Multiple types: int, double, string, pointer - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDefault`. .. _prop_OfxParamPropDimensionLabel: **OfxParamPropDimensionLabel** ^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropDimensionLabel` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamsInt2D3D ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropDimensionLabel`. .. _prop_OfxParamPropHint: **OfxParamPropHint** ^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropHint` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropHint`. .. _prop_OfxParamPropPageChild: **OfxParamPropPageChild** ^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropPageChild` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParamsPage ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropPageChild`. .. _prop_OfxParamPropParent: **OfxParamPropParent** ^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropParent` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropParent`. .. _prop_OfxParamPropScriptName: **OfxParamPropScriptName** ^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropScriptName` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropScriptName`. .. _prop_OfxParamPropType: **OfxParamPropType** ^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxParamPropType` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxParamPropType`. .. _prop_OfxPluginPropFilePath: **OfxPluginPropFilePath** ^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPluginPropFilePath` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPluginPropFilePath`. .. _prop_OfxPluginPropParamPageOrder: **OfxPluginPropParamPageOrder** ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPluginPropParamPageOrder` - **Type**: string - **Dimension**: Variable (0 or more) - **Used in Property Sets**: :ref:`ParameterSet ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPluginPropParamPageOrder`. .. _prop_OfxPropIcon: **OfxPropIcon** ^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropIcon` - **Type**: string - **Dimension**: 2 - **Used in Property Sets**: :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropIcon`. .. _prop_OfxPropLabel: **OfxPropLabel** ^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropLabel` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host), :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropLabel`. .. _prop_OfxPropLongLabel: **OfxPropLongLabel** ^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropLongLabel` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropLongLabel`. .. _prop_OfxPropName: **OfxPropName** ^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropName` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`ImageEffectHost ` (host), :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropName`. .. _prop_OfxPropPluginDescription: **OfxPropPluginDescription** ^^^^^^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropPluginDescription` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropPluginDescription`. .. _prop_OfxPropShortLabel: **OfxPropShortLabel** ^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropShortLabel` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropShortLabel`. .. _prop_OfxPropType: **OfxPropType** ^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropType` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`ClipDescriptor ` (plugin), :ref:`ClipInstance ` (host), :ref:`EffectDescriptor ` (plugin), :ref:`EffectInstance ` (host), :ref:`Image ` (host), :ref:`ImageEffectHost ` (host), :ref:`ParamDouble1D ` (plugin), :ref:`ParamsByte ` (plugin), :ref:`ParamsChoice ` (plugin), :ref:`ParamsCustom ` (plugin), :ref:`ParamsDouble2D3D ` (plugin), :ref:`ParamsGroup ` (plugin), :ref:`ParamsInt2D3D ` (plugin), :ref:`ParamsNormalizedSpatial ` (plugin), :ref:`ParamsPage ` (plugin), :ref:`ParamsParametric ` (plugin), :ref:`ParamsStrChoice ` (plugin), :ref:`ParamsString ` (plugin) - **Doc**: For detailed doc, see :c:macro:`kOfxPropType`. .. _prop_OfxPropVersionLabel: **OfxPropVersionLabel** ^^^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropVersionLabel` - **Type**: string - **Dimension**: 1 - **Used in Property Sets**: :ref:`EffectDescriptor ` (plugin), :ref:`ImageEffectHost ` (host) - **Doc**: For detailed doc, see :c:macro:`kOfxPropVersionLabel`. .. _prop_kOfxPropKeyString: **kOfxPropKeyString** ^^^^^^^^^^^^^^^^^ - **C #define**: :c:macro:`kOfxPropKeyString` - **Type**: string - **Dimension**: 1 - **Doc**: For detailed doc, see :c:macro:`kOfxPropKeyString`.