— loads an image from an OFX clip as a texture into OpenGL
||OfxImageClipHandle clip ,|
|OfxTime time ,|
|const char * format ,|
|const OfxRectD * region ,|
An image is fetched from a clip at the indicated time for the given region and loaded into an OpenGL texture. When a specific format is requested, the host ensures it gives the requested format. When the clip specified is the "Output" clip, the format is ignored and the host must bind the resulting texture as the current color buffer (render target). This may also be done prior to calling the
action. If the
region parameter is set to non-NULL, then it will be clipped to the clip's Region of Definition for the given time. The returned image will be
least as big as this region. If the region parameter is not set or is NULL, then the region fetched will be at least the Region of Interest the effect has previously specified, clipped to the clip's Region of Definition. Information about the texture, including the texture index, is returned in the
textureHandle argument. The properties on this handle will be...
With the exception of the OpenGL specifics, these properties are the same as the properties in an image handle returned by clipGetImage in the image effect suite. \pre
the host must bind the resulting texture as the current color buffer (render target). This may also be done prior to calling the render action.
kOfxStatOK- the image was successfully fetched and returned
in the handle,
kOfxStatFailed- the image could not be fetched because it does
not exist in the clip at the indicated time and/or region, the plugin should continue operation, but assume the image was black and transparent.
effect to load the texture. The plugin should abort the GL render and return
, after which the host can decide to retry the operation with CPU based processing.