Document version 1.4
Copyright © 2005-2015 The Open Effects Association
Table of Contents
OfxPropertySuiteV1::propSetPointer
— Set a single value in a pointer property
OfxPropertySuiteV1::propSetString
— Set a single value in a string property
OfxPropertySuiteV1::propSetDouble
— Set a single value in a double property
OfxPropertySuiteV1::propSetInt
— Set a single value in an int property
OfxPropertySuiteV1::propSetPointerN
— Set multiple values of the pointer property
OfxPropertySuiteV1::propSetStringN
— Set multiple values of a string property
OfxPropertySuiteV1::propSetDoubleN
— Set multiple values of a double property
OfxPropertySuiteV1::propSetIntN
— Set multiple values of an int property
OfxPropertySuiteV1::propGetPointer
— Get a single value from a pointer property
OfxPropertySuiteV1::propGetString
— Get a single value of a string property
OfxPropertySuiteV1::propGetDouble
— Get a single value of a double property
OfxPropertySuiteV1::propGetInt
— Get a single value of an int property
OfxPropertySuiteV1::propGetPointerN
— Get multiple values of a pointer property
OfxPropertySuiteV1::propGetStringN
— Get multiple values of a string property
OfxPropertySuiteV1::propGetDoubleN
— Get multiple values of a double property
OfxPropertySuiteV1::propGetIntN
— Get multiple values of an int property
OfxPropertySuiteV1::propReset
— Resets all dimensions of a property to its default value
OfxPropertySuiteV1::propGetDimension
— Gets the dimension of the property
OfxImageEffectSuiteV1::getPropertySet
— Retrieves the property set for the given image effect
OfxImageEffectSuiteV1::getParamSet
— Retrieves the parameter set for the given image effect
OfxImageEffectSuiteV1::clipDefine
— Define a clip to the effect.
OfxImageEffectSuiteV1::clipGetHandle
— Get the propery handle of the named input clip in the given instance
OfxImageEffectSuiteV1::clipGetPropertySet
— Retrieves the property set for a given clip
OfxImageEffectSuiteV1::clipGetImage
— Get a handle for an image in a clip at the indicated time and indicated region
OfxImageEffectSuiteV1::clipReleaseImage
— Releases the image handle previously returned by clipGetImage
OfxImageEffectSuiteV1::clipGetRegionOfDefinition
— Returns the spatial region of definition of the clip at the given time
OfxImageEffectSuiteV1::abort
— Returns whether to abort processing or not.
OfxImageEffectSuiteV1::imageMemoryAlloc
— Allocate memory from the host's image memory pool
OfxImageEffectSuiteV1::imageMemoryFree
— Frees a memory handle and associated memory.
OfxImageEffectSuiteV1::imageMemoryLock
— Lock the memory associated with a memory handle and make it available for use.
OfxImageEffectSuiteV1::imageMemoryUnlock
— Unlock allocated image data
OfxProgressSuiteV1::progressStart
— Initiate a progress bar display.
OfxProgressSuiteV1::progressUpdate
— Indicate how much of the processing task has been completed and reports on any abort status.
OfxProgressSuiteV1::progressEnd
— Signal that we are finished with the progress meter.
OfxTimeLineSuiteV1::getTime
— Get the time value of the timeline that is controlling to the indicated effect.
OfxTimeLineSuiteV1::gotoTime
— Move the timeline control to the indicated time.
OfxTimeLineSuiteV1::getTimeBounds
— Get the current bounds on a timeline
OfxParameterSuiteV1::paramDefine
— Defines a new parameter of the given type in a describe action
OfxParameterSuiteV1::paramGetHandle
— Retrieves the handle for a parameter in a given parameter set
OfxParameterSuiteV1::paramSetGetPropertySet
— Retrieves the property set handle for the given parameter set
OfxParameterSuiteV1::paramGetPropertySet
— Retrieves the property set handle for the given parameter
OfxParameterSuiteV1::paramGetValue
— Gets the current value of a parameter,
OfxParameterSuiteV1::paramGetValueAtTime
— Gets the value of a parameter at a specific time.
OfxParameterSuiteV1::paramGetDerivative
— Gets the derivative of a parameter at a specific time.
OfxParameterSuiteV1::paramGetIntegral
— Gets the integral of a parameter over a specific time range,
OfxParameterSuiteV1::paramSetValue
— Sets the current value of a parameter
OfxParameterSuiteV1::paramSetValueAtTime
— Keyframes the value of a parameter at a specific time.
OfxParameterSuiteV1::paramGetNumKeys
— Returns the number of keyframes in the parameter
OfxParameterSuiteV1::paramGetKeyTime
— Returns the time of the nth key
OfxParameterSuiteV1::paramGetKeyIndex
— Finds the index of a keyframe at/before/after a specified time.
OfxParameterSuiteV1::paramDeleteKey
— Deletes a keyframe if one exists at the given time.
OfxParameterSuiteV1::paramDeleteAllKeys
— Deletes all keyframes from a parameter.
OfxParameterSuiteV1::paramCopy
— Copies one parameter to another, including any animation etc...
OfxParameterSuiteV1::paramEditBegin
— Used to group any parameter changes for undo/redo purposes
OfxParameterSuiteV1::paramEditEnd
— Used to group any parameter changes for undo/redo purposes
OfxParametricParameterSuiteV1::parametricParamGetValue
— Evaluates a parametric parameter
OfxParametricParameterSuiteV1::parametricParamGetNControlPoints
— Returns the number of control points in the parametric param.
OfxParametricParameterSuiteV1::parametricParamGetNthControlPoint
— Returns the key/value pair of the nth control point.
OfxParametricParameterSuiteV1::parametricParamSetNthControlPoint
— Modifies an existing control point on a curve
OfxParametricParameterSuiteV1::parametricParamAddControlPoint
— Adds a control point to the curve.
OfxParametricParameterSuiteV1::parametricParamDeleteControlPoint
— Deletes the nth control point from a parametric param.
OfxParametricParameterSuiteV1::parametricParamDeleteAllControlPoints
— Delete all curve control points on the given param.
OfxMemorySuiteV1::memoryAlloc
— Allocate memory.
OfxMemorySuiteV1::memoryFree
— Frees memory.
OfxMultiThreadSuiteV1::multiThread
— Function to spawn SMP threads
OfxMultiThreadSuiteV1::multiThreadNumCPUs
— Function which indicates the number of CPUs available for SMP processing
OfxMultiThreadSuiteV1::multiThreadIndex
— Function which indicates the index of the current thread
OfxMultiThreadSuiteV1::multiThreadIsSpawnedThread
— Function to enquire if the calling thread was spawned by multiThread
OfxMultiThreadSuiteV1::mutexCreate
— Create a mutex
OfxMultiThreadSuiteV1::mutexDestroy
— Destroy a mutex
OfxMultiThreadSuiteV1::mutexLock
— Blocking lock on the mutex
OfxMultiThreadSuiteV1::mutexUnLock
— Unlock the mutex
OfxMultiThreadSuiteV1::mutexTryLock
— Non blocking attempt to lock the mutex
OfxInteractSuiteV1::interactSwapBuffers
— Requests an openGL buffer swap on the interact instance
OfxInteractSuiteV1::interactRedraw
— Requests a redraw of the interact instance
OfxInteractSuiteV1::interactGetPropertySet
— Gets the property set handle for this interact handle
OfxMessageSuiteV2::message
— Post a transient message on the host, using printf style varargs. Same as the V1 message suite call.
OfxMessageSuiteV2::setPersistentMessage
— Post a persistent message on an effect, using printf style varargs, and set error states. New for V2 message suite.
OfxMessageSuiteV2::clearPersistentMessage
Clears any persistent message on an effect handle that was set by
OfxMessageSuiteV2::setPersistentMessage
. New for V2 message suite.
OfxImageEffectOpenGLRenderSuiteV1::clipLoadTexture
— loads an image from an OFX clip as a texture into OpenGL
OfxImageEffectOpenGLRenderSuiteV1::clipFreeTexture
— Releases the texture handle previously returned by
OfxImageEffectOpenGLRenderSuiteV1::flushResources
— Request the host to minimize its GPU resource load
kOfxImageClipPropConnected
— Says whether the clip is actually connected at the moment.
kOfxImageClipPropContinuousSamples
— Clip and action argument property which indicates that the clip can be sampled continously
kOfxImageClipPropFieldExtraction
— Controls how a plugin fetched fielded imagery from a clip.
kOfxImageClipPropFieldOrder
— Which spatial field occurs temporally first in a frame.
kOfxImageClipPropIsMask
— Indicates that a clip is intended to be used as a mask input
kOfxImageClipPropOptional
— Indicates if a clip is optional.
kOfxImageClipPropUnmappedComponents
— Indicates the current 'raw' component type on a clip before any mapping by clip preferences
kOfxImageClipPropUnmappedPixelDepth
— Indicates the type of each component in a clip before any mapping by clip preferences
kOfxImageEffectFrameVarying
— Indicates whether an effect will generate different images from frame to frame.
kOfxImageEffectHostPropIsBackground
— Indicates if a host is a background render.
kOfxImageEffectHostPropNativeOrigin
— Property that indicates the host native UI space - this is only a UI hint, has no impact on pixel processing
kOfxImageEffectInstancePropEffectDuration
— The duration of the effect
kOfxImageEffectInstancePropSequentialRender
— Indicates whether a plugin needs sequential rendering, and a host support it
kOfxImageEffectPluginPropFieldRenderTwiceAlways
— Controls how a plugin renders fielded footage.
kOfxImageEffectPluginPropGrouping
— Indicates the effect group for this plugin.
kOfxImageEffectPluginPropHostFrameThreading
— Indicates whether a plugin lets the host perform per frame SMP threading
kOfxImageEffectPluginPropOverlayInteractV1
— Sets the entry for an effect's overlay interaction
kOfxImageEffectPluginPropSingleInstance
— Indicates whether only one instance of a plugin can exist at the same time
kOfxImageEffectPluginRenderThreadSafety
— Indicates how many simultaneous renders the plugin can deal with.
kOfxImageEffectPropClipPreferencesSlaveParam
— Indicates the set of parameters on which a value change will trigger a change to clip preferences
kOfxImageEffectPropComponents
— Indicates the current component type in a clip or image (after any mapping)
kOfxImageEffectPropContext
— Indicates the context a plugin instance has been created for.
kOfxImageEffectPropFieldToRender
— Indicates which field is being rendered.
kOfxImageEffectPropFrameRange
— The frame range over which a clip has images.
kOfxImageEffectPropFrameRate
— The frame rate of a clip or instance's project.
kOfxImageEffectPropFrameStep
— The frame step used for a sequence of renders
kOfxImageEffectPropInteractiveRenderStatus
— Property that indicates if a plugin is being rendered in response to user interaction.
kOfxImageEffectPropOpenGLEnabled
— Indicates that an image effect SHOULD use OpenGL acceleration in
kOfxImageEffectPropOpenGLRenderSupported
— Indicates whether a host or plugin can support OpenGL accelerated
kOfxImageEffectPropOpenGLTextureIndex
— Indicates the texture index of an image turned into an OpenGL
kOfxImageEffectPropOpenGLTextureTarget
— Indicates the texture target enumerator of an image turned into
kOfxImageEffectPropPixelDepth
— Indicates the type of each component in a clip or image (after any mapping)
kOfxImageEffectPropPluginHandle
— The plugin handle passed to the initial 'describe' action.
kOfxImageEffectPropPreMultiplication
— Indicates the premultiplication state of a clip or image
kOfxImageEffectPropProjectExtent
— The extent of the current project in canonical coordinates.
kOfxImageEffectPropProjectOffset
— The offset of the current project in canonical coordinates.
kOfxImageEffectPropProjectPixelAspectRatio
— The pixel aspect ratio of the current project
kOfxImageEffectPropProjectSize
— The size of the current project in canonical coordinates.
kOfxImageEffectPropRegionOfDefinition
— Used to indicate the region of definition of a plug-in
kOfxImageEffectPropRegionOfInterest
— The value of a region of interest.
kOfxImageEffectPropRenderQualityDraft
— Indicates whether an effect can take quality shortcuts to improve speed.
kOfxImageEffectPropRenderScale
— The proxy render scale currently being applied.
kOfxImageEffectPropRenderWindow
— The region to be rendered.
kOfxImageEffectPropSequentialRenderStatus
— Property on all the render action that indicate the current sequential render status of a host
kOfxImageEffectPropSetableFielding
— Indicates whether the host will let a plugin set the fielding of the output clip.
kOfxImageEffectPropSetableFrameRate
— Indicates whether the host will let a plugin set the frame rate of the output clip.
kOfxImageEffectPropSupportedComponents
— Indicates the components supported by a clip or host,
kOfxImageEffectPropSupportedContexts
— Indicates to the host the contexts a plugin can be used in.
kOfxImageEffectPropSupportedPixelDepths
— Indicates the bit depths support by a plug-in or host
kOfxImageEffectPropSupportsMultiResolution
— Indicates whether a plugin or host support multiple resolution images.
kOfxImageEffectPropSupportsMultipleClipDepths
— Indicates whether a host or plugin can support clips of differing component depths going into/out of an effect
kOfxImageEffectPropSupportsMultipleClipPARs
— Indicates whether a host or plugin can support clips of differing pixel aspect ratios going into/out of an effect
kOfxImageEffectPropSupportsOverlays
Indicates whether a host support image effect ImageEffectOverlays.
kOfxImageEffectPropSupportsTiles
— Indicates whether a clip, plugin or host supports tiled images
kOfxImageEffectPropTemporalClipAccess
— Indicates support for random temporal access to images in a clip.
kOfxImageEffectPropUnmappedFrameRange
— The unmaped frame range over which an output clip has images.
kOfxImageEffectPropUnmappedFrameRate
— Indicates the original unmapped frame rate (frames/second) of a clip
kOfxImagePropBounds
— The bounds of an image's pixels.
kOfxImagePropData
— The pixel data pointer of an image.
kOfxImagePropField
— Which fields are present in the image
kOfxImagePropPixelAspectRatio
— The pixel aspect ratio of a clip or image.
kOfxImagePropRegionOfDefinition
— The full region of definition of an image.
kOfxImagePropRowBytes
— The number of bytes in a row of an image.
kOfxImagePropUniqueIdentifier
— Uniquely labels an image
kOfxInteractPropBackgroundColour
— The background colour of the application behind an interact instance
kOfxInteractPropBitDepth
— Indicates whether the dits per component in the interact's openGL frame buffer
kOfxInteractPropHasAlpha
— Indicates whether the interact's frame buffer has an alpha component or not
kOfxInteractPropPenPosition
— The position of the pen in an interact.
kOfxInteractPropPenPressure
— The pressure of the pen in an interact.
kOfxInteractPropPenViewportPosition
— The position of the pen in an interact in viewport coordinates.
kOfxInteractPropPixelScale
— The size of a real screen pixel under the interact's canonical projection.
kOfxInteractPropSlaveToParam
— The set of parameters on which a value change will trigger a redraw for an interact.
kOfxInteractPropSuggestedColour
— The suggested colour to draw a widget in an interact, typically for overlays.
kOfxOpenGLPropPixelDepth
— Indicates the bit depths supported by a plug-in during OpenGL renders.
kOfxParamHostPropMaxPages
— Indicates the maximum number of parameter pages.
kOfxParamHostPropMaxParameters
— Indicates the maximum numbers of parameters available on the host.
kOfxParamHostPropPageRowColumnCount
— This indicates the number of parameter rows and coloumns on a page.
kOfxParamHostPropSupportsBooleanAnimation
— Indicates if the host supports animation of boolean params
kOfxParamHostPropSupportsChoiceAnimation
— Indicates if the host supports animation of choice params
kOfxParamHostPropSupportsCustomAnimation
— Indicates if the host supports animation of custom parameters
kOfxParamHostPropSupportsCustomInteract
— Indicates if the host supports custom interacts for parameters
kOfxParamHostPropSupportsParametricAnimation
— Property on the host to indicate support for parametric parameter animation.
kOfxParamHostPropSupportsStringAnimation
— Indicates if the host supports animation of string params
kOfxParamPropAnimates
— Flags whether a parameter can animate.
kOfxParamPropCacheInvalidation
— Specifies how modifying the value of a param will affect any output of an effect over time.
kOfxParamPropCanUndo
— Flags whether changes to a parameter should be put on the undo/redo stack
kOfxParamPropChoiceOption
— Set an option in a choice parameter.
kOfxParamPropCustomInterpCallbackV1
— A pointer to a custom parameter's interpolation function.
kOfxParamPropCustomValue
— Used by interpolating custom parameters to get and set interpolated values.
kOfxParamPropDataPtr
— A private data pointer that the plug-in can store its own data behind.
kOfxParamPropDefault
— The default value of a parameter.
kOfxParamPropDefaultCoordinateSystem
— Describes in which coordinate system a spatial double parameter's default value is specified.
kOfxParamPropDigits
— How many digits after a decimal point to display for a double param in a GUI.
kOfxParamPropDimensionLabel
— Label for individual dimensions on a multidimensional numeric parameter.
kOfxParamPropDisplayMax
— The maximum value for a numeric parameter on any user interface.
kOfxParamPropDisplayMin
— The minimum value for a numeric parameter on any user interface.
kOfxParamPropDoubleType
— Describes how the double parameter should be interpreted by a host.
kOfxParamPropEnabled
— Used to enable a parameter in the user interface.
kOfxParamPropEvaluateOnChange
— Flags whether changing a parameter's value forces an evalution (ie: render),
kOfxParamPropGroupOpen
— Whether the initial state of a group is open or closed in a hierarchical layout.
kOfxParamPropHasHostOverlayHandle
— A flag to indicate if there is a host overlay UI handle for the given parameter.
kOfxParamPropHint
— A hint to the user as to how the parameter is to be used.
kOfxParamPropIncrement
— The granularity of a slider used to represent a numeric parameter.
kOfxParamPropInteractMinimumSize
— The minimum size of a parameter's custom interface, in screen pixels.
kOfxParamPropInteractPreferedSize
— The preferred size of a parameter's custom interface.
kOfxParamPropInteractSize
— The size of a parameter instance's custom interface in screen pixels.
kOfxParamPropInteractSizeAspect
— The preferred aspect ratio of a parameter's custom interface.
kOfxParamPropInteractV1
— Overrides the parameter's standard user interface with the given interact.
kOfxParamPropInterpolationAmount
Property used by
OfxCustomParamInterpFuncV1
to indicate the amount of interpolation to perform
kOfxParamPropInterpolationTime
— Used by interpolating custom parameters to indicate the time a key occurs at.
kOfxParamPropIsAnimating
— Flags whether a parameter is currently animating.
kOfxParamPropIsAutoKeying
— Will a value change on the parameter add automatic keyframes.
kOfxParamPropMax
— The maximum value for a numeric parameter.
kOfxParamPropMin
— The minimum value for a numeric parameter.
kOfxParamPropPageChild
— The names of the parameters included in a page parameter.
kOfxParamPropParametricDimension
— The dimension of a parametric param
kOfxParamPropParametricInteractBackground
— Interact entry point to draw the background of a parametric parameter.
kOfxParamPropParametricRange
— Property to indicate the min and max range of the parametric input value.
kOfxParamPropParametricUIColour
— The colour of parametric param curve interface in any UI.
kOfxParamPropParent
— The name of a parameter's parent group.
kOfxParamPropPersistant
— Flags whether the value of a parameter should persist.
kOfxParamPropPluginMayWrite
— Flags whether the plugin will attempt to set the value of a parameter in some callback or analysis pass
kOfxParamPropScriptName
— The value to be used as the id of the parameter in a host scripting language.
kOfxParamPropSecret
— Flags whether a parameter should be exposed to a user,
kOfxParamPropShowTimeMarker
— Enables the display of a time marker on the host's time line to indicate the value of the absolute time param.
kOfxParamPropStringFilePathExists
— Indicates string parameters of file or directory type need that file to exist already.
kOfxParamPropStringMode
— Used to indicate the type of a string parameter.
kOfxParamPropType
— The type of a parameter.
kOfxParamPropUseHostOverlayHandle
— A flag to indicate that the host should use a native UI overlay handle for the given parameter.
kOfxPluginPropFilePath
— The file path to the plugin.
kOfxPluginPropParamPageOrder
— Sets the parameter pages and order of pages.
kOfxPropAPIVersion
— Property on the host descriptor, saying what API version of the API is being implemented
kOfxPropChangeReason
— Indicates why a plug-in changed.
kOfxPropEffectInstance
— A pointer to an effect instance.
kOfxPropHostOSHandle
— A pointer to an operating system specific application handle.
kOfxPropIcon
— If set this tells the host to use an icon instead of a label for some object in the interface.
kOfxPropInstanceData
— A private data pointer that the plug-in can store its own data behind.
kOfxPropIsInteractive
— Indicates if a host is actively editing the effect with some GUI.
kOfxPropKeyString
— This property encodes a single keypresses that generates a unicode code point. The value is stored as a UTF8 string.
kOfxPropKeySym
— Property used to indicate which a key on the keyboard or a button on a button device has been pressed
kOfxPropLabel
— User visible name of an object.
kOfxPropLongLabel
— Long user visible name of an object.
kOfxPropName
— Unique name of an object.
kOfxPropParamSetNeedsSyncing
— States whether the plugin needs to resync its private data
kOfxPropPluginDescription
— Description of the plug-in to a user.
kOfxPropShortLabel
— Short user visible name of an object.
kOfxPropTime
— General property used to get/set the time of something.
kOfxPropType
— General property, used to identify the kind of an object behind a handle
kOfxPropVersion
— Identifies a specific version of a host or plugin.
kOfxPropVersionLabel
— Unique user readable version string of a plugin or host.