TuttleOFX
1
|
The OFX suite for image effects. More...
#include <ofxImageEffect.h>
Data Fields | |
OfxStatus(* | getPropertySet )(OfxImageEffectHandle imageEffect, OfxPropertySetHandle *propHandle) |
Retrieves the property set for the given image effect. | |
OfxStatus(* | getParamSet )(OfxImageEffectHandle imageEffect, OfxParamSetHandle *paramSet) |
Retrieves the parameter set for the given image effect. | |
OfxStatus(* | clipDefine )(OfxImageEffectHandle imageEffect, const char *name, OfxPropertySetHandle *propertySet) |
Define a clip to the effect. | |
OfxStatus(* | clipGetHandle )(OfxImageEffectHandle imageEffect, const char *name, OfxImageClipHandle *clip, OfxPropertySetHandle *propertySet) |
Get the propery handle of the named input clip in the given instance. | |
OfxStatus(* | clipGetPropertySet )(OfxImageClipHandle clip, OfxPropertySetHandle *propHandle) |
Retrieves the property set for a given clip. | |
OfxStatus(* | clipGetImage )(OfxImageClipHandle clip, OfxTime time, OfxRectD *region, OfxPropertySetHandle *imageHandle) |
Get a handle for an image in a clip at the indicated time and indicated region. | |
OfxStatus(* | clipReleaseImage )(OfxPropertySetHandle imageHandle) |
Releases the image handle previously returned by clipGetImage. | |
OfxStatus(* | clipGetRegionOfDefinition )(OfxImageClipHandle clip, OfxTime time, OfxRectD *bounds) |
Returns the spatial region of definition of the clip at the given time. | |
int(* | abort )(OfxImageEffectHandle imageEffect) |
Returns whether to abort processing or not. | |
OfxStatus(* | imageMemoryAlloc )(OfxImageEffectHandle instanceHandle, size_t nBytes, OfxImageMemoryHandle *memoryHandle) |
Allocate memory from the host's image memory pool. | |
OfxStatus(* | imageMemoryFree )(OfxImageMemoryHandle memoryHandle) |
Frees a memory handle and associated memory. | |
OfxStatus(* | imageMemoryLock )(OfxImageMemoryHandle memoryHandle, void **returnedPtr) |
Lock the memory associated with a memory handle and make it available for use. | |
OfxStatus(* | imageMemoryUnlock )(OfxImageMemoryHandle memoryHandle) |
Unlock allocated image data. |
The OFX suite for image effects.
This suite provides the functions needed by a plugin to defined and use an image effect plugin.
Definition at line 1005 of file ofxImageEffect.h.
int( * OfxImageEffectSuiteV1::abort)(OfxImageEffectHandle imageEffect) |
Returns whether to abort processing or not.
A host may want to signal to a plugin that it should stop whatever rendering it is doing and start again. Generally this is done in interactive threads in response to users tweaking some parameter.
This function indicates whether a plugin should stop whatever processing it is doing.
Definition at line 1194 of file ofxImageEffect.h.
Referenced by OFX::ImageEffect::abort().
OfxStatus( * OfxImageEffectSuiteV1::clipDefine)(OfxImageEffectHandle imageEffect, const char *name, OfxPropertySetHandle *propertySet) |
Define a clip to the effect.
This function defines a clip to a host, the returned property set is used to describe various aspects of the clip to the host. Note that this does not create a clip instance.
Definition at line 1052 of file ofxImageEffect.h.
Referenced by OFX::ImageEffectDescriptor::defineClip().
OfxStatus( * OfxImageEffectSuiteV1::clipGetHandle)(OfxImageEffectHandle imageEffect, const char *name, OfxImageClipHandle *clip, OfxPropertySetHandle *propertySet) |
Get the propery handle of the named input clip in the given instance.
The propertySet will have the same value as would be returned by OfxImageEffectSuiteV1::clipGetPropertySet
This return a clip handle for the given instance, note that this will not be the same as the clip handle returned by clipDefine and will be distanct to clip handles in any other instance of the plugin.
Not a valid call in any of the describe actions.
Definition at line 1080 of file ofxImageEffect.h.
Referenced by OFX::ImageEffect::fetchClip().
OfxStatus( * OfxImageEffectSuiteV1::clipGetImage)(OfxImageClipHandle clip, OfxTime time, OfxRectD *region, OfxPropertySetHandle *imageHandle) |
Get a handle for an image in a clip at the indicated time and indicated region.
An image is fetched from a clip at the indicated time for the given region and returned in the imageHandle.
If the region parameter is not set to NULL, then it will be clipped to the clip's Region of Definition for the given time. The returned image will be at least as big as this region. If the region parameter is not set, then the region fetched will be at least the Region of Interest the effect has previously specified, clipped the clip's Region of Definition.
If clipGetImage is called twice with the same parameters, then two separate image handles will be returned, each of which must be release. The underlying implementation could share image data pointers and use reference counting to maintain them.
Definition at line 1129 of file ofxImageEffect.h.
Referenced by OFX::Clip::fetchImage().
OfxStatus( * OfxImageEffectSuiteV1::clipGetPropertySet)(OfxImageClipHandle clip, OfxPropertySetHandle *propHandle) |
Retrieves the property set for a given clip.
The property handle is valid for the lifetime of the clip, which is generally the lifetime of the instance.
Definition at line 1097 of file ofxImageEffect.h.
OfxStatus( * OfxImageEffectSuiteV1::clipGetRegionOfDefinition)(OfxImageClipHandle clip, OfxTime time, OfxRectD *bounds) |
Returns the spatial region of definition of the clip at the given time.
An image is fetched from a clip at the indicated time for the given region and returned in the imageHandle.
If the region parameter is not set to NULL, then it will be clipped to the clip's Region of Definition for the given time. The returned image will be at least as big as this region. If the region parameter is not set, then the region fetched will be at least the Region of Interest the effect has previously specified, clipped the clip's Region of Definition.
Definition at line 1177 of file ofxImageEffect.h.
Referenced by OFX::Clip::getCanonicalRod().
OfxStatus( * OfxImageEffectSuiteV1::clipReleaseImage)(OfxPropertySetHandle imageHandle) |
Releases the image handle previously returned by clipGetImage.
Definition at line 1147 of file ofxImageEffect.h.
Referenced by OFX::Image::~Image().
OfxStatus( * OfxImageEffectSuiteV1::getParamSet)(OfxImageEffectHandle imageEffect, OfxParamSetHandle *paramSet) |
Retrieves the parameter set for the given image effect.
The param set handle is valid for the lifetime of the image effect handle.
Definition at line 1034 of file ofxImageEffect.h.
Referenced by OFX::ImageEffect::ImageEffect(), and OFX::ImageEffectDescriptor::ImageEffectDescriptor().
OfxStatus( * OfxImageEffectSuiteV1::getPropertySet)(OfxImageEffectHandle imageEffect, OfxPropertySetHandle *propHandle) |
Retrieves the property set for the given image effect.
The property handle is for the duration of the image effect handle.
Definition at line 1019 of file ofxImageEffect.h.
Referenced by OFX::Private::fetchEffectProps(), OFX::ImageEffectDescriptor::ImageEffectDescriptor(), and OFX::Private::retrieveImageEffectPointer().
OfxStatus( * OfxImageEffectSuiteV1::imageMemoryAlloc)(OfxImageEffectHandle instanceHandle, size_t nBytes, OfxImageMemoryHandle *memoryHandle) |
Allocate memory from the host's image memory pool.
Memory handles allocated by this should be freed by OfxImageEffectSuiteV1::imageMemoryFree. To access the memory behind the handle you need to call OfxImageEffectSuiteV1::imageMemoryLock.
See ImageEffectsMemoryAllocation.
Definition at line 1212 of file ofxImageEffect.h.
Referenced by OFX::ImageMemory::alloc().
OfxStatus( * OfxImageEffectSuiteV1::imageMemoryFree)(OfxImageMemoryHandle memoryHandle) |
Frees a memory handle and associated memory.
This function frees a memory handle and associated memory that was previously allocated via OfxImageEffectSuiteV1::imageMemoryAlloc
If there are outstanding locks, these are ignored and the handle and memory are freed anyway.
See ImageEffectsMemoryAllocation.
Definition at line 1230 of file ofxImageEffect.h.
Referenced by OFX::ImageMemory::~ImageMemory().
OfxStatus( * OfxImageEffectSuiteV1::imageMemoryLock)(OfxImageMemoryHandle memoryHandle, void **returnedPtr) |
Lock the memory associated with a memory handle and make it available for use.
This function locks them memory associated with a memory handle and returns a pointer to it. The memory will be 16 byte aligned, to allow use of vector operations.
Note that memory locks and unlocks nest.
After the first lock call, the contents of the memory pointer to by returnedPtr is undefined. All subsequent calls to lock will return memory with the same contents as the previous call.
Also, if unlocked, then relocked, the memory associated with a memory handle may be at a different address.
See also OfxImageEffectSuiteV1::imageMemoryUnlock and ImageEffectsMemoryAllocation.
Definition at line 1252 of file ofxImageEffect.h.
Referenced by OFX::ImageMemory::lock().
OfxStatus( * OfxImageEffectSuiteV1::imageMemoryUnlock)(OfxImageMemoryHandle memoryHandle) |
Unlock allocated image data.
This function unlocks a previously locked memory handle. Once completely unlocked, memory associated with a memoryHandle is no longer available for use. Attempting to use it results in undefined behaviour.
Note that locks and unlocks nest, and to fully unlock memory you need to match the count of locks placed upon it.
Also note, if you unlock a completely unlocked handle, it has no effect (ie: the lock count can't be negative).
If unlocked, then relocked, the memory associated with a memory handle may be at a different address, however the contents will remain the same.
See also OfxImageEffectSuiteV1::imageMemoryLock and ImageEffectsMemoryAllocation.
Definition at line 1273 of file ofxImageEffect.h.
Referenced by OFX::ImageMemory::unlock().