ofxImageEffect.h File Reference

#include "ofxCore.h"
#include "ofxParam.h"
#include "ofxInteract.h"
#include "ofxMessage.h"
#include "ofxMemory.h"
#include "ofxMultiThread.h"

Go to the source code of this file.

Classes

struct OfxImageEffectSuiteV1

The OFX suite for image effects. More...

Defines

#define kOfxImageEffectPluginApi   "OfxImageEffectPluginAPI"

String used to label OFX Image Effect Plug-ins.

#define kOfxImageEffectPluginApiVersion   1

The current version of the Image Effect API.

#define kOfxImageComponentNone   "OfxImageComponentNone"

String to label something with unset components.

#define kOfxImageComponentRGBA   "OfxImageComponentRGBA"

String to label images with RGBA components.

#define kOfxImageComponentAlpha   "OfxImageComponentAlpha"

String to label images with only Alpha components.

#define kOfxImageComponentYUVA   "OfxImageComponentYUVA"

String to label images with YUVA components.

#define kOfxImageEffectContextGenerator   "OfxImageEffectContextGenerator"

Use to define the generator image effect context. See ImageEffectContexts.

#define kOfxImageEffectContextFilter   "OfxImageEffectContextFilter"

Use to define the filter effect image effect context See ImageEffectContexts.

#define kOfxImageEffectContextTransition   "OfxImageEffectContextTransition"

Use to define the transition image effect context See ImageEffectContexts.

#define kOfxImageEffectContextPaint   "OfxImageEffectContextPaint"

Use to define the paint image effect context See ImageEffectContexts.

#define kOfxImageEffectContextGeneral   "OfxImageEffectContextGeneral"

Use to define the general image effect context See ImageEffectContexts.

#define kOfxImageEffectContextRetimer   "OfxImageEffectContextRetimer"

Use to define the retimer effect context See ImageEffectContexts.

#define kOfxTypeImageEffectHost   "OfxTypeImageEffectHost"

Used as a value for kOfxPropType on image effect host handles.

#define kOfxTypeImageEffect   "OfxTypeImageEffect"

Used as a value for kOfxPropType on image effect plugin handles.

#define kOfxTypeImageEffectInstance   "OfxTypeImageEffectInstance"

Used as a value for kOfxPropType on image effect instance handles.

#define kOfxTypeClip   "OfxTypeClip"

Used as a value for kOfxPropType on image effect clips.

#define kOfxTypeImage   "OfxTypeImage"

Used as a value for kOfxPropType on image effect images.

#define kOfxImageEffectActionGetRegionOfDefinition   "OfxImageEffectActionGetRegionOfDefinition"

Action called to get the region of definition of an effect.

#define kOfxImageEffectActionGetRegionsOfInterest   "OfxImageEffectActionGetRegionsOfInterest"

Action called to get the regions of interest of an effect.

#define kOfxImageEffectActionGetTimeDomain   "OfxImageEffectActionGetTimeDomain"

Action called to get the temporal domain of an effect.

#define kOfxImageEffectActionGetFramesNeeded   "OfxImageEffectActionGetFramesNeeded"

Action called to get the frame ranged needed on an input clip to render a single frame.

#define kOfxImageEffectActionGetClipPreferences   "OfxImageEffectActionGetClipPreferences"

Action called to have a plug-in define input an output clip preferences.

#define kOfxImageEffectActionIsIdentity   "OfxImageEffectActionIsIdentity"

Action called to have a plug-in say if it is an identity transform.

#define kOfxImageEffectActionRender   "OfxImageEffectActionRender"

Action to render an image.

#define kOfxImageEffectActionBeginSequenceRender   "OfxImageEffectActionBeginSequenceRender"

Action indicating a series of render calls are about to happen.

#define kOfxImageEffectActionEndSequenceRender   "OfxImageEffectActionEndSequenceRender"

Action to render a series of render calls have completed.

#define kOfxImageEffectActionDescribeInContext   "OfxImageEffectActionDescribeInContext"

Action to describe an image effect in a specific context.

#define kOfxImageEffectPropSupportedContexts   "OfxImageEffectPropSupportedContexts"

Indicates to the host the contexts a plugin can be used in.

#define kOfxImageEffectPropPluginHandle   "OfxImageEffectPropPluginHandle"

