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

OfxImageClipPropConnected

C #define: kOfxImageClipPropConnected
Type: bool
Dimension: 1
Used in Property Sets: ClipInstance (host)
Doc: For detailed doc, see kOfxImageClipPropConnected.

OfxImageClipPropContinuousSamples

C #define: kOfxImageClipPropContinuousSamples
Type: bool
Dimension: 1
Used in Property Sets: ClipInstance (host)
Doc: For detailed doc, see kOfxImageClipPropContinuousSamples.

OfxImageClipPropIsMask

C #define: kOfxImageClipPropIsMask
Type: bool
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host)
Doc: For detailed doc, see kOfxImageClipPropIsMask.

OfxImageClipPropOptional

C #define: kOfxImageClipPropOptional
Type: bool
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host)
Doc: For detailed doc, see kOfxImageClipPropOptional.

OfxImageEffectFrameVarying

C #define: kOfxImageEffectFrameVarying
Type: bool
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectFrameVarying.

OfxImageEffectHostPropIsBackground

C #define: kOfxImageEffectHostPropIsBackground
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectHostPropIsBackground.

OfxImageEffectInstancePropSequentialRender

C #define: kOfxImageEffectInstancePropSequentialRender
Type: bool
Dimension: 1
Used in Property Sets: EffectInstance (host), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectInstancePropSequentialRender.

OfxImageEffectPluginPropFieldRenderTwiceAlways

C #define: kOfxImageEffectPluginPropFieldRenderTwiceAlways
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropFieldRenderTwiceAlways.

OfxImageEffectPluginPropHostFrameThreading

C #define: kOfxImageEffectPluginPropHostFrameThreading
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropHostFrameThreading.

OfxImageEffectPluginPropObsolete

C #define: kOfxImageEffectPluginPropObsolete
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropObsolete.

OfxImageEffectPluginPropSingleInstance

C #define: kOfxImageEffectPluginPropSingleInstance
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropSingleInstance.

OfxImageEffectPropCudaEnabled

C #define: kOfxImageEffectPropCudaEnabled
Type: bool
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropCudaEnabled.

OfxImageEffectPropInAnalysis

C #define: kOfxImageEffectPropInAnalysis
Type: bool
Dimension: 1
Deprecated in: version 1.4
Doc: For detailed doc, see kOfxImageEffectPropInAnalysis.

OfxImageEffectPropInteractiveRenderStatus

C #define: kOfxImageEffectPropInteractiveRenderStatus
Type: bool
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropInteractiveRenderStatus.

OfxImageEffectPropMetalEnabled

C #define: kOfxImageEffectPropMetalEnabled
Type: bool
Dimension: 1
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropMetalEnabled.

OfxImageEffectPropMultipleClipDepths

C #define: kOfxImageEffectPropSupportsMultipleClipDepths
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSupportsMultipleClipDepths.

OfxImageEffectPropOpenCLEnabled

C #define: kOfxImageEffectPropOpenCLEnabled
Type: bool
Dimension: 1
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOpenCLEnabled.

OfxImageEffectPropOpenGLEnabled

C #define: kOfxImageEffectPropOpenGLEnabled
Type: bool
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropOpenGLEnabled.

OfxImageEffectPropRenderQualityDraft

C #define: kOfxImageEffectPropRenderQualityDraft
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropRenderQualityDraft.

OfxImageEffectPropSequentialRenderStatus

C #define: kOfxImageEffectPropSequentialRenderStatus
Type: bool
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropSequentialRenderStatus.

OfxImageEffectPropSetableFielding

C #define: kOfxImageEffectPropSetableFielding
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSetableFielding.

OfxImageEffectPropSetableFrameRate

C #define: kOfxImageEffectPropSetableFrameRate
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSetableFrameRate.

OfxImageEffectPropSupportsMultiResolution

C #define: kOfxImageEffectPropSupportsMultiResolution
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSupportsMultiResolution.

OfxImageEffectPropSupportsMultipleClipPARs

C #define: kOfxImageEffectPropSupportsMultipleClipPARs
Type: bool
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSupportsMultipleClipPARs.

OfxImageEffectPropSupportsOverlays

C #define: kOfxImageEffectPropSupportsOverlays
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSupportsOverlays.

OfxImageEffectPropSupportsTiles

C #define: kOfxImageEffectPropSupportsTiles
Type: bool
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), EffectInstance (host), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropSupportsTiles.

OfxImageEffectPropTemporalClipAccess

C #define: kOfxImageEffectPropTemporalClipAccess
Type: bool
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxImageEffectPropTemporalClipAccess.

OfxInteractPropHasAlpha

C #define: kOfxInteractPropHasAlpha
Type: bool
Dimension: 1
Used in Property Sets: InteractDescriptor (host), InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropHasAlpha.

OfxParamHostPropSupportsBooleanAnimation

C #define: kOfxParamHostPropSupportsBooleanAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsBooleanAnimation.

