carb/extras/Library.h¶
↰ Parent directory: carb/extras/
Provides helper functions to handle library loading and management.
Source: carb/extras/Library.h
Included By¶
carb/extras/TestEnvironment.h: Provides helper functions to check the platform a process is running on.
omni/core/ModuleInfo.h: Helper functions for collecting module information.
omni/core/Omni.h: Main header for the Omniverse core.
Namespaces¶
carb: The main Carbonite namespace.
carb::extras: Common namespace for extra helper functions and classes.
Functions¶
carb::extras::createLibraryNameForModule: Creates a full library name from a module’s base name.
carb::extras::getDefaultLibraryExtension: Retrieves the default library file extension for the current platform.
carb::extras::getDefaultLibraryPrefix: Retrieves the default library file prefix for the current platform.
carb::extras::getLastLoadLibraryError: Retrieves a string explaining the most recent library load failure cause.
carb::extras::getLibraryDirectory: Retrieves the parent directory of the library containing a given address or symbol.
carb::extras::getLibraryDirectoryByHandle: Retrieves the parent directory of a library.
carb::extras::getLibraryFilename: Retrieves the path for a loaded library from an address or symbol within it.
carb::extras::getLibraryFilenameByHandle: Retrieves the path for a loaded library from its handle.
carb::extras::getLibraryHandleByFilename: Attempts to retrieve a library’s handle by its filename.
carb::extras::getLibrarySymbol: Attempts to retrieve the address of a symbol from a loaded module.
carb::extras::loadLibrary: Attempts to load a named library into the calling process.
carb::extras::unloadLibrary: Unloads a loaded library.
Defines¶
CARB_LIBRARY_EXTENSION: The default library file extension for the current platform.
CARB_LIBRARY_GET_LITERAL_NAME: A macro to build a libraryi file’s name as a string literal.
CARB_LIBRARY_PREFIX: Retrieves the default library file prefix for the current platform.
Typedefs¶
carb::extras::LibraryFlags: Handle to a loaded library.
Variables¶
carb::extras::fLibFlagDeepBind: Flag to indicate that the symbols in the library being loaded should be linked to first and take precedence over global scope symbols of the same name from other libraries.
carb::extras::fLibFlagMakeFullLibName: Flag to indicate that only the module’s base name was given and that the full name should be constructed using carb::extras::createLibraryNameForModule before attempting to load the library.
carb::extras::fLibFlagNow: Flag to indicate that the library should be fully loaded and linked immediately.