![]() |
Murl Engine API
Version 2018.3
|
The engine configuration interface defines the engine-specific settings which can be modified prior to starting the engine only, e.g. More...
#include <murl_i_engine_configuration.h>
The engine configuration interface defines the engine-specific settings which can be modified prior to starting the engine only, e.g.
Inherited by Murl::Util::EngineConfiguration.
Public Member Functions | |
virtual const IPlatformConfiguration * | GetPlatformConfiguration () const =0 |
Get the const platform configuration object. More... | |
virtual const IAppConfiguration * | GetAppConfiguration () const =0 |
Get the const application configuration object. More... | |
virtual IAppConfiguration * | GetAppConfiguration ()=0 |
Get the application configuration object. More... | |
virtual Bool | HasChanged (ChangeInspector &inspector) const =0 |
Check is any configuration setting has changed. More... | |
virtual IAttributes * | GetDefaultGraphParameters ()=0 |
Get the mutable set of default graph parameters. More... | |
virtual const IAttributes * | GetDefaultGraphParameters () const =0 |
Get the constant set of default graph parameters. More... | |
virtual IFeatureSet * | GetFeatures ()=0 |
Get the feature set object. More... | |
virtual const IFeatureSet * | GetFeatures () const =0 |
Get the const feature set object. More... | |
virtual UInt32 | GetMajorRevision () const =0 |
Get the major revision of the engine. More... | |
virtual UInt32 | GetMinorRevision () const =0 |
Get the minor revision of the engine. More... | |
virtual UInt32 | GetBuildNumber () const =0 |
Get the build number of the engine. More... | |
virtual const String & | GetReleaseState () const =0 |
Get the release state string of the engine. More... | |
virtual const String & | GetVersionString () const =0 |
Get the version string of the engine. More... | |
virtual const String & | GetCopyrightString () const =0 |
Get the copyright string of the engine. More... | |
virtual void | SetLicenseKey (const UInt8 *key)=0 |
Set the licence key data. More... | |
virtual const ConstData & | GetLicenseKey () const =0 |
Get the licence key data object. More... | |
virtual void | SetLogFileName (const String &logFileName)=0 |
Set the log file name. More... | |
virtual const String & | GetLogFileName () const =0 |
Get the log file name. More... | |
virtual void | SetLogFileFullPath (const String &logFilePath)=0 |
Set the log file full path. More... | |
virtual const String & | GetLogFileFullPath () const =0 |
Get the log file full path. More... | |
virtual void | SetRunLoopMode (IEnums::RunLoopMode runLoopMode)=0 |
Set the engine's run loop mode. More... | |
virtual IEnums::RunLoopMode | GetRunLoopMode () const =0 |
Get the engine's run loop mode. More... | |
virtual void | SetBootTime (const System::Time &time)=0 |
Set the boot time. More... | |
virtual const System::Time & | GetBootTime () const =0 |
Get the boot time. More... | |
virtual Bool | HasBootTimeChanged (ChangeInspector &inspector) const =0 |
Check if the boot time has changed. More... | |
virtual void | SetProductName (const String &productName)=0 |
Set the product name. More... | |
virtual const String & | GetProductName () const =0 |
Get the product name. More... | |
virtual Bool | HasProductNameChanged (ChangeInspector &inspector) const =0 |
Check if the product name has changed. More... | |
virtual void | SetVersionName (const String &versionName)=0 |
Set the app version name. More... | |
virtual const String & | GetVersionName () const =0 |
Get the app version name. More... | |
virtual Bool | HasVersionNameChanged (ChangeInspector &inspector) const =0 |
Check if the app version name has changed. More... | |
virtual void | SetAudioSessionCategory (IEnums::AudioSessionCategory sessionCategory)=0 |
Set the audio session category. More... | |
virtual IEnums::AudioSessionCategory | GetAudioSessionCategory () const =0 |
Get the audio session category. More... | |
virtual Bool | HasAudioSessionCategoryChanged (ChangeInspector &inspector) const =0 |
Check if the audio session category has changed. More... | |
virtual void | SetVideoApi (IEnums::VideoApi videoApi)=0 |
Set the video api enumeration value. More... | |
virtual IEnums::VideoApi | GetVideoApi () const =0 |
Get the video api enumeration value. More... | |
virtual Bool | IsVideoApiMatching (IEnums::VideoApi videoApi) const =0 |
Check if the video api is matching a specified value. More... | |
virtual Bool | HasVideoApiChanged (ChangeInspector &inspector) const =0 |
Check if the video api enumeration value has changed. More... | |
virtual void | SetAudioApi (IEnums::AudioApi audioApi)=0 |
Set the audio api enumeration value. More... | |
virtual IEnums::AudioApi | GetAudioApi () const =0 |
Get the audio api enumeration value. More... | |
virtual Bool | IsAudioApiMatching (IEnums::AudioApi audioApi) const =0 |
Check if the audio api is matching a specified value. More... | |
virtual Bool | HasAudioApiChanged (ChangeInspector &inspector) const =0 |
Check if the audio api enumeration value has changed. More... | |
virtual void | SetVideoRendererClassName (const String &className)=0 |
Set the video renderer class name. More... | |
virtual const String & | GetVideoRendererClassName () const =0 |
Get the video renderer class name. More... | |
virtual Bool | HasVideoRendererClassNameChanged (ChangeInspector &inspector) const =0 |
Check if the video renderer class name has changed. More... | |
virtual void | SetAudioRendererClassName (const String &className)=0 |
Set the audio renderer class name. More... | |
virtual const String & | GetAudioRendererClassName () const =0 |
Get the audio renderer class name. More... | |
virtual Bool | HasAudioRendererClassNameChanged (ChangeInspector &inspector) const =0 |
Check if the audio renderer class name has changed. More... | |
virtual void | SetPhysicsSimulatorClassName (const String &className)=0 |
Set the physics simulator class name. More... | |
virtual const String & | GetPhysicsSimulatorClassName () const =0 |
Get the physics simulator class name. More... | |
virtual Bool | HasPhysicsSimulatorClassNameChanged (ChangeInspector &inspector) const =0 |
Check if the physics simulator class name has changed. More... | |
virtual void | SetResourceCollectionClassName (const String &className)=0 |
Set the resource collection class name. More... | |
virtual const String & | GetResourceCollectionClassName () const =0 |
Get the resource collection class name. More... | |
virtual Bool | HasResourceCollectionClassNameChanged (ChangeInspector &inspector) const =0 |
Check if the resource collection class name has changed. More... | |
virtual void | SetPreferredResourcePackageType (IEnums::PackageType type)=0 |
Set the preferred resource package type. More... | |
virtual IEnums::PackageType | GetPreferredResourcePackageType () const =0 |
Get the preferred resource package type. More... | |
virtual Bool | HasPreferredResourcePackageTypeChanged (ChangeInspector &inspector) const =0 |
Check if the preferred resource package type has changed. More... | |
virtual void | SetResourceFileCategory (IEnums::FileCategory category)=0 |
Set the resource file category. More... | |
virtual IEnums::FileCategory | GetResourceFileCategory () const =0 |
Get the resource file category. More... | |
virtual Bool | HasResourceFileCategoryChanged (ChangeInspector &inspector) const =0 |
Check if the resource file category has changed. More... | |
virtual void | SetDeactivatedAppRunState (IEnums::AppRunState appRunState)=0 |
Set the deactivated application run state. More... | |
virtual IEnums::AppRunState | GetDeactivatedAppRunState () const =0 |
Get the deactivated application run state. More... | |
virtual Bool | HasDeactivatedAppRunStateChanged (ChangeInspector &inspector) const =0 |
Check if the deactivated application run state has changed. More... | |
virtual void | SetSuspendUnloadsResources (Bool unload)=0 |
Set the suspend unloads resources flag. More... | |
virtual Bool | GetSuspendUnloadsResources () const =0 |
Get the suspend unloads resources flag. More... | |
virtual Bool | HasSuspendUnloadsResourcesChanged (ChangeInspector &inspector) const =0 |
Check if the suspend unloads resources flag has changed. More... | |
virtual void | SetSuspendableResources (IEnums::SuspendableResources suspendableResources)=0 |
Set the suspendable resources type. More... | |
virtual IEnums::SuspendableResources | GetSuspendableResources () const =0 |
Get the suspendable resources type. More... | |
virtual Bool | HasSuspendableResourcesChanged (ChangeInspector &inspector) const =0 |
Check if the suspendable resources type has changed. More... | |
virtual void | SetUnitSize (Real sizeX, Real sizeY)=0 |
Set the global unit size factor. More... | |
virtual Real | GetUnitSizeX () const =0 |
Get the horizontal unit size factor. More... | |
virtual Real | GetUnitSizeY () const =0 |
Get the vertical unit size factor. More... | |
virtual Bool | HasUnitSizeChanged (ChangeInspector &inspector) const =0 |
Check if the global unit size factor has changed. More... | |
virtual void | SetPixelCenter (Real centerX, Real centerY)=0 |
Set the pixel center position. More... | |
virtual Real | GetPixelCenterX () const =0 |
Get the horizontal pixel center position. More... | |
virtual Real | GetPixelCenterY () const =0 |
Get the vertical pixel center position. More... | |
virtual Bool | HasPixelCenterChanged (ChangeInspector &inspector) const =0 |
Check if the global pixel center position has changed. More... | |
virtual void | SetSyncLoadingTimeout (Double timeout)=0 |
Set the synchronous resource initialization timeout. More... | |
virtual Double | GetSyncLoadingTimeout () const =0 |
Get the synchronous resource initialization timeout. More... | |
virtual Bool | HasSyncLoadingTimeoutChanged (ChangeInspector &inspector) const =0 |
Check if the synchronous resource initialization timeout has changed. More... | |
virtual void | SetAsyncLoadingEnabled (Bool enabled)=0 |
Enable asynchronous resource initialization after loading. More... | |
virtual Bool | IsAsyncLoadingEnabled () const =0 |
Check if the asynchronous loading is enabled. More... | |
virtual Bool | HasAsyncLoadingEnabledChanged (ChangeInspector &inspector) const =0 |
Check if the asynchronous loading setting has changed. More... | |
virtual void | SetSyncToVBlankEnabled (Bool enabled)=0 |
Enable synchronous vertical blank page flipping. More... | |
virtual Bool | IsSyncToVBlankEnabled () const =0 |
Check if the synchronous vertical blank page flipping is enabled. More... | |
virtual Bool | HasSyncToVBlankEnabledChanged (ChangeInspector &inspector) const =0 |
Check if the synchronous vertical blank page flipping setting has changed. More... | |
virtual void | SetVideoApiChecksEnabled (Bool enabled)=0 |
Enable checks to video api calls. More... | |
virtual Bool | AreVideoApiChecksEnabled () const =0 |
Check if the video api check feature is enabled. More... | |
virtual Bool | HasVideoApiChecksEnabledChanged (ChangeInspector &inspector) const =0 |
Check if the video api check setting has changed. More... | |
virtual void | SetAudioApiChecksEnabled (Bool enabled)=0 |
Enable checks to audio api calls. More... | |
virtual Bool | AreAudioApiChecksEnabled () const =0 |
Check if the audio api check feature is enabled. More... | |
virtual Bool | HasAudioApiChecksEnabledChanged (ChangeInspector &inspector) const =0 |
Check if the audio api check setting has changed. More... | |
virtual void | SetNumberOfAntialiasSamples (UInt32 numSamples)=0 |
Set the number of antialiasing samples. More... | |
virtual UInt32 | GetNumberOfAntialiasSamples () const =0 |
Get the number of antialiasing samples. More... | |
virtual Bool | HasNumberOfAntialiasSamplesChanged (ChangeInspector &inspector) const =0 |
Check if the number of antialiasing samples has changed. More... | |
virtual void | SetDefaultMaxTextureAnisotropy (Real maxAnisotropy)=0 |
Set the default maximum texture anisotropy for filtering. More... | |
virtual Real | GetDefaultMaxTextureAnisotropy () const =0 |
Get the default maximum texture anisotropy for filtering. More... | |
virtual Bool | HasDefaultMaxTextureAnisotropyChanged (ChangeInspector &inspector) const =0 |
Check if the default maximum texture anisotropy has changed. More... | |
virtual void | SetTexturePrescaleDivisor (UInt32 divisor)=0 |
Set the texture prescale divisor. More... | |
virtual UInt32 | GetTexturePrescaleDivisor () const =0 |
Get the texture prescale divisor. More... | |
virtual Bool | IsTexturePrescaleDivisorMatching (UInt32 divisor) const =0 |
Check if the texture prescale divisor matching a specified value. More... | |
virtual Bool | HasTexturePrescaleDivisorChanged (ChangeInspector &inspector) const =0 |
Check if the texture prescale divisor has changed. More... | |
virtual void | SetExactLogicTickDuration (Double dt)=0 |
Set the exact logic tick duration. More... | |
virtual void | SetBoundsForLogicTickDuration (Double dtMin, Double dtMax)=0 |
Set the logic tick duration bounds. More... | |
virtual Double | GetMinimumLogicTickDuration () const =0 |
Get minimum logic tick duration in seconds. More... | |
virtual Double | GetMaximumLogicTickDuration () const =0 |
Get maximum logic tick duration in seconds. More... | |
virtual Bool | HasLogicTickDurationChanged (ChangeInspector &inspector) const =0 |
Check if the logic tick duration setting has changed. More... | |
virtual void | SetExactLogicTicksPerFrame (UInt32 numTicks)=0 |
Set the exact number of logic ticks per frame. More... | |
virtual void | SetBoundsForLogicTicksPerFrame (UInt32 numTicksMin, UInt32 numTicksMax)=0 |
Set the number of logic ticks per frame bounds. More... | |
virtual UInt32 | GetMinimumLogicTicksPerFrame () const =0 |
Get minimum number of logic logic ticks per frame. More... | |
virtual UInt32 | GetMaximumLogicTicksPerFrame () const =0 |
Get maximum number of logic logic ticks per frame. More... | |
virtual Bool | HasLogicTicksPerFrameChanged (ChangeInspector &inspector) const =0 |
Check if the number of logic logic ticks per frame setting has changed. More... | |
virtual void | AddSystemFont (const String &fontId, const String &fontName, Real weight, Real sizeFactor, Real ascent, Real descent, Real leading)=0 |
Add a user-defined system font. More... | |
virtual UInt32 | GetNumberOfSystemFonts () const =0 |
Get the number of user-defined system fonts. More... | |
virtual const String & | GetSystemFontId (UInt32 index) const =0 |
Get the internal ID of the user-defined system font at a given index. More... | |
virtual const String & | GetSystemFontName (UInt32 index) const =0 |
Get the OS-specific name of the user-defined system font at a given index. More... | |
virtual Real | GetSystemFontWeight (UInt32 index) const =0 |
Get the weight of the user-defined system font at a given index. More... | |
virtual Real | GetSystemFontSizeFactor (UInt32 index) const =0 |
Get the size factor of the user-defined system font at a given index. More... | |
virtual Real | GetSystemFontAscent (UInt32 index) const =0 |
Get the ascent of the user-defined system font at a given index. More... | |
virtual Real | GetSystemFontDescent (UInt32 index) const =0 |
Get the descent of the user-defined system font at a given index. More... | |
virtual Real | GetSystemFontLeading (UInt32 index) const =0 |
Get the leading value of the user-defined system font at a given index. More... | |
virtual void | SetVirtualMouseEnable (Bool isEnabled)=0 |
Enable the virtual mouse device. More... | |
virtual Bool | IsVirtualMouseEnabled () const =0 |
Check if the virtual mouse device is enabled. More... | |
virtual void | SetVirtualRawMouseEnable (Bool isEnabled)=0 |
Enable the virtual raw-mouse device. More... | |
virtual Bool | IsVirtualRawMouseEnabled () const =0 |
Check if the virtual raw-mouse device is enabled. More... | |
virtual void | SetCloudControlEnable (Bool isEnabled)=0 |
Enable the cloud control. More... | |
virtual Bool | IsCloudControlEnabled () const =0 |
Check if the cloud control is enabled. More... | |
|
pure virtual |
Get the const platform configuration object.
|
pure virtual |
Get the const application configuration object.
|
pure virtual |
Get the application configuration object.
|
pure virtual |
Check is any configuration setting has changed.
inspector | The change inspector. |
|
pure virtual |
Get the mutable set of default graph parameters.
Use the returned object in the IApp::Configure() method to add any custom parameters to be used in attribute evaluation during the creation of a scene (sub-)graph.
|
pure virtual |
Get the constant set of default graph parameters.
|
pure virtual |
Get the feature set object.
|
pure virtual |
Get the const feature set object.
|
pure virtual |
Get the major revision of the engine.
|
pure virtual |
Get the minor revision of the engine.
|
pure virtual |
Get the build number of the engine.
|
pure virtual |
Get the release state string of the engine.
|
pure virtual |
Get the version string of the engine.
|
pure virtual |
Get the copyright string of the engine.
|
pure virtual |
Set the licence key data.
key | The licence key data. |
|
pure virtual |
Get the licence key data object.
|
pure virtual |
Set the log file name.
If the log file name is set, all MURL_TRACE, MURL_ERROR and MURL_ASSERT messages are written into the file.
The default log file name is empty.
logFileName | The log file name, see also SetLogFileFullPath(). |
|
pure virtual |
Get the log file name.
|
pure virtual |
Set the log file full path.
logFilePath | The log file full path, see also SetLogFileName(). |
|
pure virtual |
Get the log file full path.
|
pure virtual |
Set the engine's run loop mode.
runLoopMode | The run loop mode. |
|
pure virtual |
Get the engine's run loop mode.
|
pure virtual |
Set the boot time.
time | The boot time in number of seconds since 00:00 hours, Jan 1, 1970 UTC. |
|
pure virtual |
Get the boot time.
|
pure virtual |
Check if the boot time has changed.
inspector | The change inspector. |
|
pure virtual |
Set the product name.
The product name is used to create a subfolder for IEnums::FILE_CATEGORY_CACHE, IEnums::FILE_CATEGORY_PRIVATE, and IEnums::FILE_CATEGORY_TEMPORARY except on iOS.
The OSX platform uses the product name to replace "%@" in all interface builder's menu items.
On OSX and iOS the product name is set to the kCFBundleExecutableKey identifier.
On Android the product name is set to the application android:label from the manifest.
On Win32 the product name is set to the "ProductName" from version info resource.
productName | The product name. |
|
pure virtual |
Get the product name.
|
pure virtual |
Check if the product name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the app version name.
On OSX and iOS the app version name is set to the kCFBundleVersionKey identifier.
On Android the app version name is set to the android:versionName from the manifest.
On Win32 the app version name is set to the "ProductVersion" from version info resource.
versionName | The app version name. |
|
pure virtual |
Get the app version name.
|
pure virtual |
Check if the app version name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the audio session category.
Setting the audio session category effects the IMusicPlayerControl only.
If IEnums::AUDIO_SESSION_CATEGORY_MIX_AMBIENT_IF_PLAYING is set, the system's audio session is set to mix ambient if another audio is playing otherwise the system's audio session is not set (default category behaviour). After IApp::Configure() the IMusicPlayerControl::GetPlaybackState() returns IMusicPlayerControl::PLAYBACK_PLAYING if another audio was playing at app start until a IMusicPlayerControl::MusicPlayer is selected.
The default audio session category is IEnums::AUDIO_SESSION_CATEGORY_DEFAULT.
sessionCategory | The audio session category. |
|
pure virtual |
Get the audio session category.
The IMusicPlayerControl does not change this item.
|
pure virtual |
Check if the audio session category has changed.
inspector | The change inspector. |
|
pure virtual |
Set the video api enumeration value.
Typically the platform implementaition sets this to an appropriate value, see also SetVideoRendererClassName().
The default video api is IEnums::VIDEO_API_DEFAULT.
videoApi | The video api enumeration value. |
|
pure virtual |
Get the video api enumeration value.
|
pure virtual |
Check if the video api is matching a specified value.
videoApi | The video api enumeration value. |
|
pure virtual |
Check if the video api enumeration value has changed.
inspector | The change inspector. |
|
pure virtual |
Set the audio api enumeration value.
Typically the platform implementaition sets this to an appropriate value, see also SetAudioRendererClassName().
The default audio api is IEnums::AUDIO_API_DEFAULT.
audioApi | The audio api enumeration value. |
|
pure virtual |
Get the audio api enumeration value.
|
pure virtual |
Check if the audio api is matching a specified value.
audioApi | The audio api enumeration value. |
|
pure virtual |
Check if the audio api enumeration value has changed.
inspector | The change inspector. |
|
pure virtual |
Set the video renderer class name.
If the video renderer class name is empty the engine creates a renderer depending on the value set by SetVideoApi().
The default video renderer class name is empty.
className | The video renderer class name. |
|
pure virtual |
Get the video renderer class name.
|
pure virtual |
Check if the video renderer class name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the audio renderer class name.
If the audio renderer class name is empty the engine creates a renderer depending on the value set by SetAudioApi().
The default audio renderer class name is empty.
className | The audio renderer class name. |
|
pure virtual |
Get the audio renderer class name.
|
pure virtual |
Check if the audio renderer class name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the physics simulator class name.
If the physics simulator class name is empty the engine creates the built-in simulator.
The default physics simulator class name is empty.
className | The physics simulator class name. |
|
pure virtual |
Get the physics simulator class name.
|
pure virtual |
Check if the physics simulator class name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the resource collection class name.
If the resource collection class name is empty the engine creates the built-in collection.
The default resource collection class name is empty.
className | The resource collection class name. |
|
pure virtual |
Get the resource collection class name.
|
pure virtual |
Check if the resource collection class name has changed.
inspector | The change inspector. |
|
pure virtual |
Set the preferred resource package type.
When a package is added to the loader in the App::Init() method without explicitly specifying a file suffix (.murlres/.murlpkg), the resource system loads the first appropriate package found in the folder specified by SetResourceFileCategory(); usually, this will be a .murlpkg file if present. During development it may be convenient to directly work from .murlres packages, so one does not need to run the resource packer tool every time the application is started. For this reason, this method can be used to manually specify a different preferred package type. By default, release builds on all platforms use the IEnums::PACKAGE_TYPE_NATIVE type, and IEnums::PACKAGE_TYPE_XML is used for debug builds on all available platforms except Android (where only native packages are supported). If a file suffix is specified, this setting has no effect.
type | The preferred resource package type. |
|
pure virtual |
Get the preferred resource package type.
|
pure virtual |
Check if the preferred resource package type has changed.
inspector | The change inspector. |
|
pure virtual |
Set the resource file category.
The category specifies the working directory of the package loader. On desktop platforms the category is set to Murl::IEnums::FILE_CATEGORY_CURRENT in debug build, which allows easier development.
The default resource file category is IEnums::FILE_CATEGORY_RESOURCE.
category | The resource file category. |
|
pure virtual |
Get the resource file category.
|
pure virtual |
Check if the resource file category has changed.
inspector | The change inspector. |
|
pure virtual |
Set the deactivated application run state.
Depending on this setting the platform implementation decides how to set the IAppConfiguration::SetAppRunState() if the application is activated or deactivated.
The application is deactivated:
The default deactivated application run state is IEnums::APP_RUN_STATE_DEFAULT which performs no action.
appRunState | The deactivated application run state. |
|
pure virtual |
Get the deactivated application run state.
|
pure virtual |
Check if the deactivated application run state has changed.
inspector | The change inspector. |
|
pure virtual |
Set the suspend unloads resources flag.
If the suspend unloads resources flag is true the engine unloads all resource types specified by SetSuspendableResources() if the IAppConfiguration::SetAppRunState() is set to IEnums::APP_RUN_STATE_SUSPENDED.
The default suspend unloads resources flag is false.
unload | The suspend unloads resources flag. |
|
pure virtual |
Get the suspend unloads resources flag.
|
pure virtual |
Check if the suspend unloads resources flag has changed.
inspector | The change inspector. |
|
pure virtual |
Set the suspendable resources type.
See also SetSuspendUnloadsResources().
The default suspendable resources value is IEnums::SUSPENDABLE_RESOURCE_ALL.
suspendableResources | The suspendable resources type. |
|
pure virtual |
Get the suspendable resources type.
|
pure virtual |
Check if the suspendable resources type has changed.
inspector | The change inspector. |
Set the global unit size factor.
The global unit size factor is multiplied to the camera's unit size.
The default global unit size factor is 1.0.
sizeX | The horizontal unit size factor. |
sizeY | The vertical unit size factor. |
|
pure virtual |
Get the horizontal unit size factor.
|
pure virtual |
Get the vertical unit size factor.
|
pure virtual |
Check if the global unit size factor has changed.
inspector | The change inspector. |
Set the pixel center position.
The pixel center position is used by the camera, the range is [0 .. 1]. The pixel center is typically determined by the platform implementation depending on the graphic driver's properties.
The default pixel center position is 0 / 0.
centerX | The horizontal pixel center position. |
centerY | The vertical pixel center position. |
|
pure virtual |
Get the horizontal pixel center position.
|
pure virtual |
Get the vertical pixel center position.
|
pure virtual |
Check if the global pixel center position has changed.
inspector | The change inspector. |
|
pure virtual |
Set the synchronous resource initialization timeout.
Is used only if SetAsyncLoadingEnabled() is set to false. The timeout specifies the maximum time to use for initializing multiple graphic objects before the next frame is rendered. At least one object is initialized each frame which can take more time than the timeout depending on the complexity of the object.
The default timeout is 0.005 seconds.
timeout | The loading timeout in seconds. |
|
pure virtual |
Get the synchronous resource initialization timeout.
|
pure virtual |
Check if the synchronous resource initialization timeout has changed.
inspector | The change inspector. |
|
pure virtual |
Enable asynchronous resource initialization after loading.
Setup how to initialize loaded graphic objects:
This feature is typically determined by the platform implementation depending on the graphic driver's capabilities.
The default value is true.
enabled | true to enable. |
|
pure virtual |
Check if the asynchronous loading is enabled.
|
pure virtual |
Check if the asynchronous loading setting has changed.
inspector | The change inspector. |
|
pure virtual |
Enable synchronous vertical blank page flipping.
The platform implementation is using this setting to enable vertical blank page flipping depending on the graphic driver capabilities.
The default value is true.
enabled | true to enable. |
|
pure virtual |
Check if the synchronous vertical blank page flipping is enabled.
|
pure virtual |
Check if the synchronous vertical blank page flipping setting has changed.
inspector | The change inspector. |
|
pure virtual |
Enable checks to video api calls.
Api checks are used for development purposes and are available in debug build only.
The default value is false.
enabled | true to enable. |
|
pure virtual |
Check if the video api check feature is enabled.
|
pure virtual |
Check if the video api check setting has changed.
inspector | The change inspector. |
|
pure virtual |
Enable checks to audio api calls.
Api checks are used for development purposes and are available in debug build only.
The default value is false.
enabled | true to enable. |
|
pure virtual |
Check if the audio api check feature is enabled.
|
pure virtual |
Check if the audio api check setting has changed.
inspector | The change inspector. |
|
pure virtual |
Set the number of antialiasing samples.
The platform implementation is using this setting depending on the graphic driver capabilities.
The default value is 1.
numSamples | The number of antialiasing samples. |
|
pure virtual |
Get the number of antialiasing samples.
|
pure virtual |
Check if the number of antialiasing samples has changed.
inspector | The change inspector. |
|
pure virtual |
Set the default maximum texture anisotropy for filtering.
This value specifies the preferred maximum anisotropy used for texture filtering if not specified for a given texture. The actual value is clamped to hardware-specific limits. Higher values produce better visual results, but may result in degraded rendering performance. The default value is 1.0, i.e. isotropic filtering (fastest). The maximum anisotropy value supported by the hardware is typically around 16.0.
maxAnisotropy | The default maximum texture filtering anisotropy. |
|
pure virtual |
Get the default maximum texture anisotropy for filtering.
|
pure virtual |
Check if the default maximum texture anisotropy has changed.
inspector | The change inspector. |
|
pure virtual |
Set the texture prescale divisor.
The texture prescale divisor is used to shrink textures before loading to the graphics memory. This allows reducing of memory usage on small equipped platforms.
The default texture prescale divisor is 1.
divisor | The texture prescale divisor. |
|
pure virtual |
Get the texture prescale divisor.
|
pure virtual |
Check if the texture prescale divisor matching a specified value.
divisor | The divisor value to check. |
|
pure virtual |
Check if the texture prescale divisor has changed.
inspector | The change inspector. |
|
pure virtual |
Set the exact logic tick duration.
Set the duration bounds to the same value, see SetBoundsForLogicTickDuration().
dt | The exact logic tick duration in seconds. |
|
pure virtual |
Set the logic tick duration bounds.
The logic tick duration allows exact tick cycles for e.g. physics simulation.
If the bounds have the same value, the SetBoundsForLogicTicksPerFrame() should be set to an appropriate range.
The default value is (0, 1).
dtMin | The minimum logic tick duration in seconds. |
dtMax | The maximum logic tick duration in seconds. |
|
pure virtual |
Get minimum logic tick duration in seconds.
|
pure virtual |
Get maximum logic tick duration in seconds.
|
pure virtual |
Check if the logic tick duration setting has changed.
inspector | The change inspector. |
|
pure virtual |
Set the exact number of logic ticks per frame.
Set the per frame bounds to the same value, see SetBoundsForLogicTicksPerFrame().
numTicks | The exact number of logic ticks per frame. |
|
pure virtual |
Set the number of logic ticks per frame bounds.
If the bounds have the same value, the SetBoundsForLogicTickDuration() should be set to an appropriate range.
The default value is (1, 1).
numTicksMin | The minimum number of logic logic ticks per frame. |
numTicksMax | The maximum number of logic logic ticks per frame. |
|
pure virtual |
Get minimum number of logic logic ticks per frame.
|
pure virtual |
Get maximum number of logic logic ticks per frame.
|
pure virtual |
Check if the number of logic logic ticks per frame setting has changed.
inspector | The change inspector. |
|
pure virtual |
Add a user-defined system font.
This method can be used to define additional platform-specific system fonts used in conjunction with a Graph::IFlatTextTexture. If user-defined system fonts are required, this method must be called with different values for the "fontName" parameter depending on the platform. In addition, some platforms accept a "Bold" identifier as part of the font name, e.g. "Helvetica-Bold" on iOS and OSX. In this case, the weight parameter is ignored. On other platforms, it is required to specify the boldness of the font via the "weight" parameter (usually 400 for regular thickness and 800 for bold fonts), and only specify the font name without style.
fontId | The unique font ID within the Murl Engine. |
fontName | The font name, as expected by the operating system. |
weight | The font weight (default 400), if supported by the operating system. |
sizeFactor | The scale factor to apply (default 1.0). |
ascent | The font ascent, i.e. height above the base line. Ascent and descent should sum up to 1.0. |
descent | The font descent. |
leading | The font leading, i.e. additional space between consecutive text lines. |
|
pure virtual |
Get the number of user-defined system fonts.
|
pure virtual |
Get the internal ID of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
|
pure virtual |
Get the OS-specific name of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
Get the weight of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
Get the size factor of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
Get the ascent of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
Get the descent of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
Get the leading value of the user-defined system font at a given index.
index | The index of the font, in the range from 0 to GetNumberOfSystemFonts()-1. |
|
pure virtual |
Enable the virtual mouse device.
A virtual mouse is available on AppleTV Siri Remote device. The default value is true on AppleTV, otherwise false.
isEnabled | The enabled state. |
|
pure virtual |
Check if the virtual mouse device is enabled.
|
pure virtual |
Enable the virtual raw-mouse device.
A virtual raw-mouse is available on AppleTV Siri Remote device. The default value is true on AppleTV, otherwise false.
isEnabled | The enabled state. |
|
pure virtual |
Check if the virtual raw-mouse device is enabled.
|
pure virtual |
Enable the cloud control.
The cloud control is available on iOS/OSX/tvOS. The default value is false, if enabled an iCloud entitlement must be setup for the application,
isEnabled | The enabled state. |
|
pure virtual |
Check if the cloud control is enabled.