OfxParamHostPropSupportsChoiceAnimation

C #define: kOfxParamHostPropSupportsChoiceAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsChoiceAnimation.

OfxParamHostPropSupportsCustomAnimation

C #define: kOfxParamHostPropSupportsCustomAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsCustomAnimation.

OfxParamHostPropSupportsCustomInteract

C #define: kOfxParamHostPropSupportsCustomInteract
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsCustomInteract.

OfxParamHostPropSupportsParametricAnimation

C #define: kOfxParamHostPropSupportsParametricAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsParametricAnimation.

OfxParamHostPropSupportsStrChoice

C #define: kOfxParamHostPropSupportsStrChoice
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxParamHostPropSupportsStrChoice.

OfxParamHostPropSupportsStrChoiceAnimation

C #define: kOfxParamHostPropSupportsStrChoiceAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxParamHostPropSupportsStrChoiceAnimation.

OfxParamHostPropSupportsStringAnimation

C #define: kOfxParamHostPropSupportsStringAnimation
Type: bool
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropSupportsStringAnimation.

OfxParamPropAnimates

C #define: kOfxParamPropAnimates
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropAnimates.

OfxParamPropCanUndo

C #define: kOfxParamPropCanUndo
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropCanUndo.

OfxParamPropChoiceEnum

C #define: kOfxParamPropChoiceEnum
Type: bool
Dimension: 1
Used in Property Sets: ParamsStrChoice (plugin)
Doc: For detailed doc, see kOfxParamPropChoiceEnum.

OfxParamPropEnabled

C #define: kOfxParamPropEnabled
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropEnabled.

OfxParamPropEvaluateOnChange

C #define: kOfxParamPropEvaluateOnChange
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropEvaluateOnChange.

OfxParamPropGroupOpen

C #define: kOfxParamPropGroupOpen
Type: bool
Dimension: 1
Used in Property Sets: ParamsGroup (plugin)
Doc: For detailed doc, see kOfxParamPropGroupOpen.

OfxParamPropHasHostOverlayHandle

C #define: kOfxParamPropHasHostOverlayHandle
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropHasHostOverlayHandle.

OfxParamPropIsAnimating

C #define: kOfxParamPropIsAnimating
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (host), ParamsByte (host), ParamsChoice (host), ParamsCustom (host), ParamsDouble2D3D (host), ParamsInt2D3D (host), ParamsNormalizedSpatial (host), ParamsParametric (host), ParamsParametric (plugin), ParamsStrChoice (host), ParamsString (host)
Doc: For detailed doc, see kOfxParamPropIsAnimating.

OfxParamPropIsAutoKeying

C #define: kOfxParamPropIsAutoKeying
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (host), ParamsByte (host), ParamsChoice (host), ParamsCustom (host), ParamsDouble2D3D (host), ParamsInt2D3D (host), ParamsNormalizedSpatial (host), ParamsParametric (host), ParamsParametric (plugin), ParamsStrChoice (host), ParamsString (host)
Doc: For detailed doc, see kOfxParamPropIsAutoKeying.

OfxParamPropPersistant

C #define: kOfxParamPropPersistant
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropPersistant.

OfxParamPropPluginMayWrite

C #define: kOfxParamPropPluginMayWrite
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Deprecated in: version 1.4
Doc: For detailed doc, see kOfxParamPropPluginMayWrite.

OfxParamPropSecret

C #define: kOfxParamPropSecret
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropSecret.

OfxParamPropShowTimeMarker

C #define: kOfxParamPropShowTimeMarker
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin)
Doc: For detailed doc, see kOfxParamPropShowTimeMarker.

OfxParamPropStringFilePathExists

C #define: kOfxParamPropStringFilePathExists
Type: bool
Dimension: 1
Used in Property Sets: ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropStringFilePathExists.

OfxPropIsInteractive

C #define: kOfxPropIsInteractive
Type: bool
Dimension: 1
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxPropIsInteractive.

OfxPropParamSetNeedsSyncing

C #define: kOfxPropParamSetNeedsSyncing
Type: bool
Dimension: 1
Used in Property Sets: ParameterSet (plugin)
Doc: For detailed doc, see kOfxPropParamSetNeedsSyncing.

kOfxParamPropUseHostOverlayHandle

C #define: kOfxParamPropUseHostOverlayHandle
Type: bool
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropUseHostOverlayHandle.

Double Properties

OfxImageEffectInstancePropEffectDuration

C #define: kOfxImageEffectInstancePropEffectDuration
Type: double
Dimension: 1
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectInstancePropEffectDuration.

OfxImageEffectPropFrameRange

C #define: kOfxImageEffectPropFrameRange
Type: double
Dimension: 2
Used in Property Sets: ClipInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropFrameRange.

OfxImageEffectPropFrameRate

C #define: kOfxImageEffectPropFrameRate
Type: double
Dimension: 1
Used in Property Sets: ClipInstance (host), EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropFrameRate.

