Runtime Class
Provides static methods, properties and events for working with Carmenta Engine.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this type are, in general, not thread-safe.
Syntax
public class Runtime : System.ObjectInheritance Hierarchy
System.Object (not available in C#)
Runtime
Platforms
Windows, Linux, Android
Runtime Members
The Runtime type has the following members.
Properties
| Name | Description |
|---|---|
 ExtensionsUsedByProcess | Gets the names of all extensions used by the process. |
| GlobalCacheSize | Gets or sets the size of the global memory cache. |
| IsInitialized | Checks if the Carmenta Engine runtime has been initialized. |
| IsLicenseActivationRequired | Gets a value indicating if the current Carmenta Engine license key needs to be activated. |
| RasterSizeLimitEnabled | Gets or sets a flag indicating if the size of rasters should be limited or not. |
| Version | Gets the Carmenta Engine version information. |
Methods
| Name | Description |
|---|---|
| FireStatusChanged | Fires the StatusChanged event with the specified values. |
| GenerateLicenseActivationRequest | Generates a license activate request that can be e-emailed to Support to activate a Carmenta Engine license key. |
| GetPredefinedObject | Gets the predefined object with the given name. |
| GetPredefinedObjectNames | Gets the names of all predefined objects. |
| GetRegisteredObject | Gets the object that has been registered with the given name. |
| Initialize | Overloaded. Initializes the Carmenta Engine runtime environment. |
| IsExtensionAvailable | Checks if the specified Carmenta Engine extension can be used on this machine. |
| IsExtensionLicensed | Checks if the specified Carmenta Engine extension is licensed on this machine. |
| RegisterObject | Registers an EngineObject with the specified name. |
| Shutdown | Releases shared data and resources that Carmenta Engine has allocated. |
Events
| Name | Description |
|---|---|
| Error | Occurs when an error is detected by Carmenta Engine. |
| StatusChanged | Occurs when the status of some Carmenta Engine objects have changed or when FireStatusChanged is called. |