OfxImageEffectSuiteV1::clipGetImage

`OfxImageEffectSuiteV1::clipGetImage`
Prev	Chapter 16. Image Effect Suite	Next

Name

OfxImageEffectSuiteV1::clipGetImage — Get a handle for an image in a clip at the indicated time and indicated region

#include "ofxImageEffect.h"

`OfxStatus(*clipGetImage)(`	OfxImageClipHandle`clip`,
	OfxTime `time`,
	OfxRectD *`region`,
	OfxPropertySetHandle *`imageHandle)`;

clip - the clip to extract the image from
time - time to fetch the image at
region - region to fetch the image from (optional, set to NULL to get a 'default' region) this is in the CanonicalCoordinates.
imageHandle - property set containing the image's data

An image is fetched from a clip at the indicated time for the given region and returned in the imageHandle.

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.

kOfxStatErrBadHandle - the clip handle was invalid,
kOfxStatErrMemory - the host had not enough memory to complete the operation, plugin should abort whatever it was doing.

Prev	Up	Next
`OfxImageEffectSuiteV1::clipGetPropertySet`	Home	`OfxImageEffectSuiteV1::clipReleaseImage`