The plugin handle passed to the initial 'describe' action.

#define kOfxImageEffectHostPropIsBackground   "OfxImageEffectHostPropIsBackground"

Indicates if a host is a background render.

#define kOfxImageEffectPluginPropSingleInstance   "OfxImageEffectPluginPropSingleInstance"

Indicates whether only one instance of a plugin can exist at the same time.

#define kOfxImageEffectPluginRenderThreadSafety   "OfxImageEffectPluginRenderThreadSafety"

Indicates how many simultaneous renders the plugin can deal with.

#define kOfxImageEffectRenderUnsafe   "OfxImageEffectRenderUnsafe"

String used to label render threads as un thread safe, see, kOfxImageEffectPluginRenderThreadSafety.

#define kOfxImageEffectRenderInstanceSafe   "OfxImageEffectRenderInstanceSafe"

String used to label render threads as instance thread safe, kOfxImageEffectPluginRenderThreadSafety.

#define kOfxImageEffectRenderFullySafe   "OfxImageEffectRenderFullySafe"

String used to label render threads as fully thread safe, kOfxImageEffectPluginRenderThreadSafety.

#define kOfxImageEffectPluginPropHostFrameThreading   "OfxImageEffectPluginPropHostFrameThreading"

Indicates whether a plugin lets the host perform per frame SMP threading.

#define kOfxImageEffectPropSupportsMultipleClipDepths   "OfxImageEffectPropMultipleClipDepths"

Indicates whether a host or plugin can support clips of differing component depths going into/out of an effect.

#define kOfxImageEffectPropSupportsMultipleClipPARs   "OfxImageEffectPropSupportsMultipleClipPARs"

Indicates whether a host or plugin can support clips of differing pixel aspect ratios going into/out of an effect.

#define kOfxImageEffectPropClipPreferencesSlaveParam   "OfxImageEffectPropClipPreferencesSlaveParam"

Indicates the set of parameters on which a value change will trigger a change to clip preferences.

#define kOfxImageEffectPropSetableFrameRate   "OfxImageEffectPropSetableFrameRate"

Indicates whether the host will let a plugin set the frame rate of the output clip.

#define kOfxImageEffectPropSetableFielding   "OfxImageEffectPropSetableFielding"

Indicates whether the host will let a plugin set the fielding of the output clip.

#define kOfxImageEffectInstancePropSequentialRender   "OfxImageEffectInstancePropSequentialRender"

Says whether an effect needs to be rendered sequentially or not.

#define kOfxImageEffectPluginPropGrouping   "OfxImageEffectPluginPropGrouping"

Indicates the effect group for this plugin.

#define kOfxImageEffectPropSupportsOverlays   "OfxImageEffectPropSupportsOverlays"

Indicates whether a host support image effect ImageEffectOverlays.

#define kOfxImageEffectPluginPropOverlayInteractV1   "OfxImageEffectPluginPropOverlayInteractV1"

Sets the entry for an effect's overlay interaction.

#define kOfxImageEffectPropSupportsMultiResolution   "OfxImageEffectPropSupportsMultiResolution"

Indicates whether a plugin or host support multiple resolution images.

#define kOfxImageEffectPropSupportsTiles   "OfxImageEffectPropSupportsTiles"

Indicates whether a clip, plugin or host supports tiled images.

#define kOfxImageEffectPropInAnalysis   "OfxImageEffectPropInAnalysis"

Indicates whether an effect is performing an analysis pass.

#define kOfxImageEffectPropTemporalClipAccess   "OfxImageEffectPropTemporalClipAccess"

Indicates support for random temporal access to images in a clip.

#define kOfxImageEffectPropContext   "OfxImageEffectPropContext"

Indicates the context a plugin instance has been created for.

#define kOfxImageEffectPropPixelDepth   "OfxImageEffectPropPixelDepth"

Indicates the type of each component in a clip or image (after any mapping).

#define kOfxImageEffectPropComponents   "OfxImageEffectPropComponents"

Indicates the current component type in a clip or image (after any mapping).

#define kOfxImagePropUniqueIdentifier   "OfxImagePropUniqueIdentifier"

Uniquely labels an image.

#define kOfxImageClipPropContinuousSamples   "OfxImageClipPropContinuousSamples"