OfxImageEffectPropFrameStep

C #define: kOfxImageEffectPropFrameStep
Type: double
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropFrameStep.

OfxImageEffectPropPixelAspectRatio

C #define: kOfxImageEffectPropProjectPixelAspectRatio
Type: double
Dimension: 1
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropProjectPixelAspectRatio.

OfxImageEffectPropProjectExtent

C #define: kOfxImageEffectPropProjectExtent
Type: double
Dimension: 2
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropProjectExtent.

OfxImageEffectPropProjectOffset

C #define: kOfxImageEffectPropProjectOffset
Type: double
Dimension: 2
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropProjectOffset.

OfxImageEffectPropProjectSize

C #define: kOfxImageEffectPropProjectSize
Type: double
Dimension: 2
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropProjectSize.

OfxImageEffectPropRegionOfDefinition

C #define: kOfxImageEffectPropRegionOfDefinition
Type: double
Dimension: 4
Doc: For detailed doc, see kOfxImageEffectPropRegionOfDefinition.

OfxImageEffectPropRegionOfInterest

C #define: kOfxImageEffectPropRegionOfInterest
Type: double
Dimension: 4
Doc: For detailed doc, see kOfxImageEffectPropRegionOfInterest.

OfxImageEffectPropRenderScale

C #define: kOfxImageEffectPropRenderScale
Type: double
Dimension: 2
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImageEffectPropRenderScale.

OfxImageEffectPropUnmappedFrameRange

C #define: kOfxImageEffectPropUnmappedFrameRange
Type: double
Dimension: 2
Used in Property Sets: ClipInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropUnmappedFrameRange.

OfxImageEffectPropUnmappedFrameRate

C #define: kOfxImageEffectPropUnmappedFrameRate
Type: double
Dimension: 1
Used in Property Sets: ClipInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropUnmappedFrameRate.

OfxImagePropPixelAspectRatio

C #define: kOfxImagePropPixelAspectRatio
Type: double
Dimension: 1
Used in Property Sets: ClipInstance (host), Image (host)
Doc: For detailed doc, see kOfxImagePropPixelAspectRatio.

OfxInteractPropBackgroundColour

C #define: kOfxInteractPropBackgroundColour
Type: double
Dimension: 3
Used in Property Sets: InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropBackgroundColour.

OfxInteractPropPenPosition

C #define: kOfxInteractPropPenPosition
Type: double
Dimension: 2
Doc: For detailed doc, see kOfxInteractPropPenPosition.

OfxInteractPropPenPressure

C #define: kOfxInteractPropPenPressure
Type: double
Dimension: 1
Doc: For detailed doc, see kOfxInteractPropPenPressure.

OfxInteractPropPixelScale

C #define: kOfxInteractPropPixelScale
Type: double
Dimension: 2
Used in Property Sets: InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropPixelScale.

OfxInteractPropSuggestedColour

C #define: kOfxInteractPropSuggestedColour
Type: double
Dimension: 3
Used in Property Sets: InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropSuggestedColour.

OfxParamPropDefault

C #define: kOfxParamPropDefault
Type: Multiple types: int, double, string, pointer
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDefault.

OfxParamPropDisplayMax

C #define: kOfxParamPropDisplayMax
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDisplayMax.

OfxParamPropDisplayMin

C #define: kOfxParamPropDisplayMin
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDisplayMin.

OfxParamPropIncrement

C #define: kOfxParamPropIncrement
Type: double
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsDouble2D3D (plugin), ParamsNormalizedSpatial (plugin)
Doc: For detailed doc, see kOfxParamPropIncrement.

OfxParamPropInteractMinimumSize

C #define: kOfxParamPropInteractMinimumSize
Type: double
Dimension: 2
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropInteractMinimumSize.

OfxParamPropInteractSize

C #define: kOfxParamPropInteractSize
Type: double
Dimension: 2
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropInteractSize.

OfxParamPropInteractSizeAspect

C #define: kOfxParamPropInteractSizeAspect
Type: double
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropInteractSizeAspect.

OfxParamPropInterpolationAmount

C #define: kOfxParamPropInterpolationAmount
Type: double
Dimension: 1
Doc: For detailed doc, see kOfxParamPropInterpolationAmount.

OfxParamPropInterpolationTime

C #define: kOfxParamPropInterpolationTime
Type: double
Dimension: 2
Doc: For detailed doc, see kOfxParamPropInterpolationTime.

OfxParamPropMax

C #define: kOfxParamPropMax
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropMax.

OfxParamPropMin

C #define: kOfxParamPropMin
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropMin.

OfxParamPropParametricRange

C #define: kOfxParamPropParametricRange
Type: double
Dimension: 2
Used in Property Sets: ParamsParametric (plugin)
Doc: For detailed doc, see kOfxParamPropParametricRange.

OfxParamPropParametricUIColour

