nvidia::apex::ModuleLoader Class Reference

The ModuleLoader is a utility class for loading APEX modules. More...

#include <ModuleLoader.h>

Inheritance diagram for nvidia::apex::ModuleLoader:

List of all members.

Public Types
typedef shdfnd::HashMap< const char *, nvidia::apex::ApexCreateError >	ModuleNameErrorMap
	ModuleNameErrorMap.
Public Member Functions
virtual Module *	loadModule (const char *name)=0
	Load and initialize a specific APEX module.
virtual void	loadModules (const char **names, uint32_t size, Module **modules=0)=0
	Load and initialize a list of specific APEX modules.
virtual void	loadAllModules ()=0
	Load and initialize all APEX modules.
virtual void	loadAllLegacyModules ()=0
	Load and initialize all legacy APEX modules (useful for deserializing legacy assets)
virtual uint32_t	getLoadedModuleCount () const =0
	Returns the number of loaded APEX modules.
virtual Module *	getLoadedModule (uint32_t idx) const =0
	Returns the APEX module specified by the index if it was loaded by this ModuleLoader.
virtual Module *	getLoadedModule (const char *name) const =0
	Returns the APEX module specified by the name if it was loaded by this ModuleLoader.
virtual void	releaseModule (uint32_t idx)=0
	Releases the APEX module specified by the index if it was loaded by this ModuleLoader.
virtual void	releaseModule (const char *name)=0
	Releases the APEX module specified by the name if it was loaded by this ModuleLoader.
virtual void	releaseModules (Module **modules, uint32_t size)=0
	Releases the APEX module specified by the index if it was loaded by this ModuleLoader.
virtual void	releaseModule (Module *module)=0
	Releases the specified APEX module.
virtual void	releaseModules (const char **names, uint32_t size)=0
	Releases the APEX modules specified in the names list.
virtual void	releaseLoadedModules ()=0
	Releases all APEX modules loaded by this ModuleLoader.
virtual const ModuleNameErrorMap &	getLoadedModulesErrors () const =0
	Returns ModuleNameErrorMap.

---

Detailed Description

The ModuleLoader is a utility class for loading APEX modules.

Note:

The most useful methods for rapid integration are "loadAllModules()", "loadAllLegacyModules()", and "releaseLoadedModules()".

If you need to release APEX modules loaded with ModuleLoader you should use one of the release-methods provided below. Note that you may never need it because SDK automatically releases all modules when program ends.

---

Member Function Documentation

virtual void nvidia::apex::ModuleLoader::loadModules	(	const char **	names,
		uint32_t	size,
		Module **	modules = 0
	)		[pure virtual]

Load and initialize a list of specific APEX modules.

Parameters:

[in]	names	The names of modules to load
[in]	size	Number of modules to load
[in]	modules	The modules array must be the same size as the names array to support storage of every loaded Module pointer. Use NULL if you do not need the list of created modules.

virtual void nvidia::apex::ModuleLoader::releaseModule

(

Module *

module

)

[pure virtual]

Releases the specified APEX module.

Note:

If the ModuleLoader is used to load modules, this method must be used to release individual modules. Do not use the Module::release() method.

virtual void nvidia::apex::ModuleLoader::releaseModules	(	const char **	names,
		uint32_t	size
	)		[pure virtual]

Releases the APEX modules specified in the names list.

Note:

If the ModuleLoader is used to load modules, this method must be used to release individual modules. Do not use the Module::release() method.

---

The documentation for this class was generated from the following file:

• ModuleLoader.h