Clip and action argument property which indicates that the clip can be sampled continously.

#define kOfxImageClipPropUnmappedPixelDepth   "OfxImageClipPropUnmappedPixelDepth"

Indicates the type of each component in a clip before any mapping by clip preferences.

#define kOfxImageClipPropUnmappedComponents   "OfxImageClipPropUnmappedComponents"

Indicates the current 'raw' component type on a clip before any mapping by clip preferences.

#define kOfxImageEffectPropPreMultiplication   "OfxImageEffectPropPreMultiplication"

Indicates the premultiplication state of a clip or image.

#define kOfxImageOpaque   "OfxImageOpaque"

#define kOfxImagePreMultiplied   "OfxImageAlphaPremultiplied"

#define kOfxImageUnPreMultiplied   "OfxImageAlphaUnPremultiplied"

#define kOfxImageEffectPropSupportedPixelDepths   "OfxImageEffectPropSupportedPixelDepths"

Indicates the bit depths support by a plug-in or host.

#define kOfxImageEffectPropSupportedComponents   "OfxImageEffectPropSupportedComponents"

Indicates the components supported by a clip or host,.

#define kOfxImageClipPropOptional   "OfxImageClipPropOptional"

Indicates if a clip is optional.

#define kOfxImageClipPropIsMask   "OfxImageClipPropIsMask"

Indicates that a clip is intended to be used as a mask input.

#define kOfxImagePropPixelAspectRatio   "OfxImagePropPixelAspectRatio"

The pixel aspect ratio of a clip or image.

#define kOfxImageEffectPropFrameRate   "OfxImageEffectPropFrameRate"

The frame rate of a clip or instance's project.

#define kOfxImageEffectPropUnmappedFrameRate   "OfxImageEffectPropUnmappedFrameRate"

Indicates the original unmapped frame rate (frames/second) of a clip.

#define kOfxImageEffectPropFrameStep   "OfxImageEffectPropFrameStep"

The frame step used for a sequence of renders.

#define kOfxImageEffectPropFrameRange   "OfxImageEffectPropFrameRange"

The frame range over which a clip has images.

#define kOfxImageEffectPropUnmappedFrameRange   "OfxImageEffectPropUnmappedFrameRange"

The unmaped frame range over which an output clip has images.

#define kOfxImageClipPropConnected   "OfxImageClipPropConnected"

Says whether the clip is actually connected at the moment.

#define kOfxImageEffectFrameVarying   "OfxImageEffectFrameVarying"

Indicates whether an effect will generate different images from frame to frame.

#define kOfxImageEffectPropRenderScale   "OfxImageEffectPropRenderScale"

The proxy render scale currently being applied.

#define kOfxImageEffectPropProjectExtent   "OfxImageEffectPropProjectExtent"

The extent of the current project in canonical coordinates.

#define kOfxImageEffectPropProjectSize   "OfxImageEffectPropProjectSize"

The size of the current project in canonical coordinates.

#define kOfxImageEffectPropProjectOffset   "OfxImageEffectPropProjectOffset"

The offset of the current project in canonical coordinates.

#define kOfxImageEffectPropProjectPixelAspectRatio   "OfxImageEffectPropPixelAspectRatio"

The pixel aspect ratio of the current project.

#define kOfxImageEffectInstancePropEffectDuration   "OfxImageEffectInstancePropEffectDuration"

The duration of the effect.

#define kOfxImageClipPropFieldOrder   "OfxImageClipPropFieldOrder"

Which spatial field occurs temporally first in a frame.

#define kOfxImagePropData   "OfxImagePropData"

The pixel data pointer of an image.

#define kOfxImagePropBounds   "OfxImagePropBounds"

The bounds of an image's pixels.

#define kOfxImagePropRegionOfDefinition   "OfxImagePropRegionOfDefinition"

The full region of definition of an image.

#define kOfxImagePropRowBytes   "OfxImagePropRowBytes"

The number of bytes in a row of an image.

#define kOfxImagePropField   "OfxImagePropField"

Which fields are present in the image.

#define kOfxImageEffectPluginPropFieldRenderTwiceAlways   "OfxImageEffectPluginPropFieldRenderTwiceAlways"

Controls how a plugin renders fielded footage.