C #define: kOfxParamPropParametricUIColour
Type: double
Dimension: Variable (0 or more)
Used in Property Sets: ParamsParametric (plugin)
Doc: For detailed doc, see kOfxParamPropParametricUIColour.

OfxPropTime

C #define: kOfxPropTime
Type: double
Dimension: 1
Doc: For detailed doc, see kOfxPropTime.

Enumeration Properties

OfxImageClipPropFieldExtraction

C #define: kOfxImageClipPropFieldExtraction
Type: enum
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host)
Valid Values: - OfxImageFieldNone - OfxImageFieldLower - OfxImageFieldUpper - OfxImageFieldBoth - OfxImageFieldSingle - OfxImageFieldDoubled
Doc: For detailed doc, see kOfxImageClipPropFieldExtraction.

OfxImageClipPropFieldOrder

C #define: kOfxImageClipPropFieldOrder
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host)
Valid Values: - OfxImageFieldNone - OfxImageFieldLower - OfxImageFieldUpper
Doc: For detailed doc, see kOfxImageClipPropFieldOrder.

OfxImageClipPropUnmappedComponents

C #define: kOfxImageClipPropUnmappedComponents
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host)
Valid Values: - OfxImageComponentNone - OfxImageComponentRGBA - OfxImageComponentRGB - OfxImageComponentAlpha
Doc: For detailed doc, see kOfxImageClipPropUnmappedComponents.

OfxImageClipPropUnmappedPixelDepth

C #define: kOfxImageClipPropUnmappedPixelDepth
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host)
Valid Values: - OfxBitDepthNone - OfxBitDepthByte - OfxBitDepthShort - OfxBitDepthHalf - OfxBitDepthFloat
Doc: For detailed doc, see kOfxImageClipPropUnmappedPixelDepth.

OfxImageEffectHostPropNativeOrigin

C #define: kOfxImageEffectHostPropNativeOrigin
Type: enum
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Valid Values: - OfxImageEffectHostPropNativeOriginBottomLeft - OfxImageEffectHostPropNativeOriginTopLeft - OfxImageEffectHostPropNativeOriginCenter
Doc: For detailed doc, see kOfxImageEffectHostPropNativeOrigin.

OfxImageEffectPluginRenderThreadSafety

C #define: kOfxImageEffectPluginRenderThreadSafety
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), EffectDescriptor (plugin)
Valid Values: - OfxImageEffectRenderUnsafe - OfxImageEffectRenderInstanceSafe - OfxImageEffectRenderFullySafe
Doc: For detailed doc, see kOfxImageEffectPluginRenderThreadSafety.

OfxImageEffectPropCPURenderSupported

C #define: kOfxImageEffectPropCPURenderSupported
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), EffectInstance (host), ImageEffectHost (host)
Valid Values: - false - true
Introduced in: version 1.5.1
Doc: For detailed doc, see kOfxImageEffectPropCPURenderSupported.

OfxImageEffectPropColourManagementStyle

C #define: kOfxImageEffectPropColourManagementStyle
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), EffectInstance (host), ImageEffectHost (host)
Valid Values: - OfxImageEffectPropColourManagementNone - OfxImageEffectPropColourManagementBasic - OfxImageEffectPropColourManagementCore - OfxImageEffectPropColourManagementFull - OfxImageEffectPropColourManagementOCIO
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropColourManagementStyle.

OfxImageEffectPropComponents

C #define: kOfxImageEffectPropComponents
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host), Image (host)
Valid Values: - OfxImageComponentNone - OfxImageComponentRGBA - OfxImageComponentRGB - OfxImageComponentAlpha
Doc: For detailed doc, see kOfxImageEffectPropComponents.

OfxImageEffectPropContext

C #define: kOfxImageEffectPropContext
Type: enum
Dimension: 1
Used in Property Sets: EffectInstance (host)
Valid Values: - OfxImageEffectContextGenerator - OfxImageEffectContextFilter - OfxImageEffectContextTransition - OfxImageEffectContextPaint - OfxImageEffectContextGeneral - OfxImageEffectContextRetimer
Doc: For detailed doc, see kOfxImageEffectPropContext.

OfxImageEffectPropCudaRenderSupported

C #define: kOfxImageEffectPropCudaRenderSupported
Type: enum
Dimension: 1
Valid Values: - false - true - needed
Doc: For detailed doc, see kOfxImageEffectPropCudaRenderSupported.

OfxImageEffectPropCudaStreamSupported

C #define: kOfxImageEffectPropCudaStreamSupported
Type: enum
Dimension: 1
Valid Values: - false - true - needed
Doc: For detailed doc, see kOfxImageEffectPropCudaStreamSupported.

OfxImageEffectPropFieldToRender

C #define: kOfxImageEffectPropFieldToRender
Type: enum
Dimension: 1
Valid Values: - OfxImageFieldNone - OfxImageFieldBoth - OfxImageFieldLower - OfxImageFieldUpper
Doc: For detailed doc, see kOfxImageEffectPropFieldToRender.

