NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IPlugin Class Referenceabstract

The basic interface to be implemented by Iray API plugins. More...

Inheritance diagram for mi::neuraylib::IPlugin:
Inheritance graph
[legend]

Public Member Functions

virtual bool  init (IPlugin_api *plugin_api)=0
  Initializes the plugin. More...
 
virtual bool  exit (IPlugin_api *plugin_api)=0
  De-initializes the plugin. More...
 
- Public Member Functions inherited from mi::base::Plugin
virtual Sint32  get_plugin_system_version () const
  Returns the version of the plugin system used to compile this. More...
 
virtual const char *  get_name () const =0
  Returns the name of the plugin. More...
 
virtual const char *  get_type () const =0
  Returns the type of the plugin. More...
 
virtual Sint32  get_version () const
  Returns the version number of the plugin. More...
 
virtual const char *  get_compiler () const
  Returns the compiler used to compile the plugin. More...
 
virtual void  release ()=0
  Destroys the plugin instance. More...
 
virtual const char *  get_string_property (Sint32 index, const char **value)
  Returns a plugin property. More...
 

Detailed Description

The basic interface to be implemented by Iray API plugins.

Iray API plugins need to return MI_NEURAYLIB_PLUGIN_TYPE in mi::base::Plugin::get_type().

Member Function Documentation

virtual bool mi::neuraylib::IPlugin::exit ( IPlugin_api plugin_api)
pure virtual

De-initializes the plugin.

Parameters
plugin_api Provides access to API components available for plugins.
Returns
true in case of success, and false otherwise.
virtual bool mi::neuraylib::IPlugin::init ( IPlugin_api plugin_api)
pure virtual

Initializes the plugin.

Parameters
plugin_api Provides access to API components available for plugins.
Returns
true in case of success, and false otherwise.