#define kOfxImageClipPropFieldExtraction   "OfxImageClipPropFieldExtraction"

Controls how a plugin fetched fielded imagery from a clip.

#define kOfxImageEffectPropFieldToRender   "OfxImageEffectPropFieldToRender"

Indicates which field is being rendered.

#define kOfxImageEffectPropRegionOfDefinition   "OfxImageEffectPropRegionOfDefinition"

Used to indicate the region of definition of a plug-in.

#define kOfxImageEffectPropRegionOfInterest   "OfxImageEffectPropRegionOfInterest"

The value of a region of interest.

#define kOfxImageEffectPropRenderWindow   "OfxImageEffectPropRenderWindow"

The region to be rendered.

#define kOfxImageFieldNone   "OfxFieldNone"

#define kOfxImageFieldLower   "OfxFieldLower"

#define kOfxImageFieldUpper   "OfxFieldUpper"

#define kOfxImageFieldBoth   "OfxFieldBoth"

#define kOfxImageFieldSingle   "OfxFieldSingle"

#define kOfxImageFieldDoubled   "OfxFieldDoubled"

#define kOfxImageEffectOutputClipName   "Output"

String that is the name of the standard OFX output clip.

#define kOfxImageEffectSimpleSourceClipName   "Source"

String that is the name of the standard OFX single source input clip.

#define kOfxImageEffectTransitionSourceFromClipName   "SourceFrom"

String that is the name of the 'from' clip in the OFX transition context.

#define kOfxImageEffectTransitionSourceToClipName   "SourceTo"

String that is the name of the 'from' clip in the OFX transition context.

#define kOfxImageEffectRetimerParamName   "SourceTime"

the name of the mandated 'SourceTime' param for the retime context

#define kOfxImageEffectSuite   "OfxImageEffectSuite"

the string that names image effect suites, passed to OfxHost::fetchSuite

#define kOfxStatErrImageFormat   ((int) 1000)

Error code for incorrect image formats.

Typedefs

typedef OfxImageEffectStruct * OfxImageEffectHandle

Blind declaration of an OFX image effect.

typedef OfxImageClipStruct * OfxImageClipHandle

Blind declaration of an OFX image effect.

typedef OfxImageMemoryStruct * OfxImageMemoryHandle

Blind declaration for an handle to image memory returned by the image memory management routines.

typedef OfxImageEffectSuiteV1 OfxImageEffectSuiteV1

The OFX suite for image effects.

Define Documentation

#define kOfxImageComponentAlpha "OfxImageComponentAlpha"

String to label images with only Alpha components.

#define kOfxImageComponentNone "OfxImageComponentNone"

String to label something with unset components.

#define kOfxImageComponentRGBA "OfxImageComponentRGBA"

String to label images with RGBA components.

#define kOfxImageComponentYUVA "OfxImageComponentYUVA"

String to label images with YUVA components.

#define kOfxImageEffectContextFilter "OfxImageEffectContextFilter"

Use to define the filter effect image effect context See ImageEffectContexts.

#define kOfxImageEffectContextGeneral "OfxImageEffectContextGeneral"

Use to define the general image effect context See ImageEffectContexts.

#define kOfxImageEffectContextGenerator "OfxImageEffectContextGenerator"

Use to define the generator image effect context. See ImageEffectContexts.

#define kOfxImageEffectContextPaint "OfxImageEffectContextPaint"

Use to define the paint image effect context See ImageEffectContexts.

#define kOfxImageEffectContextRetimer "OfxImageEffectContextRetimer"

Use to define the retimer effect context See ImageEffectContexts.

#define kOfxImageEffectContextTransition "OfxImageEffectContextTransition"

Use to define the transition image effect context See ImageEffectContexts.

#define kOfxImageEffectOutputClipName "Output"

String that is the name of the standard OFX output clip.

#define kOfxImageEffectPluginApi "OfxImageEffectPluginAPI"

String used to label OFX Image Effect Plug-ins.
Set the pluginApi member of the OfxPluginHeader inside any OfxImageEffectPluginStruct to be this so that the host knows the plugin is an image effect.

#define kOfxImageEffectPluginApiVersion 1

The current version of the Image Effect API.

#define kOfxImageEffectRetimerParamName "SourceTime"