OfxImageEffectPropMetalRenderSupported

C #define: kOfxImageEffectPropMetalRenderSupported
Type: enum
Dimension: 1
Valid Values: - false - true - needed
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropMetalRenderSupported.

OfxImageEffectPropNoSpatialAwareness

C #define: kOfxImageEffectPropNoSpatialAwareness
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Valid Values: - false - true
Doc: For detailed doc, see kOfxImageEffectPropNoSpatialAwareness.

OfxImageEffectPropOpenCLRenderSupported

C #define: kOfxImageEffectPropOpenCLRenderSupported
Type: enum
Dimension: 1
Valid Values: - false - true - needed
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOpenCLRenderSupported.

OfxImageEffectPropOpenCLSupported

C #define: kOfxImageEffectPropOpenCLSupported
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Valid Values: - false - true
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOpenCLSupported.

OfxImageEffectPropOpenGLRenderSupported

C #define: kOfxImageEffectPropOpenGLRenderSupported
Type: enum
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), EffectInstance (host), ImageEffectHost (host)
Valid Values: - false - true - needed
Doc: For detailed doc, see kOfxImageEffectPropOpenGLRenderSupported.

OfxImageEffectPropPixelDepth

C #define: kOfxImageEffectPropPixelDepth
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host), Image (host)
Valid Values: - OfxBitDepthNone - OfxBitDepthByte - OfxBitDepthShort - OfxBitDepthHalf - OfxBitDepthFloat
Doc: For detailed doc, see kOfxImageEffectPropPixelDepth.

OfxImageEffectPropPreMultiplication

C #define: kOfxImageEffectPropPreMultiplication
Type: enum
Dimension: 1
Used in Property Sets: ClipInstance (host), Image (host)
Valid Values: - OfxImageOpaque - OfxImagePreMultiplied - OfxImageUnPreMultiplied
Doc: For detailed doc, see kOfxImageEffectPropPreMultiplication.

OfxImageEffectPropSupportedComponents

C #define: kOfxImageEffectPropSupportedComponents
Type: enum
Dimension: Variable (0 or more)
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), ImageEffectHost (host)
Valid Values: - OfxImageComponentNone - OfxImageComponentRGBA - OfxImageComponentRGB - OfxImageComponentAlpha
Doc: For detailed doc, see kOfxImageEffectPropSupportedComponents.

OfxImageEffectPropSupportedContexts

C #define: kOfxImageEffectPropSupportedContexts
Type: enum
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Valid Values: - OfxImageEffectContextGenerator - OfxImageEffectContextFilter - OfxImageEffectContextTransition - OfxImageEffectContextPaint - OfxImageEffectContextGeneral - OfxImageEffectContextRetimer
Doc: For detailed doc, see kOfxImageEffectPropSupportedContexts.

OfxImageEffectPropSupportedPixelDepths

C #define: kOfxImageEffectPropSupportedPixelDepths
Type: enum
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin)
Valid Values: - OfxBitDepthNone - OfxBitDepthByte - OfxBitDepthShort - OfxBitDepthHalf - OfxBitDepthFloat
Doc: For detailed doc, see kOfxImageEffectPropSupportedPixelDepths.

OfxImageEffectPropThumbnailRender

C #define: kOfxImageEffectPropThumbnailRender
Type: enum
Dimension: 1
Valid Values: - false - true
Introduced in: version 1.5.1
Doc: For detailed doc, see kOfxImageEffectPropThumbnailRender.

OfxImagePropField

C #define: kOfxImagePropField
Type: enum
Dimension: 1
Used in Property Sets: Image (host)
Valid Values: - OfxImageFieldNone - OfxImageFieldBoth - OfxImageFieldLower - OfxImageFieldUpper
Doc: For detailed doc, see kOfxImagePropField.

OfxOpenGLPropPixelDepth

C #define: kOfxOpenGLPropPixelDepth
Type: enum
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin)
Valid Values: - OfxBitDepthNone - OfxBitDepthByte - OfxBitDepthShort - OfxBitDepthHalf - OfxBitDepthFloat
Doc: For detailed doc, see kOfxOpenGLPropPixelDepth.

OfxParamPropCacheInvalidation

C #define: kOfxParamPropCacheInvalidation
Type: enum
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Valid Values: - OfxParamInvalidateValueChange - OfxParamInvalidateValueChangeToEnd - OfxParamInvalidateAll
Doc: For detailed doc, see kOfxParamPropCacheInvalidation.

OfxParamPropDefaultCoordinateSystem

C #define: kOfxParamPropDefaultCoordinateSystem
Type: enum
Dimension: 1
Used in Property Sets: ParamsNormalizedSpatial (plugin)
Valid Values: - OfxParamCoordinatesCanonical - OfxParamCoordinatesNormalised
Doc: For detailed doc, see kOfxParamPropDefaultCoordinateSystem.

OfxParamPropDoubleType

