Document version 0.6
Copyright © 2007 Bruno Nicoletti
Table of Contents
OfxPropertySuiteV1::propSetPointer
— Set a single value in a pointer property OfxPropertySuiteV1::propSetString
— Set a single value in a string propertyOfxPropertySuiteV1::propSetDouble
— Set a single value in a double propertyOfxPropertySuiteV1::propSetInt
— Set a single value in an int property OfxPropertySuiteV1::propSetPointerN
— Set multiple values of the pointer propertyOfxPropertySuiteV1::propSetStringN
— Set multiple values of a string propertyOfxPropertySuiteV1::propSetDoubleN
— Set multiple values of a double propertyOfxPropertySuiteV1::propSetIntN
— Set multiple values of an int property OfxPropertySuiteV1::propGetPointer
— Get a single value from a pointer propertyOfxPropertySuiteV1::propGetString
— Get a single value of a string propertyOfxPropertySuiteV1::propGetDouble
— Get a single value of a double propertyOfxPropertySuiteV1::propGetInt
— Get a single value of an int propertyOfxPropertySuiteV1::propGetPointerN
— Get multiple values of a pointer property OfxPropertySuiteV1::propGetStringN
— Get multiple values of a string propertyOfxPropertySuiteV1::propGetDoubleN
— Get multiple values of a double propertyOfxPropertySuiteV1::propGetIntN
— Get multiple values of an int propertyOfxPropertySuiteV1::propReset
— Resets all dimensions of a property to it's default valueOfxPropertySuiteV1::propGetDimension
— Gets the dimension of the propertyOfxImageEffectSuiteV1::getPropertySet
— Retrieves the property set for the given image effectOfxImageEffectSuiteV1::getParamSet
— Retrieves the parameter set for the given image effectOfxImageEffectSuiteV1::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 clipOfxImageEffectSuiteV1::clipGetImage
— Get a handle for an image in a clip at the indicated time and indicated regionOfxImageEffectSuiteV1::clipReleaseImage
— Releases the image handle previously returned by clipGetImageOfxImageEffectSuiteV1::clipGetRegionOfDefinition
— Returns the spatial region of definition of the clip at the given timeOfxImageEffectSuiteV1::abort
— Returns whether to abort processing or not.OfxImageEffectSuiteV1::imageMemoryAlloc
— Allocate memory from the host's image memory poolOfxImageEffectSuiteV1::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 dataOfxProgressSuiteV1::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 timelineOfxParameterSuiteV1::paramDefine
— Defines a new parameter of the given type in a describe actionOfxParameterSuiteV1::paramGetHandle
— Retrieves the handle for a parameter in a given parameter setOfxParameterSuiteV1::paramSetGetPropertySet
— Retrieves the property set handle for the given parameter setOfxParameterSuiteV1::paramGetPropertySet
— Retrieves the property set handle for the given parameterOfxParameterSuiteV1::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 parameterOfxParameterSuiteV1::paramSetValueAtTime
— Keyframes the value of a parameter at a specific time.OfxParameterSuiteV1::paramGetNumKeys
— Returns the number of keyframes in the parameterOfxParameterSuiteV1::paramGetKeyTime
— Returns the time of the nth keyOfxParameterSuiteV1::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 purposesOfxParameterSuiteV1::paramEditEnd
— Used to group any parameter changes for undo/redo purposesOfxMemorySuiteV1::memoryAlloc
— Allocate memory.OfxMemorySuiteV1::memoryFree
— Frees memory.OfxMultiThreadSuiteV1::multiThread
— Function to spawn SMP threadsOfxMultiThreadSuiteV1::multiThreadNumCPUs
— Function which indicates the number of CPUs available for SMP processingOfxMultiThreadSuiteV1::multiThreadIndex
— Function which indicates the index of the current threadOfxMultiThreadSuiteV1::multiThreadIsSpawnedThread
— Function to enquire if the calling thread was spawned by multiThreadOfxMultiThreadSuiteV1::mutexCreate
— Create a mutexOfxMultiThreadSuiteV1::mutexDestroy
— Destroy a mutexOfxMultiThreadSuiteV1::mutexLock
— Blocking lock on the mutexOfxMultiThreadSuiteV1::mutexUnLock
— Unlock the mutexOfxMultiThreadSuiteV1::mutexTryLock
— Non blocking attempt to lock the mutexOfxInteractSuiteV1::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 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 continouslykOfxImageClipPropFieldExtraction
— 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 inputkOfxImageClipPropOptional
— Indicates if a clip is optional.kOfxImageClipPropUnmappedComponents
— Indicates the current 'raw' component type on a clip before any mapping by clip preferenceskOfxImageClipPropUnmappedPixelDepth
— Indicates the type of each component in a clip before any mapping by clip preferenceskOfxImageEffectFrameVarying
— Indicates whether an effect will generate different images from frame to frame.kOfxImageEffectHostPropIsBackground
— Indicates if a host is a background render.kOfxImageEffectInstancePropEffectDuration
— The duration of the effectkOfxImageEffectInstancePropSequentialRender
— Says whether an effect needs to be rendered sequentially or notkOfxImageEffectPluginPropFieldRenderTwiceAlways
— 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 threadingkOfxImageEffectPluginPropOverlayInteractV1
— Sets the entry for an effect's overlay interactionkOfxImageEffectPluginPropSingleInstance
— Indicates whether only one instance of a plugin can exist at the same timekOfxImageEffectPluginRenderThreadSafety
— 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 preferenceskOfxImageEffectPropComponents
— 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 renderskOfxImageEffectPropInAnalysis
— Indicates whether an effect is performing an analysis pass.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 imagekOfxImageEffectPropProjectExtent
— 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 projectkOfxImageEffectPropProjectSize
— The size of the current project in canonical coordinates.kOfxImageEffectPropRegionOfDefinition
— Used to indicate the region of definition of a plug-inkOfxImageEffectPropRegionOfInterest
— The value of a region of interest.kOfxImageEffectPropRenderScale
— The proxy render scale currently being applied.kOfxImageEffectPropRenderWindow
— The region to be rendered.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 hostkOfxImageEffectPropSupportsMultiResolution
— 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 effectkOfxImageEffectPropSupportsMultipleClipPARs
— Indicates whether a host or plugin can support clips of differing pixel aspect ratios going into/out of an effectkOfxImageEffectPropSupportsOverlays
— Indicates whether a host support image effect ImageEffectOverlays.kOfxImageEffectPropSupportsTiles
— Indicates whether a clip, plugin or host supports tiled imageskOfxImageEffectPropTemporalClipAccess
— 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 clipkOfxImagePropBounds
— The bounds of an image's pixels.kOfxImagePropData
— The pixel data pointer of an image.kOfxImagePropField
— Which fields are present in the imagekOfxImagePropPixelAspectRatio
— 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 instancekOfxInteractPropBitDepth
— Indicates whether the dits per component in the interact's openGL frame bufferkOfxInteractPropHasAlpha
— Indicates whether the interact's frame buffer has an alpha component or notkOfxInteractPropPenPosition
— The position of the pen in an interact.kOfxInteractPropPenPressure
— The pressure of the pen in an interact.kOfxInteractPropPixelScale
— The size of a real screen pixel under the interact's cannonical projection.kOfxInteractPropSlaveToParam
— The set of parameters on which a value change will trigger a redraw for an interact.kOfxInteractPropViewportSize
— The size of an interact's openGL viewportkOfxParamHostPropMaxPages
— 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 paramskOfxParamHostPropSupportsChoiceAnimation
— 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 parameterskOfxParamHostPropSupportsStringAnimation
— 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 stackkOfxParamPropChoiceOption
— 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 it's own data behind.kOfxParamPropDefault
— The default value of a parameter.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),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 performkOfxParamPropInterpolationTime
— 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.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 passkOfxParamPropScriptName
— 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.kOfxPluginPropFilePath
— The file path to the plugin.kOfxPluginPropParamPageOrder
— Sets the parameter pages and order of pages.kOfxPropChangeReason
— Indicates why a plug-in changed.kOfxPropEffectInstance
— A pointer to an effect instance.kOfxPropInstanceData
— A private data pointer that the plug-in can store it's 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 pressedkOfxPropLabel
— User visible name of an object.kOfxPropLongLabel
— Long user visible name of an object.kOfxPropName
— Unique name of an object.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