OfxImageEffectSuiteV1::clipGetHandle
Prev   Image Effect Suite   Next

Name

OfxImageEffectSuiteV1::clipGetHandle — Get the propery handle of the named input clip in the given instance

Synopsis

#include "ofxImageEffect.h"
OfxStatus (*clipGetHandle) ( OfxImageEffectHandle imageEffect ,
  const char * name ,
  OfxImageClipHandle * clip ,
  OfxPropertySetHandle * propertySet ) ;
 

Arguments

  • imageEffect - an instance handle to the plugin
  • name - name of the clip, previously used in a clip define call
  • clip - where to return the clip
  • propertySet - if not null, the descriptor handle for a parameter's property set will be placed here.

Description

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 m 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.

\pre

  • create instance action called,
  • name passed to clipDefine for this context,
  • not inside describe or describe in context actions.

\post

  • handle will be valid for the life time of the instance.

Prev   Up   Next
OfxImageEffectSuiteV1::clipDefine   Home   OfxImageEffectSuiteV1::clipGetPropertySet