C #define: kOfxParamPropDoubleType
Type: enum
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsDouble2D3D (plugin)
Valid Values: - OfxParamDoubleTypePlain - OfxParamDoubleTypeAngle - OfxParamDoubleTypeScale - OfxParamDoubleTypeTime - OfxParamDoubleTypeAbsoluteTime - OfxParamDoubleTypeX - OfxParamDoubleTypeXAbsolute - OfxParamDoubleTypeY - OfxParamDoubleTypeYAbsolute - OfxParamDoubleTypeXY - OfxParamDoubleTypeXYAbsolute
Doc: For detailed doc, see kOfxParamPropDoubleType.

OfxParamPropStringMode

C #define: kOfxParamPropStringMode
Type: enum
Dimension: 1
Used in Property Sets: ParamsString (plugin)
Valid Values: - OfxParamStringIsSingleLine - OfxParamStringIsMultiLine - OfxParamStringIsFilePath - OfxParamStringIsDirectoryPath - OfxParamStringIsLabel - OfxParamStringIsRichTextFormat
Doc: For detailed doc, see kOfxParamPropStringMode.

OfxPropChangeReason

C #define: kOfxPropChangeReason
Type: enum
Dimension: 1
Valid Values: - OfxChangeUserEdited - OfxChangePluginEdited - OfxChangeTime
Doc: For detailed doc, see kOfxPropChangeReason.

Integer Properties

OfxImageEffectPropOpenGLTextureIndex

C #define: kOfxImageEffectPropOpenGLTextureIndex
Type: int
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropOpenGLTextureIndex.

OfxImageEffectPropOpenGLTextureTarget

C #define: kOfxImageEffectPropOpenGLTextureTarget
Type: int
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropOpenGLTextureTarget.

OfxImageEffectPropRenderWindow

C #define: kOfxImageEffectPropRenderWindow
Type: int
Dimension: 4
Doc: For detailed doc, see kOfxImageEffectPropRenderWindow.

OfxImagePropBounds

C #define: kOfxImagePropBounds
Type: int
Dimension: 4
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImagePropBounds.

OfxImagePropRegionOfDefinition

C #define: kOfxImagePropRegionOfDefinition
Type: int
Dimension: 4
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImagePropRegionOfDefinition.

OfxImagePropRowBytes

C #define: kOfxImagePropRowBytes
Type: int
Dimension: 1
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImagePropRowBytes.

OfxInteractPropBitDepth

C #define: kOfxInteractPropBitDepth
Type: int
Dimension: 1
Used in Property Sets: InteractDescriptor (host), InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropBitDepth.

OfxInteractPropPenViewportPosition

C #define: kOfxInteractPropPenViewportPosition
Type: int
Dimension: 2
Doc: For detailed doc, see kOfxInteractPropPenViewportPosition.

OfxInteractPropViewport

C #define: kOfxInteractPropViewportSize
Type: int
Dimension: 2
Deprecated in: version 1.3
Doc: For detailed doc, see kOfxInteractPropViewportSize.

OfxParamHostPropMaxPages

C #define: kOfxParamHostPropMaxPages
Type: int
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropMaxPages.

OfxParamHostPropMaxParameters

C #define: kOfxParamHostPropMaxParameters
Type: int
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropMaxParameters.

OfxParamHostPropPageRowColumnCount

C #define: kOfxParamHostPropPageRowColumnCount
Type: int
Dimension: 2
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxParamHostPropPageRowColumnCount.

OfxParamPropChoiceOrder

C #define: kOfxParamPropChoiceOrder
Type: int
Dimension: Variable (0 or more)
Used in Property Sets: ParamsChoice (plugin)
Doc: For detailed doc, see kOfxParamPropChoiceOrder.

OfxParamPropDefault

C #define: kOfxParamPropDefault
Type: Multiple types: int, double, string, pointer
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDefault.

OfxParamPropDigits

C #define: kOfxParamPropDigits
Type: int
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsDouble2D3D (plugin), ParamsNormalizedSpatial (plugin)
Doc: For detailed doc, see kOfxParamPropDigits.

OfxParamPropDisplayMax

C #define: kOfxParamPropDisplayMax
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDisplayMax.

OfxParamPropDisplayMin

C #define: kOfxParamPropDisplayMin
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDisplayMin.

OfxParamPropInteractPreferedSize

C #define: kOfxParamPropInteractPreferedSize
Type: int
Dimension: 2
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropInteractPreferedSize.

OfxParamPropMax

C #define: kOfxParamPropMax
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropMax.

OfxParamPropMin

C #define: kOfxParamPropMin
Type: Multiple types: int, double
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropMin.

OfxParamPropParametricDimension

C #define: kOfxParamPropParametricDimension
Type: int
Dimension: 1
Used in Property Sets: ParamsParametric (plugin)
Doc: For detailed doc, see kOfxParamPropParametricDimension.

OfxPropAPIVersion