the name of the mandated 'SourceTime' param for the retime context

#define kOfxImageEffectSimpleSourceClipName "Source"

String that is the name of the standard OFX single source input clip.

#define kOfxImageEffectSuite "OfxImageEffectSuite"

the string that names image effect suites, passed to OfxHost::fetchSuite

#define kOfxImageEffectTransitionSourceFromClipName "SourceFrom"

String that is the name of the 'from' clip in the OFX transition context.

#define kOfxImageEffectTransitionSourceToClipName "SourceTo"

String that is the name of the 'from' clip in the OFX transition context.

#define kOfxTypeClip "OfxTypeClip"

Used as a value for kOfxPropType on image effect clips.

#define kOfxTypeImage "OfxTypeImage"

Used as a value for kOfxPropType on image effect images.

#define kOfxTypeImageEffect "OfxTypeImageEffect"

Used as a value for kOfxPropType on image effect plugin handles.

#define kOfxTypeImageEffectHost "OfxTypeImageEffectHost"

Used as a value for kOfxPropType on image effect host handles.

#define kOfxTypeImageEffectInstance "OfxTypeImageEffectInstance"

Used as a value for kOfxPropType on image effect instance handles.

Typedef Documentation

typedef struct OfxImageClipStruct* OfxImageClipHandle

Blind declaration of an OFX image effect.

typedef struct OfxImageEffectStruct* OfxImageEffectHandle

Blind declaration of an OFX image effect.

typedef struct OfxImageEffectSuiteV1 OfxImageEffectSuiteV1

The OFX suite for image effects.
This suite provides the functions needed by a plugin to defined and use an image effect plugin.

typedef struct OfxImageMemoryStruct* OfxImageMemoryHandle

Blind declaration for an handle to image memory returned by the image memory management routines.

Redistributions of the document must retain the above copyright notice and this list of conditions.
Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.


Classes
struct	OfxImageEffectSuiteV1
	The OFX suite for image effects. More...
Defines
#define	kOfxImageEffectPluginApi "OfxImageEffectPluginAPI"
	String used to label OFX Image Effect Plug-ins.
#define	kOfxImageEffectPluginApiVersion 1
	The current version of the Image Effect API.
#define	kOfxImageComponentNone "OfxImageComponentNone"
	String to label something with unset components.
#define	kOfxImageComponentRGBA "OfxImageComponentRGBA"
	String to label images with RGBA components.
#define	kOfxImageComponentAlpha "OfxImageComponentAlpha"
	String to label images with only Alpha components.
#define	kOfxImageComponentYUVA "OfxImageComponentYUVA"
	String to label images with YUVA components.
#define	kOfxImageEffectContextGenerator "OfxImageEffectContextGenerator"
	Use to define the generator image effect context. See ImageEffectContexts.
#define	kOfxImageEffectContextFilter "OfxImageEffectContextFilter"
	Use to define the filter effect image effect context See ImageEffectContexts.
#define	kOfxImageEffectContextTransition "OfxImageEffectContextTransition"
	Use to define the transition image effect context See ImageEffectContexts.
#define	kOfxImageEffectContextPaint "OfxImageEffectContextPaint"
	Use to define the paint image effect context See ImageEffectContexts.
#define	kOfxImageEffectContextGeneral "OfxImageEffectContextGeneral"
	Use to define the general image effect context See ImageEffectContexts.
#define	kOfxImageEffectContextRetimer "OfxImageEffectContextRetimer"
	Use to define the retimer effect context See ImageEffectContexts.
#define	kOfxTypeImageEffectHost "OfxTypeImageEffectHost"
	Used as a value for kOfxPropType on image effect host handles.
#define	kOfxTypeImageEffect "OfxTypeImageEffect"
	Used as a value for kOfxPropType on image effect plugin handles.
#define	kOfxTypeImageEffectInstance "OfxTypeImageEffectInstance"
	Used as a value for kOfxPropType on image effect instance handles.
#define	kOfxTypeClip "OfxTypeClip"
	Used as a value for kOfxPropType on image effect clips.
#define	kOfxTypeImage "OfxTypeImage"
	Used as a value for kOfxPropType on image effect images.
#define	kOfxImageEffectActionGetRegionOfDefinition "OfxImageEffectActionGetRegionOfDefinition"
	Action called to get the region of definition of an effect.
