The platform configuration interface defines the immutable platform-specific settings. More...
#include "murl_i_platform_configuration.h"
Inherited by Murl::Util::PlatformConfiguration.
Public Member Functions | |
virtual const IEngineConfiguration * | GetEngineConfiguration () const =0 |
Get the const engine configuration object. More... | |
virtual const IAppConfiguration * | GetAppConfiguration () const =0 |
Get the const application configuration object. More... | |
virtual IEngineConfiguration * | GetEngineConfiguration ()=0 |
Get the engine configuration object. More... | |
virtual IAppConfiguration * | GetAppConfiguration ()=0 |
Get the application configuration object. More... | |
virtual void | SetLaunchArguments (const StringArray &arguments)=0 |
Set the application's launch arguments, if existing. More... | |
virtual const StringArray & | GetLaunchArguments () const =0 |
Get the application's launch arguments. More... | |
virtual void | SetUniqueDeviceId (const String &id)=0 |
Set the unique device identifier string. More... | |
virtual const String & | GetUniqueDeviceId () const =0 |
Get the unique device identifier string. More... | |
virtual void | SetUniqueInstallId (const String &id)=0 |
Set the unique install identifier string. More... | |
virtual const String & | GetUniqueInstallId () const =0 |
Get the unique install identifier string. More... | |
virtual void | SetCountryCode (const String &code)=0 |
Set the country code string. More... | |
virtual const String & | GetCountryCode () const =0 |
Get the country code string. More... | |
virtual void | SetTargetManufacturerName (const String &name)=0 |
Set the manufacturer name. More... | |
virtual const String & | GetTargetManufacturerName () const =0 |
Get the manufacturer name. More... | |
virtual void | SetTargetDeviceName (const String &name)=0 |
Set the target device name. More... | |
virtual const String & | GetTargetDeviceName () const =0 |
Get the target device name. More... | |
virtual void | SetTargetModelName (const String &name)=0 |
Set the target model name. More... | |
virtual const String & | GetTargetModelName () const =0 |
Get the target model name. More... | |
virtual void | SetTargetProductName (const String &name)=0 |
Set the target product name. More... | |
virtual const String & | GetTargetProductName () const =0 |
Get the target product name. More... | |
virtual void | SetSystemVersionName (const String &name)=0 |
Set the system version name. More... | |
virtual const String & | GetSystemVersionName () const =0 |
Get the system version name. More... | |
virtual void | SetTargetClass (IEnums::TargetClass targetClass)=0 |
Set the target class enumeration value. More... | |
virtual IEnums::TargetClass | GetTargetClass () const =0 |
Get the target class enumeration value. More... | |
virtual Bool | IsTargetClassMatching (IEnums::TargetClass targetClass) const =0 |
Check if the target class is matching a specified value. More... | |
virtual void | SetTargetDevice (IEnums::TargetDevice targetDevice)=0 |
Set the target device enumeration value. More... | |
virtual IEnums::TargetDevice | GetTargetDevice () const =0 |
Get the target device enumeration value. More... | |
virtual Bool | IsTargetDeviceMatching (IEnums::TargetDevice targetDevice) const =0 |
Check if the target device is matching a specified value. More... | |
virtual void | SetTargetHost (IEnums::TargetHost targetHost)=0 |
Set the target host enumeration value. More... | |
virtual IEnums::TargetHost | GetTargetHost () const =0 |
Get the target host enumeration value. More... | |
virtual Bool | IsTargetHostMatching (IEnums::TargetHost targetHost) const =0 |
Check if the target host is matching a specified value. More... | |
virtual void | SetOperatingSystem (IEnums::OperatingSystem operatingSystem)=0 |
Set the operating system enumeration value. More... | |
virtual IEnums::OperatingSystem | GetOperatingSystem () const =0 |
Get the operating system enumeration value. More... | |
virtual Bool | IsOperatingSystemMatching (IEnums::OperatingSystem operatingSystem) const =0 |
Check if the operating system is matching a specified value. More... | |
virtual void | SetGpu (IEnums::Gpu gpu)=0 |
Set the graphics processing unit enumeration value. More... | |
virtual IEnums::Gpu | GetGpu () const =0 |
Get the graphics processing unit enumeration value. More... | |
virtual Bool | IsGpuMatching (IEnums::Gpu gpu) const =0 |
Check if the graphics processing unit is matching a specified value. More... | |
virtual void | SetNumberOfBackBufferColorBits (UInt32 numRedBits, UInt32 numGreenBits, UInt32 numBlueBits, UInt32 numAlphaBits)=0 |
Set the back buffer's bit depths for a single color value. More... | |
virtual UInt32 | GetNumberOfBackBufferRedBits () const =0 |
Get the back buffer's bit depth for the red component. More... | |
virtual UInt32 | GetNumberOfBackBufferGreenBits () const =0 |
Get the back buffer's bit depth for the green component. More... | |
virtual UInt32 | GetNumberOfBackBufferBlueBits () const =0 |
Get the back buffer's bit depth for the blue component. More... | |
virtual UInt32 | GetNumberOfBackBufferAlphaBits () const =0 |
Get the back buffer's bit depth for the alpha component. More... | |
virtual void | SetNumberOfBackBufferDepthBits (UInt32 numDepthBits)=0 |
Set the back buffer's depth buffer bit depth. More... | |
virtual UInt32 | GetNumberOfBackBufferDepthBits () const =0 |
Get the back buffer's depth buffer bit depth. More... | |
virtual void | SetNumberOfBackBufferStencilBits (UInt32 numStencilBits)=0 |
Set the back buffer's stencil buffer bit depth. More... | |
virtual UInt32 | GetNumberOfBackBufferStencilBits () const =0 |
Get the back buffer's stencil buffer bit depth. More... | |
virtual void | SetPhysicalScreenSize (Real mmSizeX, Real mmSizeY)=0 |
Set the physical screen size. More... | |
virtual Real | GetPhysicalScreenSizeX () const =0 |
Get the physical screen width. More... | |
virtual Real | GetPhysicalScreenSizeY () const =0 |
Get the physical screen height. More... | |
virtual void | SetPhysicalPixelSize (Real mmSizeX, Real mmSizeY)=0 |
Set the physical pixel size. More... | |
virtual Real | GetPhysicalPixelSizeX () const =0 |
Get the physical pixel width. More... | |
virtual Real | GetPhysicalPixelSizeY () const =0 |
Get the physical pixel height. More... | |
virtual void | SetPixelScaleFactor (Real sizeXFactor, Real sizeYFactor)=0 |
Set the pixel scale factor. More... | |
virtual Real | GetPixelScaleFactorX () const =0 |
Set the pixel width scale factor. More... | |
virtual Real | GetPixelScaleFactorY () const =0 |
Set the pixel height scale factor. More... | |
virtual Real | GetNumberOfPixelsFromSizeX (Real sizeValue, IEnums::LengthMeasure unit) const =0 |
Get the number of pixels from a specified width and unit. More... | |
virtual Real | GetNumberOfPixelsFromSizeY (Real sizeValue, IEnums::LengthMeasure unit) const =0 |
Get the number of pixels from a specified height and unit. More... | |
virtual Real | GetSizeXFromNumberOfPixels (Real numberOfPixels, IEnums::LengthMeasure unit) const =0 |
Get the width in a specified unit from a specified number of pixels. More... | |
virtual Real | GetSizeYFromNumberOfPixels (Real numberOfPixels, IEnums::LengthMeasure unit) const =0 |
Get the height in a specified unit from a specified number of pixels. More... | |
virtual void | SetInAppBillingProviderName (const String &name)=0 |
Set the name of the In-App Billing provider. More... | |
virtual const String & | GetInAppBillingProviderName () const =0 |
Get the In-App Billing provider name. More... | |
virtual void | SetMultithreadingSupported (Bool supported)=0 |
Enable/disable multithreading support. More... | |
virtual Bool | IsMultithreadingSupported () const =0 |
Check if multithreading is supported. More... | |
Detailed Description
The platform configuration interface defines the immutable platform-specific settings.
Member Function Documentation
◆ GetEngineConfiguration() [1/2]
|
pure virtual |
Get the const engine configuration object.
- Returns
- The engine configuration object.
◆ GetAppConfiguration() [1/2]
|
pure virtual |
Get the const application configuration object.
- Returns
- The application configuration object.
◆ GetEngineConfiguration() [2/2]
|
pure virtual |
Get the engine configuration object.
- Returns
- The engine configuration object.
◆ GetAppConfiguration() [2/2]
|
pure virtual |
Get the application configuration object.
- Returns
- The application configuration object.
◆ SetLaunchArguments()
|
pure virtual |
Set the application's launch arguments, if existing.
When supported by the specific platform, the first argument in the list represents the path and file name to the application executable itself, followed by individual optional strings for each argument given at launch.
- Parameters
-
arguments A string array containing all launch arguments.
◆ GetLaunchArguments()
|
pure virtual |
Get the application's launch arguments.
On platforms that do not support launch arguments, this simply returns an empty array.
- Returns
- A constant string array containing all launch arguments.
◆ SetUniqueDeviceId()
|
pure virtual |
Set the unique device identifier string.
Removes all '-' characters from the identifier string.
- Parameters
-
id The unique device identifier string.
◆ GetUniqueDeviceId()
|
pure virtual |
Get the unique device identifier string.
On multi user platforms each user gets an own unique identifier.
- Returns
- The unique device identifier string or 32 x '0' characters if not set by the platform implementation.
◆ SetUniqueInstallId()
|
pure virtual |
Set the unique install identifier string.
Removes all '-' characters from the identifier string.
- Parameters
-
id The unique install identifier string.
◆ GetUniqueInstallId()
|
pure virtual |
Get the unique install identifier string.
On multi user platforms each user gets an own unique identifier.
- Returns
- The unique install identifier string or 32 x '0' characters if not set by the platform implementation.
◆ SetCountryCode()
|
pure virtual |
Set the country code string.
- Parameters
-
code The country code string.
◆ GetCountryCode()
|
pure virtual |
Get the country code string.
The country code string is provided in the ISO 3166-1-alpha-2 code.
- Returns
- The country code string or "??" if not set by the platform implementation.
◆ SetTargetManufacturerName()
|
pure virtual |
Set the manufacturer name.
- Parameters
-
name The manufacturer name.
◆ GetTargetManufacturerName()
|
pure virtual |
Get the manufacturer name.
- Returns
- The manufacturer name or "N/A" if not set by the platform implementation.
◆ SetTargetDeviceName()
|
pure virtual |
Set the target device name.
- Parameters
-
name The target device name.
◆ GetTargetDeviceName()
|
pure virtual |
Get the target device name.
- Returns
- THe target device name or "N/A" if not set by the platform implementation.
◆ SetTargetModelName()
|
pure virtual |
Set the target model name.
- Parameters
-
name The target model name.
◆ GetTargetModelName()
|
pure virtual |
Get the target model name.
- Returns
- The target model name or "N/A" if not set by the platform implementation.
◆ SetTargetProductName()
|
pure virtual |
Set the target product name.
- Parameters
-
name The target product name.
◆ GetTargetProductName()
|
pure virtual |
Get the target product name.
- Returns
- The target product name or "N/A" if not set by the platform implementation.
◆ SetSystemVersionName()
|
pure virtual |
Set the system version name.
- Parameters
-
name The system version name.
◆ GetSystemVersionName()
|
pure virtual |
Get the system version name.
- Returns
- The system version name or "N/A" if not set by the platform implementation.
◆ SetTargetClass()
|
pure virtual |
Set the target class enumeration value.
- Parameters
-
targetClass The target class enumeration value.
◆ GetTargetClass()
|
pure virtual |
Get the target class enumeration value.
- Returns
- The target class enumeration value or IEnums::TARGET_CLASS_DEFAULT if not set by the platform implementation.
◆ IsTargetClassMatching()
|
pure virtual |
Check if the target class is matching a specified value.
- Parameters
-
targetClass The target class enumeration value.
- Returns
- true if the target class is matching the parameter value.
◆ SetTargetDevice()
|
pure virtual |
Set the target device enumeration value.
- Parameters
-
targetDevice The target device enumeration value.
◆ GetTargetDevice()
|
pure virtual |
Get the target device enumeration value.
- Returns
- The target device enumeration value or IEnums::TARGET_DEVICE_DEFAULT if not set by the platform implementation.
◆ IsTargetDeviceMatching()
|
pure virtual |
Check if the target device is matching a specified value.
- Parameters
-
targetDevice The target device enumeration value.
- Returns
- true if the target device is matching the parameter value.
◆ SetTargetHost()
|
pure virtual |
Set the target host enumeration value.
- Parameters
-
targetHost The target host enumeration value.
◆ GetTargetHost()
|
pure virtual |
Get the target host enumeration value.
- Returns
- The target host enumeration value or IEnums::TARGET_HOST_DEFAULT if not set by the platform implementation.
◆ IsTargetHostMatching()
|
pure virtual |
Check if the target host is matching a specified value.
- Parameters
-
targetHost The target host enumeration value.
- Returns
- true if the target host is matching the parameter value.
◆ SetOperatingSystem()
|
pure virtual |
Set the operating system enumeration value.
- Parameters
-
operatingSystem The operating system enumeration value.
◆ GetOperatingSystem()
|
pure virtual |
Get the operating system enumeration value.
- Returns
- The operating system enumeration value or IEnums::OPERATING_SYSTEM_DEFAULT if not set by the platform implementation.
◆ IsOperatingSystemMatching()
|
pure virtual |
Check if the operating system is matching a specified value.
- Parameters
-
operatingSystem The operating system enumeration value.
- Returns
- true if the operating system is matching the parameter value.
◆ SetGpu()
|
pure virtual |
Set the graphics processing unit enumeration value.
- Parameters
-
gpu The graphics processing unit enumeration value.
◆ GetGpu()
|
pure virtual |
Get the graphics processing unit enumeration value.
- Returns
- The graphics processing unit enumeration value or IEnums::GPU_DEFAULT if not set by the platform implementation.
◆ IsGpuMatching()
|
pure virtual |
Check if the graphics processing unit is matching a specified value.
- Parameters
-
gpu The graphics processing unit enumeration value.
- Returns
- true if the graphics processing unit is matching the parameter value.
◆ SetNumberOfBackBufferColorBits()
|
pure virtual |
Set the back buffer's bit depths for a single color value.
- Parameters
-
numRedBits The number of bits for the red component. numGreenBits The number of bits for the green component. numBlueBits The number of bits for the blue component. numAlphaBits The number of bits for the alpha component.
◆ GetNumberOfBackBufferRedBits()
|
pure virtual |
Get the back buffer's bit depth for the red component.
- Returns
- The bit depth.
◆ GetNumberOfBackBufferGreenBits()
|
pure virtual |
Get the back buffer's bit depth for the green component.
- Returns
- The bit depth.
◆ GetNumberOfBackBufferBlueBits()
|
pure virtual |
Get the back buffer's bit depth for the blue component.
- Returns
- The bit depth.
◆ GetNumberOfBackBufferAlphaBits()
|
pure virtual |
Get the back buffer's bit depth for the alpha component.
- Returns
- The bit depth.
◆ SetNumberOfBackBufferDepthBits()
|
pure virtual |
Set the back buffer's depth buffer bit depth.
- Parameters
-
numDepthBits The number of bits for a single depth buffer fragment.
◆ GetNumberOfBackBufferDepthBits()
|
pure virtual |
Get the back buffer's depth buffer bit depth.
- Returns
- The number of bits for a single depth buffer fragment.
◆ SetNumberOfBackBufferStencilBits()
|
pure virtual |
Set the back buffer's stencil buffer bit depth.
- Parameters
-
numStencilBits The number of bits for a single stencil buffer fragment.
◆ GetNumberOfBackBufferStencilBits()
|
pure virtual |
Get the back buffer's stencil buffer bit depth.
- Returns
- The number of bits for a single stencil buffer fragment.
◆ SetPhysicalScreenSize()
|
pure virtual |
Set the physical screen size.
- Parameters
-
mmSizeX The screen width in millimeters. mmSizeY The screen height in millimeters.
◆ GetPhysicalScreenSizeX()
|
pure virtual |
Get the physical screen width.
- Returns
- The physical screen width in millimeters or (1680 pixels x (25.4 mm / 96 dpi)) if not set by the platform implementation.
◆ GetPhysicalScreenSizeY()
|
pure virtual |
Get the physical screen height.
- Returns
- The physical screen height in millimeters or (1050 pixels x (25.4 mm / 96 dpi)) if not set by the platform implementation.
◆ SetPhysicalPixelSize()
|
pure virtual |
Set the physical pixel size.
- Parameters
-
mmSizeX The pixel width in millimeters. mmSizeY The pixel height in millimeters.
◆ GetPhysicalPixelSizeX()
|
pure virtual |
Get the physical pixel width.
- Returns
- The physical pixel width in millimeters or (25.4 mm / 96 dpi) if not set by the platform implementation.
◆ GetPhysicalPixelSizeY()
|
pure virtual |
Get the physical pixel height.
- Returns
- The physical pixel height in millimeters or (25.4 mm / 96 dpi) if not set by the platform implementation.
◆ SetPixelScaleFactor()
|
pure virtual |
Set the pixel scale factor.
- Parameters
-
sizeXFactor The pixel width scale factor. sizeYFactor The pixel height scale factor.
◆ GetPixelScaleFactorX()
|
pure virtual |
Set the pixel width scale factor.
- Returns
- The pixel width scale factor or 1.0 if not set by the platform implementation.
◆ GetPixelScaleFactorY()
|
pure virtual |
Set the pixel height scale factor.
- Returns
- The pixel height scale factor or 1.0 if not set by the platform implementation.
◆ GetNumberOfPixelsFromSizeX()
|
pure virtual |
Get the number of pixels from a specified width and unit.
- Parameters
-
sizeValue The width value. unit The unit enumeration value.
- Returns
- The number of pixels from the specified width and unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.
◆ GetNumberOfPixelsFromSizeY()
|
pure virtual |
Get the number of pixels from a specified height and unit.
- Parameters
-
sizeValue The height value. unit The unit enumeration value.
- Returns
- The number of pixels from the specified height and unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.
◆ GetSizeXFromNumberOfPixels()
|
pure virtual |
Get the width in a specified unit from a specified number of pixels.
- Parameters
-
numberOfPixels The number of pixels value. unit The unit enumeration value.
- Returns
- The width in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.
◆ GetSizeYFromNumberOfPixels()
|
pure virtual |
Get the height in a specified unit from a specified number of pixels.
- Parameters
-
numberOfPixels The number of pixels value. unit The unit enumeration value.
- Returns
- The height in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.
◆ SetInAppBillingProviderName()
|
pure virtual |
Set the name of the In-App Billing provider.
- Parameters
-
name The IAB provider name.
◆ GetInAppBillingProviderName()
|
pure virtual |
Get the In-App Billing provider name.
- "N/A" if the provider name has not been set
- "none" if In-App Billing is not supported
- "apple-ios" for Apple iOS In-App Purchasing
- "apple-osx" for Apple OSX In-App Purchasing
- "google" for Google Play In-App Billing
- "amazon" for Amazon In-App Purchasing
- "samsung" for Samsung In-App Purchasing
- "ouya" for OUYA In-App Purchasing
- Returns
- The In-App Billing provider name or "N/A" if not set by the platform implementation.
◆ SetMultithreadingSupported()
|
pure virtual |
Enable/disable multithreading support.
- Parameters
-
supported If true, multithreading is supported.
◆ IsMultithreadingSupported()
|
pure virtual |
Check if multithreading is supported.
- Returns
- true if supported
The documentation for this interface was generated from the following file:
- murl_i_platform_configuration.h