C #define: kOfxPropAPIVersion
Type: int
Dimension: Variable (0 or more)
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxPropAPIVersion.

OfxPropVersion

C #define: kOfxPropVersion
Type: int
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxPropVersion.

kOfxPropKeySym

C #define: kOfxPropKeySym
Type: int
Dimension: 1
Doc: For detailed doc, see kOfxPropKeySym.

Pointer Properties

OfxImageEffectPluginPropOverlayInteractV1

C #define: kOfxImageEffectPluginPropOverlayInteractV1
Type: pointer
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropOverlayInteractV1.

OfxImageEffectPluginPropOverlayInteractV2

C #define: kOfxImageEffectPluginPropOverlayInteractV2
Type: pointer
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropOverlayInteractV2.

OfxImageEffectPropCudaStream

C #define: kOfxImageEffectPropCudaStream
Type: pointer
Dimension: 1
Doc: For detailed doc, see kOfxImageEffectPropCudaStream.

OfxImageEffectPropMetalCommandQueue

C #define: kOfxImageEffectPropMetalCommandQueue
Type: pointer
Dimension: 1
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropMetalCommandQueue.

OfxImageEffectPropOpenCLCommandQueue

C #define: kOfxImageEffectPropOpenCLCommandQueue
Type: pointer
Dimension: 1
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOpenCLCommandQueue.

OfxImageEffectPropOpenCLImage

C #define: kOfxImageEffectPropOpenCLImage
Type: pointer
Dimension: 1
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOpenCLImage.

OfxImageEffectPropPluginHandle

C #define: kOfxImageEffectPropPluginHandle
Type: pointer
Dimension: 1
Used in Property Sets: EffectInstance (host)
Doc: For detailed doc, see kOfxImageEffectPropPluginHandle.

OfxImagePropData

C #define: kOfxImagePropData
Type: pointer
Dimension: 1
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImagePropData.

OfxInteractPropDrawContext

C #define: kOfxInteractPropDrawContext
Type: pointer
Dimension: 1
Doc: For detailed doc, see kOfxInteractPropDrawContext.

OfxParamPropCustomCallbackV1

C #define: kOfxParamPropCustomInterpCallbackV1
Type: pointer
Dimension: 1
Used in Property Sets: ParamsCustom (plugin)
Doc: For detailed doc, see kOfxParamPropCustomInterpCallbackV1.

OfxParamPropDataPtr

C #define: kOfxParamPropDataPtr
Type: pointer
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDataPtr.

OfxParamPropDefault

C #define: kOfxParamPropDefault
Type: Multiple types: int, double, string, pointer
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDefault.

OfxParamPropInteractV1

C #define: kOfxParamPropInteractV1
Type: pointer
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropInteractV1.

OfxParamPropParametricInteractBackground

C #define: kOfxParamPropParametricInteractBackground
Type: pointer
Dimension: 1
Used in Property Sets: ParamsParametric (plugin)
Doc: For detailed doc, see kOfxParamPropParametricInteractBackground.

OfxPropEffectInstance

C #define: kOfxPropEffectInstance
Type: pointer
Dimension: 1
Used in Property Sets: InteractInstance (host)
Doc: For detailed doc, see kOfxPropEffectInstance.

OfxPropHostOSHandle

C #define: kOfxPropHostOSHandle
Type: pointer
Dimension: 1
Used in Property Sets: ImageEffectHost (host)
Doc: For detailed doc, see kOfxPropHostOSHandle.

OfxPropInstanceData

C #define: kOfxPropInstanceData
Type: pointer
Dimension: 1
Used in Property Sets: EffectInstance (host), InteractInstance (host)
Doc: For detailed doc, see kOfxPropInstanceData.

String Properties

OfxImageClipPropColourspace

C #define: kOfxImageClipPropColourspace
Type: string
Dimension: 1
Used in Property Sets: ClipInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageClipPropColourspace.

OfxImageClipPropPreferredColourspaces

C #define: kOfxImageClipPropPreferredColourspaces
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: ClipInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageClipPropPreferredColourspaces.

OfxImageEffectPluginPropGrouping

C #define: kOfxImageEffectPluginPropGrouping
Type: string
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPluginPropGrouping.

OfxImageEffectPropClipPreferencesSlaveParam

C #define: kOfxImageEffectPropClipPreferencesSlaveParam
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxImageEffectPropClipPreferencesSlaveParam.

OfxImageEffectPropColourManagementAvailableConfigs

C #define: kOfxImageEffectPropColourManagementAvailableConfigs
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropColourManagementAvailableConfigs.

OfxImageEffectPropColourManagementConfig

C #define: kOfxImageEffectPropColourManagementConfig
Type: string
Dimension: 1
Used in Property Sets: EffectInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropColourManagementConfig.

OfxImageEffectPropDisplayColourspace

C #define: kOfxImageEffectPropDisplayColourspace
Type: string
Dimension: 1
Used in Property Sets: EffectInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropDisplayColourspace.

