The OFX suite for param manipulation. More...

#include <ofxParamAPI.h>

Data Fields
OfxStatus(*	getPropertySet )(OfxParamNodeHandle paramNode, OfxPropertySetHandle *propHandle)
	Retrieves the property set for the given param node.
OfxStatus(*	getParamSet )(OfxParamNodeHandle paramNode, OfxParamSetHandle *paramSet)
	Retrieves the parameter set for the given param node.
int(*	abort )(OfxParamNodeHandle paramNode)
	Returns whether to abort processing or not.

Detailed Description

The OFX suite for param manipulation.

This suite provides the functions needed by a plugin to defined and use a param manipulation plugin.

Definition at line 63 of file ofxParamAPI.h.

Field Documentation

int( * OfxParamNodeSuiteV1::abort)(OfxParamNodeHandle paramNode)

Returns whether to abort processing or not.

paramNode - instance of the param node

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.

Returns:

0 if the effect should continue whatever processing it is doing
1 if the effect should abort whatever processing it is doing

Definition at line 108 of file ofxParamAPI.h.

OfxStatus( * OfxParamNodeSuiteV1::getParamSet)(OfxParamNodeHandle paramNode, OfxParamSetHandle *paramSet)

Retrieves the parameter set for the given param node.

paramNode param node to get the property set for
paramSet pointer to a the parameter set, value is returned here

The param set handle is valid for the lifetime of the param node handle.

Returns:

kOfxStatOK - the property set was found and returned
kOfxStatErrBadHandle - if the paramter handle was invalid
kOfxStatErrUnknown - if the type is unknown

Definition at line 92 of file ofxParamAPI.h.

OfxStatus( * OfxParamNodeSuiteV1::getPropertySet)(OfxParamNodeHandle paramNode, OfxPropertySetHandle *propHandle)

Retrieves the property set for the given param node.

paramNode param node to get the property set for
propHandle pointer to a the property set pointer, value is returned here

The property handle is for the duration of the param node handle.

Returns:

kOfxStatOK - the property set was found and returned
kOfxStatErrBadHandle - if the paramter handle was invalid
kOfxStatErrUnknown - if the type is unknown

Definition at line 77 of file ofxParamAPI.h.

The documentation for this struct was generated from the following file:

libraries/openfxHack/include/extensions/tuttle/ofxParamAPI.h

Data Fields

Detailed Description

Field Documentation