Ocean
rendering/globalillumination/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_RENDERING_GI_PLUGIN_H
9 #define META_OCEAN_RENDERING_GI_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  * @see pluginUnload().
18  * @ingroup renderinggi
19  */
20 extern "C" bool OCEAN_RENDERING_GI_EXPORT pluginLoad();
21 
22 /**
23  * Tries to unload the plugin and all internal resources of 3rd party libraries.
24  * Make sure that all resources of this plugin has been released before!
25  * @return True, if succeeded
26  * @see pluginLoad().
27  * @ingroup renderinggi
28  */
29 extern "C" bool OCEAN_RENDERING_GI_EXPORT pluginUnload();
30 
31 /**
32  * Returns informations about the used 3rd party libraries.
33  * @return Name and version of the 3rd party libraries
34  * @ingroup renderinggi
35  */
36 extern "C" OCEAN_RENDERING_GI_EXPORT const char* pluginVersion();
37 
38 #endif // META_OCEAN_RENDERING_GI_PLUGIN_H
bool OCEAN_RENDERING_GI_EXPORT pluginLoad()
Tries to load the plugin and initializes all internal 3rd party libraries.
OCEAN_RENDERING_GI_EXPORT const char * pluginVersion()
Returns informations about the used 3rd party libraries.
bool OCEAN_RENDERING_GI_EXPORT pluginUnload()
Tries to unload the plugin and all internal resources of 3rd party libraries.