#include <ofxParam.h>
Public Attributes | |
OfxStatus(* | paramDefine )(OfxParamSetHandle paramSet, const char *paramType, const char *name, OfxPropertySetHandle *propertySet) |
Defines a new parameter of the given type in a describe action. | |
OfxStatus(* | paramGetHandle )(OfxParamSetHandle paramSet, const char *name, OfxParamHandle *param, OfxPropertySetHandle *propertySet) |
Retrieves the handle for a parameter in a given parameter set. | |
OfxStatus(* | paramSetGetPropertySet )(OfxParamSetHandle paramSet, OfxPropertySetHandle *propHandle) |
Retrieves the property set handle for the given parameter set. | |
OfxStatus(* | paramGetPropertySet )(OfxParamHandle param, OfxPropertySetHandle *propHandle) |
Retrieves the property set handle for the given parameter. | |
OfxStatus(* | paramGetValue )(OfxParamHandle paramHandle,...) |
Gets the current value of a parameter,. | |
OfxStatus(* | paramGetValueAtTime )(OfxParamHandle paramHandle, OfxTime time,...) |
Gets the value of a parameter at a specific time. | |
OfxStatus(* | paramGetDerivative )(OfxParamHandle paramHandle, OfxTime time,...) |
Gets the derivative of a parameter at a specific time. | |
OfxStatus(* | paramGetIntegral )(OfxParamHandle paramHandle, OfxTime time1, OfxTime time2,...) |
Gets the integral of a parameter over a specific time range,. | |
OfxStatus(* | paramSetValue )(OfxParamHandle paramHandle,...) |
Sets the current value of a parameter. | |
OfxStatus(* | paramSetValueAtTime )(OfxParamHandle paramHandle, OfxTime time,...) |
Keyframes the value of a parameter at a specific time. | |
OfxStatus(* | paramGetNumKeys )(OfxParamHandle paramHandle, unsigned int *numberOfKeys) |
Returns the number of keyframes in the parameter. | |
OfxStatus(* | paramGetKeyTime )(OfxParamHandle paramHandle, unsigned int nthKey, OfxTime *time) |
Returns the time of the nth key. | |
OfxStatus(* | paramGetKeyIndex )(OfxParamHandle paramHandle, OfxTime time, int direction, int *index) |
Finds the index of a keyframe at/before/after a specified time. | |
OfxStatus(* | paramDeleteKey )(OfxParamHandle paramHandle, OfxTime time) |
Deletes a keyframe if one exists at the given time. | |
OfxStatus(* | paramDeleteAllKeys )(OfxParamHandle paramHandle) |
Deletes all keyframes from a parameter. | |
OfxStatus(* | paramCopy )(OfxParamHandle paramTo, OfxParamHandle paramFrom, OfxTime dstOffset, OfxRangeD *frameRange) |
Copies one parameter to another, including any animation etc... | |
OfxStatus(* | paramEditBegin )(OfxParamSetHandle paramSet, const char *name) |
Used to group any parameter changes for undo/redo purposes. | |
OfxStatus(* | paramEditEnd )(OfxParamSetHandle paramSet) |
Used to group any parameter changes for undo/redo purposes. |
OfxStatus(* OfxParameterSuiteV1::paramDefine)(OfxParamSetHandle paramSet, const char *paramType, const char *name, OfxPropertySetHandle *propertySet) |
Defines a new parameter of the given type in a describe action.
This function does not actually create a parameter, it only says that one should exist in any subsequent instances. To fetch an parameter instance paramGetHandle must be called on an instance.
This function can always be called in one of a plug-in's 'describe' functions which defines the parameter sets common to all instances of a plugin.
OfxStatus(* OfxParameterSuiteV1::paramGetHandle)(OfxParamSetHandle paramSet, const char *name, OfxParamHandle *param, OfxPropertySetHandle *propertySet) |
Retrieves the handle for a parameter in a given parameter set.
OfxStatus(* OfxParameterSuiteV1::paramSetGetPropertySet)(OfxParamSetHandle paramSet, OfxPropertySetHandle *propHandle) |
Retrieves the property set handle for the given parameter set.
OfxStatus(* OfxParameterSuiteV1::paramGetPropertySet)(OfxParamHandle param, OfxPropertySetHandle *propHandle) |
Retrieves the property set handle for the given parameter.
OfxStatus(* OfxParameterSuiteV1::paramGetValue)(OfxParamHandle paramHandle,...) |
Gets the current value of a parameter,.
OfxParamHandle myDoubleParam, *myColourParam; ofxHost->paramGetHandle(instance, "myDoubleParam", &myDoubleParam); double myDoubleValue; ofxHost->paramGetValue(myDoubleParam, &myDoubleValue); ofxHost->paramGetHandle(instance, "myColourParam", &myColourParam); double myR, myG, myB; ofxHost->paramGetValue(myColourParam, &myR, &myG, &myB);
OfxStatus(* OfxParameterSuiteV1::paramGetValueAtTime)(OfxParamHandle paramHandle, OfxTime time,...) |
Gets the value of a parameter at a specific time.
OfxStatus(* OfxParameterSuiteV1::paramGetDerivative)(OfxParamHandle paramHandle, OfxTime time,...) |
Gets the derivative of a parameter at a specific time.
The varargs needs to be pointer to C variables of the relevant type for this parameter. See OfxParameterSuiteV1::paramGetValue for notes on the varags list.
Only double and colour params can have their derivatives found.
OfxStatus(* OfxParameterSuiteV1::paramGetIntegral)(OfxParamHandle paramHandle, OfxTime time1, OfxTime time2,...) |
Gets the integral of a parameter over a specific time range,.
The varargs needs to be pointer to C variables of the relevant type for this parameter. See OfxParameterSuiteV1::paramGetValue for notes on the varags list.
Only double and colour params can be integrated.
OfxStatus(* OfxParameterSuiteV1::paramSetValue)(OfxParamHandle paramHandle,...) |
Sets the current value of a parameter.
ofxHost->paramSetValue(instance, "myDoubleParam", double(10)); ofxHost->paramSetValue(instance, "myColourParam", double(pix.r), double(pix.g), double(pix.b));
OfxStatus(* OfxParameterSuiteV1::paramSetValueAtTime)(OfxParamHandle paramHandle, OfxTime time,...) |
Keyframes the value of a parameter at a specific time.
This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.
OfxStatus(* OfxParameterSuiteV1::paramGetNumKeys)(OfxParamHandle paramHandle, unsigned int *numberOfKeys) |
Returns the number of keyframes in the parameter.
Returns the number of keyframes in the parameter.
OfxStatus(* OfxParameterSuiteV1::paramGetKeyTime)(OfxParamHandle paramHandle, unsigned int nthKey, OfxTime *time) |
Returns the time of the nth key.
OfxStatus(* OfxParameterSuiteV1::paramGetKeyIndex)(OfxParamHandle paramHandle, OfxTime time, int direction, int *index) |
Finds the index of a keyframe at/before/after a specified time.
OfxStatus(* OfxParameterSuiteV1::paramDeleteKey)(OfxParamHandle paramHandle, OfxTime time) |
Deletes a keyframe if one exists at the given time.
OfxStatus(* OfxParameterSuiteV1::paramDeleteAllKeys)(OfxParamHandle paramHandle) |
Deletes all keyframes from a parameter.
OfxStatus(* OfxParameterSuiteV1::paramCopy)(OfxParamHandle paramTo, OfxParamHandle paramFrom, OfxTime dstOffset, OfxRangeD *frameRange) |
Copies one parameter to another, including any animation etc...
To choose all animation in paramFrom set frameRange to [0, 0]
This function can be called the kOfxActionInstanceChanged action and during image effect analysis render passes.
OfxStatus(* OfxParameterSuiteV1::paramEditBegin)(OfxParamSetHandle paramSet, const char *name) |
Used to group any parameter changes for undo/redo purposes.
See also OfxParameterSuiteV1::paramEditEnd
OfxStatus(* OfxParameterSuiteV1::paramEditEnd)(OfxParamSetHandle paramSet) |
Used to group any parameter changes for undo/redo purposes.
See also OfxParameterSuiteV1::paramEditBegin