#define	kOfxImageEffectActionGetRegionsOfInterest "OfxImageEffectActionGetRegionsOfInterest"
	Action called to get the regions of interest of an effect.
#define	kOfxImageEffectActionGetTimeDomain "OfxImageEffectActionGetTimeDomain"
	Action called to get the temporal domain of an effect.
#define	kOfxImageEffectActionGetFramesNeeded "OfxImageEffectActionGetFramesNeeded"
	Action called to get the frame ranged needed on an input clip to render a single frame.
#define	kOfxImageEffectActionGetClipPreferences "OfxImageEffectActionGetClipPreferences"
	Action called to have a plug-in define input an output clip preferences.
#define	kOfxImageEffectActionIsIdentity "OfxImageEffectActionIsIdentity"
	Action called to have a plug-in say if it is an identity transform.
#define	kOfxImageEffectActionRender "OfxImageEffectActionRender"
	Action to render an image.
#define	kOfxImageEffectActionBeginSequenceRender "OfxImageEffectActionBeginSequenceRender"
	Action indicating a series of render calls are about to happen.
#define	kOfxImageEffectActionEndSequenceRender "OfxImageEffectActionEndSequenceRender"
	Action to render a series of render calls have completed.
#define	kOfxImageEffectActionDescribeInContext "OfxImageEffectActionDescribeInContext"
	Action to describe an image effect in a specific context.
#define	kOfxImageEffectPropSupportedContexts "OfxImageEffectPropSupportedContexts"
	Indicates to the host the contexts a plugin can be used in.
#define	kOfxImageEffectPropPluginHandle "OfxImageEffectPropPluginHandle"
	The plugin handle passed to the initial 'describe' action.
#define	kOfxImageEffectHostPropIsBackground "OfxImageEffectHostPropIsBackground"
	Indicates if a host is a background render.
#define	kOfxImageEffectPluginPropSingleInstance "OfxImageEffectPluginPropSingleInstance"
	Indicates whether only one instance of a plugin can exist at the same time.
#define	kOfxImageEffectPluginRenderThreadSafety "OfxImageEffectPluginRenderThreadSafety"
	Indicates how many simultaneous renders the plugin can deal with.
#define	kOfxImageEffectRenderUnsafe "OfxImageEffectRenderUnsafe"
	String used to label render threads as un thread safe, see, kOfxImageEffectPluginRenderThreadSafety.
#define	kOfxImageEffectRenderInstanceSafe "OfxImageEffectRenderInstanceSafe"
	String used to label render threads as instance thread safe, kOfxImageEffectPluginRenderThreadSafety.
#define	kOfxImageEffectRenderFullySafe "OfxImageEffectRenderFullySafe"
	String used to label render threads as fully thread safe, kOfxImageEffectPluginRenderThreadSafety.
#define	kOfxImageEffectPluginPropHostFrameThreading "OfxImageEffectPluginPropHostFrameThreading"
	Indicates whether a plugin lets the host perform per frame SMP threading.
#define	kOfxImageEffectPropSupportsMultipleClipDepths "OfxImageEffectPropMultipleClipDepths"
	Indicates whether a host or plugin can support clips of differing component depths going into/out of an effect.
#define	kOfxImageEffectPropSupportsMultipleClipPARs "OfxImageEffectPropSupportsMultipleClipPARs"
	Indicates whether a host or plugin can support clips of differing pixel aspect ratios going into/out of an effect.
#define	kOfxImageEffectPropClipPreferencesSlaveParam "OfxImageEffectPropClipPreferencesSlaveParam"
	Indicates the set of parameters on which a value change will trigger a change to clip preferences.
#define	kOfxImageEffectPropSetableFrameRate "OfxImageEffectPropSetableFrameRate"
	Indicates whether the host will let a plugin set the frame rate of the output clip.
#define	kOfxImageEffectPropSetableFielding "OfxImageEffectPropSetableFielding"
	Indicates whether the host will let a plugin set the fielding of the output clip.
#define	kOfxImageEffectInstancePropSequentialRender "OfxImageEffectInstancePropSequentialRender"
	Says whether an effect needs to be rendered sequentially or not.
#define	kOfxImageEffectPluginPropGrouping "OfxImageEffectPluginPropGrouping"
	Indicates the effect group for this plugin.
