Name, version, and behavior information to be defined by node classes, types, and libraries.
|
#define | VuoModuleDetails(...) const char *moduleDetails = #__VA_ARGS__ |
| Name, version, and behavior information to be defined by node classes, types, and libraries.
|
|
#define VuoModuleDetails |
( |
|
... | ) |
const char *moduleDetails = #__VA_ARGS__ |
Name, version, and behavior information to be defined by node classes, types, and libraries.
- Example:
"name" : "Display Console Window",
"description" : "<p>Opens a window that displays console output ...</p>",
"keywords" : [ "print", "log" ],
"version" : "1.0.0",
"dependencies" : [ "VuoWindow" ],
"node": {
"isInterface" : true
}
});
Pass a JSON specification that contains metadata about the node class, type, or library.
For modules, the keys in the JSON specification may include:
- "name" (required) — A human-readable name for the module. It can be overridden by the user.
- "description" (optional) — A description of the module's purpose. It may be formatted as plain text or HTML.
- "keywords" (optional) — A list of words related to the module's name. This list is used when searching for node classes in the Vuo Editor's Node Library.
- "version" (optional) — A version number for the module. It should use the Semantic Versioning (SemVer) scheme.
- "dependencies" (optional) — A list of libraries that this module depends upon.
For node classes, the keys in the JSON specification may additionally include "node"; its keys may include:
- "isInterface" (optional) — True if this node class sends data to or receives data from somewhere external to the composition (e.g., input device, file, network). False by default.
- See Also
- Writing a Node Class
-
Writing a Type
-
Using Libraries