Skip to content

Commit b56e6e5

Browse files
Alternative names for multidimensional params
Some foreign APIs don’t support multidimensional parameters. Plug-ins can set kOfxPropAka2D to provide alternative names for each dimenesion of a parameter, allowing the host to map them correctly. Signed-off-by: John-Paul Smith <[email protected]>
1 parent e6ade81 commit b56e6e5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

include/ofxCore.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,15 @@ This property is used to provide alternative names for objects. It can be used i
705705
*/
706706
#define kOfxPropAka "OfxPropAka"
707707

708+
/** @brief Alternative names for parameter dimensions.
709+
710+
- Type - string X N X M
711+
- Property Set - multidimensional parameter descriptors, see \ref PropertiesByObject (read only)
712+
713+
This property is used to provide alternative names for each dimension of a multidimensional parameter. It can be used in situations where effects are being transferred from another plug-in API that doesn't support multidimensional parameters, and each dimension was stored as a separate parameter.
714+
*/
715+
#define kOfxPropAka2D "OfxPropAka2D"
716+
708717
/** @brief Identifies a specific version of a host or plugin.
709718
710719
- Type - int X N

0 commit comments

Comments
 (0)