#define	kOfxImageEffectPropSupportsOverlays "OfxImageEffectPropSupportsOverlays"
	Indicates whether a host support image effect ImageEffectOverlays.
#define	kOfxImageEffectPluginPropOverlayInteractV1 "OfxImageEffectPluginPropOverlayInteractV1"
	Sets the entry for an effect's overlay interaction.
#define	kOfxImageEffectPropSupportsMultiResolution "OfxImageEffectPropSupportsMultiResolution"
	Indicates whether a plugin or host support multiple resolution images.
#define	kOfxImageEffectPropSupportsTiles "OfxImageEffectPropSupportsTiles"
	Indicates whether a clip, plugin or host supports tiled images.
#define	kOfxImageEffectPropInAnalysis "OfxImageEffectPropInAnalysis"
	Indicates whether an effect is performing an analysis pass.
#define	kOfxImageEffectPropTemporalClipAccess "OfxImageEffectPropTemporalClipAccess"
	Indicates support for random temporal access to images in a clip.
#define	kOfxImageEffectPropContext "OfxImageEffectPropContext"
	Indicates the context a plugin instance has been created for.
#define	kOfxImageEffectPropPixelDepth "OfxImageEffectPropPixelDepth"
	Indicates the type of each component in a clip or image (after any mapping).
#define	kOfxImageEffectPropComponents "OfxImageEffectPropComponents"
	Indicates the current component type in a clip or image (after any mapping).
#define	kOfxImagePropUniqueIdentifier "OfxImagePropUniqueIdentifier"
	Uniquely labels an image.
#define	kOfxImageClipPropContinuousSamples "OfxImageClipPropContinuousSamples"
	Clip and action argument property which indicates that the clip can be sampled continously.
#define	kOfxImageClipPropUnmappedPixelDepth "OfxImageClipPropUnmappedPixelDepth"
	Indicates the type of each component in a clip before any mapping by clip preferences.
#define	kOfxImageClipPropUnmappedComponents "OfxImageClipPropUnmappedComponents"
	Indicates the current 'raw' component type on a clip before any mapping by clip preferences.
#define	kOfxImageEffectPropPreMultiplication "OfxImageEffectPropPreMultiplication"
	Indicates the premultiplication state of a clip or image.
#define	kOfxImageOpaque "OfxImageOpaque"
#define	kOfxImagePreMultiplied "OfxImageAlphaPremultiplied"
#define	kOfxImageUnPreMultiplied "OfxImageAlphaUnPremultiplied"
#define	kOfxImageEffectPropSupportedPixelDepths "OfxImageEffectPropSupportedPixelDepths"
	Indicates the bit depths support by a plug-in or host.
#define	kOfxImageEffectPropSupportedComponents "OfxImageEffectPropSupportedComponents"
	Indicates the components supported by a clip or host,.
#define	kOfxImageClipPropOptional "OfxImageClipPropOptional"
	Indicates if a clip is optional.
#define	kOfxImageClipPropIsMask "OfxImageClipPropIsMask"
	Indicates that a clip is intended to be used as a mask input.
#define	kOfxImagePropPixelAspectRatio "OfxImagePropPixelAspectRatio"
	The pixel aspect ratio of a clip or image.
#define	kOfxImageEffectPropFrameRate "OfxImageEffectPropFrameRate"
	The frame rate of a clip or instance's project.
#define	kOfxImageEffectPropUnmappedFrameRate "OfxImageEffectPropUnmappedFrameRate"
	Indicates the original unmapped frame rate (frames/second) of a clip.
#define	kOfxImageEffectPropFrameStep "OfxImageEffectPropFrameStep"
	The frame step used for a sequence of renders.
#define	kOfxImageEffectPropFrameRange "OfxImageEffectPropFrameRange"
	The frame range over which a clip has images.
#define	kOfxImageEffectPropUnmappedFrameRange "OfxImageEffectPropUnmappedFrameRange"
	The unmaped frame range over which an output clip has images.
#define	kOfxImageClipPropConnected "OfxImageClipPropConnected"
	Says whether the clip is actually connected at the moment.
#define	kOfxImageEffectFrameVarying "OfxImageEffectFrameVarying"
	Indicates whether an effect will generate different images from frame to frame.
