Back to Main Site
API Reference
Programming Reference
Programming Guide
Chapter 16. Properties By Object
Prev
Next
Chapter 16. Properties By Object
This chapter lists all the properties on each OFX object.
Properties on the Image Effect Host
kOfxPropAPIVersion
- (read only) the version of the API implemented by the host, if not present, it is safe to assume "1.0"
kOfxPropType
- (read only) set to "host"
kOfxPropName
- (read only) the globally unique name of the application, eg: "com.acmesofware.funkyCompositor"
kOfxPropLabel
- (read only) the user visible name of the appliaction,
kOfxPropVersion
- (read only) the version number of the host
kOfxPropVersionLabel
- (read only) a user readable version label
kOfxImageEffectHostPropIsBackground
- (read only) is the application a background renderrer
kOfxImageEffectPropSupportsOverlays
- (read only) does the application support overlay interactive GUIs
kOfxImageEffectPropSupportsMultiResolution
- (read only) does the application support images of different sizes
kOfxImageEffectPropSupportsTiles
- (read only) does the application support image tiling
kOfxImageEffectPropTemporalClipAccess
- (read only) does the application allow random temporal access to source images
kOfxImageEffectPropSupportedComponents
- (read only) a list of supported colour components
kOfxImageEffectPropSupportedContexts
- (read only) a list of supported effect contexts
kOfxImageEffectPropSupportsMultipleClipDepths
- (read only) does the application allow inputs and output clips to have differing bit depths
kOfxImageEffectPropSupportsMultipleClipPARs
- (read only) does the application allow inputs and output clips to have differing pixel aspect ratios
kOfxImageEffectPropSetableFrameRate
- (read only) does the application allow an effect to change the frame rate of the output clip
kOfxImageEffectPropSetableFielding
- (read only) does the application allow an effect to change the fielding of the output clip
kOfxParamHostPropSupportsCustomInteract
- (read only) does the application
kOfxParamHostPropSupportsStringAnimation
- (read only) does the application allow the animation of string parameters
kOfxParamHostPropSupportsChoiceAnimation
- (read only) does the application allow the animation of choice parameters
kOfxParamHostPropSupportsBooleanAnimation
- (read only does the application allow the animation of boolean parameters)
kOfxParamHostPropSupportsCustomAnimation
- (read only) does the application allow the animation of custom parameters
kOfxParamHostPropMaxParameters
- (read only) the maximum number of parameters the application allows a plug-in to have
kOfxParamHostPropMaxPages
- (read only) the maximum number of parameter pages the application allows a plug-in to have
kOfxParamHostPropPageRowColumnCount
- (read only) the number of rows and columns on a page parameter
kOfxPropHostOSHandle
- (read only) a pointer to an OS specific application handle (eg: the root hWnd on Windows)
kOfxParamHostPropSupportsParametricAnimation
- (read only) does the host support animation of parametric parameters
kOfxImageEffectInstancePropSequentialRender
- (read only) does the host support sequential rendering
kOfxImageEffectPropOpenGLRenderSupported
- (read only) does the host support OpenGL accelerated rendering
kOfxImageEffectPropRenderQualityDraft
- (read only) does the host support draft quality rendering
kOfxImageEffectHostPropNativeOrigin
- (read only) native origin of the host