Add recommendation that hosts return same host & suite for all plugin…

…s in a shlib Closes #126. Signed-off-by: Gary Oberbrunner <[email protected]>
AcademySoftwareFoundation · Dec 7, 2023 · f720567 · f720567
1 parent 5102331
commit f720567
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/include/ofxCore.h b/include/ofxCore.h
@@ -55,6 +55,9 @@ typedef struct OfxHost {
 
       Repeated calls to fetchSuite with the same parameters will return the same pointer.
 
+      It is recommended that hosts should return the same host and suite pointers to all plugins
+      in the same shared lib or bundle.
+
       returns
          - NULL if the API is unknown (either the api or the version requested),
 	 - pointer to the relevant API if it was found
@@ -126,6 +129,9 @@ typedef struct OfxPlugin {
 
       \post
         - the pointer suite is valid until the plug-in is unloaded
+
+      It is recommended that hosts should return the same host and suite pointers to all plugins
+      in the same shared lib or bundle.
   */
   void     (*setHost)(OfxHost *host);