#define	kOfxImageEffectPropRenderScale "OfxImageEffectPropRenderScale"
	The proxy render scale currently being applied.
#define	kOfxImageEffectPropProjectExtent "OfxImageEffectPropProjectExtent"
	The extent of the current project in canonical coordinates.
#define	kOfxImageEffectPropProjectSize "OfxImageEffectPropProjectSize"
	The size of the current project in canonical coordinates.
#define	kOfxImageEffectPropProjectOffset "OfxImageEffectPropProjectOffset"
	The offset of the current project in canonical coordinates.
#define	kOfxImageEffectPropProjectPixelAspectRatio "OfxImageEffectPropPixelAspectRatio"
	The pixel aspect ratio of the current project.
#define	kOfxImageEffectInstancePropEffectDuration "OfxImageEffectInstancePropEffectDuration"
	The duration of the effect.
#define	kOfxImageClipPropFieldOrder "OfxImageClipPropFieldOrder"
	Which spatial field occurs temporally first in a frame.
#define	kOfxImagePropData "OfxImagePropData"
	The pixel data pointer of an image.
#define	kOfxImagePropBounds "OfxImagePropBounds"
	The bounds of an image's pixels.
#define	kOfxImagePropRegionOfDefinition "OfxImagePropRegionOfDefinition"
	The full region of definition of an image.
#define	kOfxImagePropRowBytes "OfxImagePropRowBytes"
	The number of bytes in a row of an image.
#define	kOfxImagePropField "OfxImagePropField"
	Which fields are present in the image.
#define	kOfxImageEffectPluginPropFieldRenderTwiceAlways "OfxImageEffectPluginPropFieldRenderTwiceAlways"
	Controls how a plugin renders fielded footage.
#define	kOfxImageClipPropFieldExtraction "OfxImageClipPropFieldExtraction"
	Controls how a plugin fetched fielded imagery from a clip.
#define	kOfxImageEffectPropFieldToRender "OfxImageEffectPropFieldToRender"
	Indicates which field is being rendered.
#define	kOfxImageEffectPropRegionOfDefinition "OfxImageEffectPropRegionOfDefinition"
	Used to indicate the region of definition of a plug-in.
#define	kOfxImageEffectPropRegionOfInterest "OfxImageEffectPropRegionOfInterest"
	The value of a region of interest.
#define	kOfxImageEffectPropRenderWindow "OfxImageEffectPropRenderWindow"
	The region to be rendered.
#define	kOfxImageFieldNone "OfxFieldNone"
#define	kOfxImageFieldLower "OfxFieldLower"
#define	kOfxImageFieldUpper "OfxFieldUpper"
#define	kOfxImageFieldBoth "OfxFieldBoth"
#define	kOfxImageFieldSingle "OfxFieldSingle"
#define	kOfxImageFieldDoubled "OfxFieldDoubled"
#define	kOfxImageEffectOutputClipName "Output"
	String that is the name of the standard OFX output clip.
#define	kOfxImageEffectSimpleSourceClipName "Source"
	String that is the name of the standard OFX single source input clip.
#define	kOfxImageEffectTransitionSourceFromClipName "SourceFrom"
	String that is the name of the 'from' clip in the OFX transition context.
#define	kOfxImageEffectTransitionSourceToClipName "SourceTo"
	String that is the name of the 'from' clip in the OFX transition context.
#define	kOfxImageEffectRetimerParamName "SourceTime"
	the name of the mandated 'SourceTime' param for the retime context
#define	kOfxImageEffectSuite "OfxImageEffectSuite"
	the string that names image effect suites, passed to OfxHost::fetchSuite
#define	kOfxStatErrImageFormat ((int) 1000)
	Error code for incorrect image formats.
Typedefs
typedef OfxImageEffectStruct *	OfxImageEffectHandle
	Blind declaration of an OFX image effect.
typedef OfxImageClipStruct *	OfxImageClipHandle
	Blind declaration of an OFX image effect.
typedef OfxImageMemoryStruct *	OfxImageMemoryHandle
	Blind declaration for an handle to image memory returned by the image memory management routines.
typedef OfxImageEffectSuiteV1	OfxImageEffectSuiteV1
	The OFX suite for image effects.