Ocean
interaction/empty/Plugin.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_INTERACTION_EMPTY_PLUGIN_H
9 #define META_OCEAN_INTERACTION_EMPTY_PLUGIN_H
10 
12 
13 /**
14  * Tries to load the plugin and initializes all internal 3rd party libraries.
15  * Make sure that the plugin will be loaded only once!
16  * @return True, if succeeded
17  * @ingroup interactionepy
18  */
19 extern "C" OCEAN_INTERACTION_EPY_EXPORT bool pluginLoad();
20 
21 /**
22  * Tries to unload the plugin and all internal resources of 3rd party libraries.
23  * Make sure that all resources of this plugin has been released before!
24  * @return True, if succeeded
25  * @ingroup interactionepy
26  */
27 extern "C" OCEAN_INTERACTION_EPY_EXPORT bool pluginUnload();
28 
29 /**
30  * Returns informations about the used 3rd party libraries.
31  * @return Name and version of the 3rd party libraries
32  * @ingroup interactionepy
33  */
34 extern "C" OCEAN_INTERACTION_EPY_EXPORT const char* pluginVersion();
35 
36 #endif // META_OCEAN_INTERACTION_EMPTY_PLUGIN_H
OCEAN_INTERACTION_EPY_EXPORT bool pluginLoad()
Tries to load the plugin and initializes all internal 3rd party libraries.
OCEAN_INTERACTION_EPY_EXPORT bool pluginUnload()
Tries to unload the plugin and all internal resources of 3rd party libraries.
OCEAN_INTERACTION_EPY_EXPORT const char * pluginVersion()
Returns informations about the used 3rd party libraries.