PixelLightAPI
.
|
PixelLight framework runtime class. More...
#include <Runtime.h>
Public Types | |
enum | EType { StaticInstallation, LocalInstallation, SystemInstallation } |
Runtime installation type. More... | |
Static Public Member Functions | |
static PLCORE_API EType | GetType () |
Get used PixelLight installation type. | |
static PLCORE_API Version | GetVersion () |
Get PixelLight version. | |
static bool | IsDebugVersion () |
Return whether or not this is a debug version of PixelLight. | |
static PLCORE_API String | GetSuffix () |
Get PixelLight suffix. | |
static String | GetLocalDirectory () |
Try to find the local PixelLight runtime directory. | |
static PLCORE_API String | GetLocalDataDirectory () |
Try to find the local PixelLight runtime data directory. | |
static PLCORE_API String | GetSystemDirectory () |
Try to find the system PixelLight runtime directory. | |
static PLCORE_API String | GetSystemDataDirectory () |
Try to find the system PixelLight runtime data directory. | |
static PLCORE_API String | GetRegistryDirectory () |
Try to find the system PixelLight runtime directory by reading the registry. | |
static PLCORE_API String | GetRegistryDataDirectory () |
Try to find the system PixelLight runtime data directory by reading the registry. | |
static PLCORE_API String | GetDirectory () |
Try to find the PixelLight runtime directory used by the running process. | |
static PLCORE_API String | GetDataDirectory () |
Try to find the PixelLight runtime data directory used by the running process. | |
static PLCORE_API String | GetPLCoreSharedLibraryName () |
Returns the name of the PLCore shared library. | |
static PLCORE_API String | GetPLCoreSharedLibraryDirectory () |
Returns the absolute path to the directory the PLCore shared library is in. | |
static PLCORE_API bool | SetDirectory (const String &sDirectory, String *pszErrorMessage=nullptr) |
Sets the given PixelLight runtime directory. | |
static PLCORE_API void | ScanDirectoryPlugins (const String &sDirectory="", bool bDelayedPluginLoading=true) |
Scan system PixelLight runtime directory for compatible plugins and load them in. | |
static PLCORE_API void | ScanDirectoryData (const String &sDirectory="") |
Scan system PixelLight runtime directory for compatible data and register it. | |
static PLCORE_API bool | ScanDirectoryPluginsAndData (bool bUrgentMessageAllowed=true) |
Scan PixelLight runtime directory for compatible plugins and load them in as well as scan for compatible data and register it. |
PixelLight framework runtime class.
Runtime installation type.
StaticInstallation |
The running process is using the static linked version of PLCore |
LocalInstallation |
The PixelLight runtime is in the same directory as the running process, making this to a local installation |
SystemInstallation |
The PixelLight runtime is registered within the system, making this to a system installation |
static PLCORE_API EType PLCore::Runtime::GetType | ( | ) | [static] |
Get used PixelLight installation type.
static PLCORE_API Version PLCore::Runtime::GetVersion | ( | ) | [static] |
Get PixelLight version.
bool PLCore::Runtime::IsDebugVersion | ( | ) | [inline, static] |
Return whether or not this is a debug version of PixelLight.
static PLCORE_API String PLCore::Runtime::GetSuffix | ( | ) | [static] |
Get PixelLight suffix.
String PLCore::Runtime::GetLocalDirectory | ( | ) | [inline, static] |
Try to find the local PixelLight runtime directory.
static PLCORE_API String PLCore::Runtime::GetLocalDataDirectory | ( | ) | [static] |
Try to find the local PixelLight runtime data directory.
static PLCORE_API String PLCore::Runtime::GetSystemDirectory | ( | ) | [static] |
Try to find the system PixelLight runtime directory.
static PLCORE_API String PLCore::Runtime::GetSystemDataDirectory | ( | ) | [static] |
Try to find the system PixelLight runtime data directory.
static PLCORE_API String PLCore::Runtime::GetRegistryDirectory | ( | ) | [static] |
Try to find the system PixelLight runtime directory by reading the registry.
On MS Windows, this key has to be at "HKEY_LOCAL_MACHINE/SOFTWARE/PixelLight/PixelLight-SDK/Runtime" (or at "HKEY_LOCAL_MACHINE/SOFTWARE/Wow6432Node/PixelLight/PixelLight-SDK/Runtime" if you are using a 32 bit PixelLight SDK on a 64 bit MS Windows). This "Runtime"-key has e.g. the string value "C:/PixelLight/Bin/Runtime/x86/" (same as the PATH environment variable entry pointing to the PixelLight runtime directory).
On Linux, the "PL_RUNTIME" environment variable is used. If this variable does not exist, "/usr/local/share/pixellight/Runtime" will be used, if it exists.
static PLCORE_API String PLCore::Runtime::GetRegistryDataDirectory | ( | ) | [static] |
Try to find the system PixelLight runtime data directory by reading the registry.
static PLCORE_API String PLCore::Runtime::GetDirectory | ( | ) | [static] |
Try to find the PixelLight runtime directory used by the running process.
static PLCORE_API String PLCore::Runtime::GetDataDirectory | ( | ) | [static] |
Try to find the PixelLight runtime data directory used by the running process.
static PLCORE_API String PLCore::Runtime::GetPLCoreSharedLibraryName | ( | ) | [static] |
static PLCORE_API String PLCore::Runtime::GetPLCoreSharedLibraryDirectory | ( | ) | [static] |
static PLCORE_API bool PLCore::Runtime::SetDirectory | ( | const String & | sDirectory, |
String * | pszErrorMessage = nullptr |
||
) | [static] |
Sets the given PixelLight runtime directory.
[in] | sDirectory | Path to the PixelLight runtime directory (e.g. "C:\PixelLight\Runtime\x86" on Windows), or "" |
[out] | pszErrorMessage | If this parameter is no null pointer and there was an error, this string will receive a human readable error description, if there was no error this string is not touched |
static PLCORE_API void PLCore::Runtime::ScanDirectoryPlugins | ( | const String & | sDirectory = "" , |
bool | bDelayedPluginLoading = true |
||
) | [static] |
Scan system PixelLight runtime directory for compatible plugins and load them in.
[in] | sDirectory | Directory to use (for example the result of "GetDirectory()", "GetLocalDirectory()" or "GetSystemDirectory()"), if empty string the result of "GetDirectory()" will be used |
[in] | bDelayedPluginLoading | 'true' if it's allowed to perform delayed shared library loading to speed up the program start, else 'false' |
static PLCORE_API void PLCore::Runtime::ScanDirectoryData | ( | const String & | sDirectory = "" | ) | [static] |
Scan system PixelLight runtime directory for compatible data and register it.
[in] | sDirectory | Directory to use (for example the result of "GetDataDirectory()", "GetLocalDataDirectory()" or "GetSystemDataDirectory()"), if empty string the result of "GetDataDirectory()" will be used |
static PLCORE_API bool PLCore::Runtime::ScanDirectoryPluginsAndData | ( | bool | bUrgentMessageAllowed = true | ) | [static] |
Scan PixelLight runtime directory for compatible plugins and load them in as well as scan for compatible data and register it.
[in] | bUrgentMessageAllowed | Is this method allowed to show an urgent message to the user in case of a failure? |
|