OfxImageEffectPropOCIOConfig

C #define: kOfxImageEffectPropOCIOConfig
Type: string
Dimension: 1
Used in Property Sets: EffectInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOCIOConfig.

OfxImageEffectPropOCIODisplay

C #define: kOfxImageEffectPropOCIODisplay
Type: string
Dimension: 1
Used in Property Sets: EffectInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOCIODisplay.

OfxImageEffectPropOCIOView

C #define: kOfxImageEffectPropOCIOView
Type: string
Dimension: 1
Used in Property Sets: EffectInstance (host)
Introduced in: version 1.5
Doc: For detailed doc, see kOfxImageEffectPropOCIOView.

OfxImagePropUniqueIdentifier

C #define: kOfxImagePropUniqueIdentifier
Type: string
Dimension: 1
Used in Property Sets: Image (host)
Doc: For detailed doc, see kOfxImagePropUniqueIdentifier.

OfxInteractPropSlaveToParam

C #define: kOfxInteractPropSlaveToParam
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: InteractInstance (host)
Doc: For detailed doc, see kOfxInteractPropSlaveToParam.

OfxParamPropChoiceOption

C #define: kOfxParamPropChoiceOption
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: ParamsChoice (plugin), ParamsStrChoice (plugin)
Doc: For detailed doc, see kOfxParamPropChoiceOption.

OfxParamPropCustomValue

C #define: kOfxParamPropCustomValue
Type: string
Dimension: 2
Doc: For detailed doc, see kOfxParamPropCustomValue.

OfxParamPropDefault

C #define: kOfxParamPropDefault
Type: Multiple types: int, double, string, pointer
Dimension: Variable (0 or more)
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropDefault.

OfxParamPropDimensionLabel

C #define: kOfxParamPropDimensionLabel
Type: string
Dimension: 1
Used in Property Sets: ParamsInt2D3D (plugin)
Doc: For detailed doc, see kOfxParamPropDimensionLabel.

OfxParamPropHint

C #define: kOfxParamPropHint
Type: string
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropHint.

OfxParamPropPageChild

C #define: kOfxParamPropPageChild
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: ParamsPage (plugin)
Doc: For detailed doc, see kOfxParamPropPageChild.

OfxParamPropParent

C #define: kOfxParamPropParent
Type: string
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropParent.

OfxParamPropScriptName

C #define: kOfxParamPropScriptName
Type: string
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropScriptName.

OfxParamPropType

C #define: kOfxParamPropType
Type: string
Dimension: 1
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxParamPropType.

OfxPluginPropFilePath

C #define: kOfxPluginPropFilePath
Type: string
Dimension: 1
Used in Property Sets: EffectDescriptor (host)
Doc: For detailed doc, see kOfxPluginPropFilePath.

OfxPluginPropParamPageOrder

C #define: kOfxPluginPropParamPageOrder
Type: string
Dimension: Variable (0 or more)
Used in Property Sets: ParameterSet (plugin)
Doc: For detailed doc, see kOfxPluginPropParamPageOrder.

OfxPropIcon

C #define: kOfxPropIcon
Type: string
Dimension: 2
Used in Property Sets: ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropIcon.

OfxPropLabel

C #define: kOfxPropLabel
Type: string
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), ImageEffectHost (host), ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropLabel.

OfxPropLongLabel

C #define: kOfxPropLongLabel
Type: string
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropLongLabel.

OfxPropName

C #define: kOfxPropName
Type: string
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), ImageEffectHost (host), ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropName.

OfxPropPluginDescription

C #define: kOfxPropPluginDescription
Type: string
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin)
Doc: For detailed doc, see kOfxPropPluginDescription.

OfxPropShortLabel

C #define: kOfxPropShortLabel
Type: string
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropShortLabel.

OfxPropType

C #define: kOfxPropType
Type: string
Dimension: 1
Used in Property Sets: ClipDescriptor (plugin), ClipInstance (host), EffectDescriptor (plugin), EffectInstance (host), Image (host), ImageEffectHost (host), ParamDouble1D (plugin), ParamsByte (plugin), ParamsChoice (plugin), ParamsCustom (plugin), ParamsDouble2D3D (plugin), ParamsGroup (plugin), ParamsInt2D3D (plugin), ParamsNormalizedSpatial (plugin), ParamsPage (plugin), ParamsParametric (plugin), ParamsStrChoice (plugin), ParamsString (plugin)
Doc: For detailed doc, see kOfxPropType.

OfxPropVersionLabel

C #define: kOfxPropVersionLabel
Type: string
Dimension: 1
Used in Property Sets: EffectDescriptor (plugin), ImageEffectHost (host)
Doc: For detailed doc, see kOfxPropVersionLabel.

kOfxPropKeyString

C #define: kOfxPropKeyString
Type: string
Dimension: 1
Doc: For detailed doc, see kOfxPropKeyString.