Murl::IPlatformConfiguration Interface Referenceabstract

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 IEngineConfigurationGetEngineConfiguration () const =0
 Get the const engine configuration object. More...
 
virtual const IAppConfigurationGetAppConfiguration () const =0
 Get the const application configuration object. More...
 
virtual IEngineConfigurationGetEngineConfiguration ()=0
 Get the engine configuration object. More...
 
virtual IAppConfigurationGetAppConfiguration ()=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 StringArrayGetLaunchArguments () 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 StringGetUniqueDeviceId () 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 StringGetUniqueInstallId () const =0
 Get the unique install identifier string. More...
 
virtual void SetCountryCode (const String &code)=0
 Set the country code string. More...
 
virtual const StringGetCountryCode () const =0
 Get the country code string. More...
 
virtual void SetTargetManufacturerName (const String &name)=0
 Set the manufacturer name. More...
 
virtual const StringGetTargetManufacturerName () const =0
 Get the manufacturer name. More...
 
virtual void SetTargetDeviceName (const String &name)=0
 Set the target device name. More...
 
virtual const StringGetTargetDeviceName () const =0
 Get the target device name. More...
 
virtual void SetTargetModelName (const String &name)=0
 Set the target model name. More...
 
virtual const StringGetTargetModelName () const =0
 Get the target model name. More...
 
virtual void SetTargetProductName (const String &name)=0
 Set the target product name. More...
 
virtual const StringGetTargetProductName () const =0
 Get the target product name. More...
 
virtual void SetSystemVersionName (const String &name)=0
 Set the system version name. More...
 
virtual const StringGetSystemVersionName () 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 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 StringGetInAppBillingProviderName () 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]

virtual const IEngineConfiguration* Murl::IPlatformConfiguration::GetEngineConfiguration ( ) const
pure virtual

Get the const engine configuration object.

Returns
The engine configuration object.

◆ GetAppConfiguration() [1/2]

virtual const IAppConfiguration* Murl::IPlatformConfiguration::GetAppConfiguration ( ) const
pure virtual

Get the const application configuration object.

Returns
The application configuration object.

◆ GetEngineConfiguration() [2/2]

virtual IEngineConfiguration* Murl::IPlatformConfiguration::GetEngineConfiguration ( )
pure virtual

Get the engine configuration object.

Returns
The engine configuration object.

◆ GetAppConfiguration() [2/2]

virtual IAppConfiguration* Murl::IPlatformConfiguration::GetAppConfiguration ( )
pure virtual

Get the application configuration object.

Returns
The application configuration object.

◆ SetLaunchArguments()

virtual void Murl::IPlatformConfiguration::SetLaunchArguments ( const StringArray arguments)
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
argumentsA string array containing all launch arguments.

◆ GetLaunchArguments()

virtual const StringArray& Murl::IPlatformConfiguration::GetLaunchArguments ( ) const
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()

virtual void Murl::IPlatformConfiguration::SetUniqueDeviceId ( const String id)
pure virtual

Set the unique device identifier string.

Removes all '-' characters from the identifier string.

Parameters
idThe unique device identifier string.

◆ GetUniqueDeviceId()

virtual const String& Murl::IPlatformConfiguration::GetUniqueDeviceId ( ) const
pure virtual

Get the unique device identifier string.

On multiuser 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()

virtual void Murl::IPlatformConfiguration::SetUniqueInstallId ( const String id)
pure virtual

Set the unique install identifier string.

Removes all '-' characters from the identifier string.

Parameters
idThe unique install identifier string.

◆ GetUniqueInstallId()

virtual const String& Murl::IPlatformConfiguration::GetUniqueInstallId ( ) const
pure virtual

Get the unique install identifier string.

On multiuser 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()

virtual void Murl::IPlatformConfiguration::SetCountryCode ( const String code)
pure virtual

Set the country code string.

Parameters
codeThe country code string.

◆ GetCountryCode()

virtual const String& Murl::IPlatformConfiguration::GetCountryCode ( ) const
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()

virtual void Murl::IPlatformConfiguration::SetTargetManufacturerName ( const String name)
pure virtual

Set the manufacturer name.

Parameters
nameThe manufacturer name.

◆ GetTargetManufacturerName()

virtual const String& Murl::IPlatformConfiguration::GetTargetManufacturerName ( ) const
pure virtual

Get the manufacturer name.

Returns
The manufacturer name or "N/A" if not set by the platform implementation.

◆ SetTargetDeviceName()

virtual void Murl::IPlatformConfiguration::SetTargetDeviceName ( const String name)
pure virtual

Set the target device name.

Parameters
nameThe target device name.

◆ GetTargetDeviceName()

virtual const String& Murl::IPlatformConfiguration::GetTargetDeviceName ( ) const
pure virtual

Get the target device name.

Returns
THe target device name or "N/A" if not set by the platform implementation.

◆ SetTargetModelName()

virtual void Murl::IPlatformConfiguration::SetTargetModelName ( const String name)
pure virtual

Set the target model name.

Parameters
nameThe target model name.

◆ GetTargetModelName()

virtual const String& Murl::IPlatformConfiguration::GetTargetModelName ( ) const
pure virtual

Get the target model name.

Returns
The target model name or "N/A" if not set by the platform implementation.

◆ SetTargetProductName()

virtual void Murl::IPlatformConfiguration::SetTargetProductName ( const String name)
pure virtual

Set the target product name.

Parameters
nameThe target product name.

◆ GetTargetProductName()

virtual const String& Murl::IPlatformConfiguration::GetTargetProductName ( ) const
pure virtual

Get the target product name.

Returns
The target product name or "N/A" if not set by the platform implementation.

◆ SetSystemVersionName()

virtual void Murl::IPlatformConfiguration::SetSystemVersionName ( const String name)
pure virtual

Set the system version name.

Parameters
nameThe system version name.

◆ GetSystemVersionName()

virtual const String& Murl::IPlatformConfiguration::GetSystemVersionName ( ) const
pure virtual

Get the system version name.

Returns
The system version name or "N/A" if not set by the platform implementation.

◆ SetTargetClass()

virtual void Murl::IPlatformConfiguration::SetTargetClass ( IEnums::TargetClass  targetClass)
pure virtual

Set the target class enumeration value.

Parameters
targetClassThe target class enumeration value.

◆ GetTargetClass()

virtual IEnums::TargetClass Murl::IPlatformConfiguration::GetTargetClass ( ) const
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()

virtual Bool Murl::IPlatformConfiguration::IsTargetClassMatching ( IEnums::TargetClass  targetClass) const
pure virtual

Check if the target class is matching a specified value.

Parameters
targetClassThe target class enumeration value.
Returns
true if the target class is matching the parameter value.

◆ SetTargetDevice()

virtual void Murl::IPlatformConfiguration::SetTargetDevice ( IEnums::TargetDevice  targetDevice)
pure virtual

Set the target device enumeration value.

Parameters
targetDeviceThe target device enumeration value.

◆ GetTargetDevice()

virtual IEnums::TargetDevice Murl::IPlatformConfiguration::GetTargetDevice ( ) const
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()

virtual Bool Murl::IPlatformConfiguration::IsTargetDeviceMatching ( IEnums::TargetDevice  targetDevice) const
pure virtual

Check if the target device is matching a specified value.

Parameters
targetDeviceThe target device enumeration value.
Returns
true if the target device is matching the parameter value.

◆ SetOperatingSystem()

virtual void Murl::IPlatformConfiguration::SetOperatingSystem ( IEnums::OperatingSystem  operatingSystem)
pure virtual

Set the operating system enumeration value.

Parameters
operatingSystemThe operating system enumeration value.

◆ GetOperatingSystem()

virtual IEnums::OperatingSystem Murl::IPlatformConfiguration::GetOperatingSystem ( ) const
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()

virtual Bool Murl::IPlatformConfiguration::IsOperatingSystemMatching ( IEnums::OperatingSystem  operatingSystem) const
pure virtual

Check if the operating system is matching a specified value.

Parameters
operatingSystemThe operating system enumeration value.
Returns
true if the operating system is matching the parameter value.

◆ SetGpu()

virtual void Murl::IPlatformConfiguration::SetGpu ( IEnums::Gpu  gpu)
pure virtual

Set the graphics processing unit enumeration value.

Parameters
gpuThe graphics processing unit enumeration value.

◆ GetGpu()

virtual IEnums::Gpu Murl::IPlatformConfiguration::GetGpu ( ) const
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()

virtual Bool Murl::IPlatformConfiguration::IsGpuMatching ( IEnums::Gpu  gpu) const
pure virtual

Check if the graphics processing unit is matching a specified value.

Parameters
gpuThe graphics processing unit enumeration value.
Returns
true if the graphics processing unit is matching the parameter value.

◆ SetNumberOfBackBufferColorBits()

virtual void Murl::IPlatformConfiguration::SetNumberOfBackBufferColorBits ( UInt32  numRedBits,
UInt32  numGreenBits,
UInt32  numBlueBits,
UInt32  numAlphaBits 
)
pure virtual

Set the back buffer's bit depths for a single color value.

Parameters
numRedBitsThe number of bits for the red component.
numGreenBitsThe number of bits for the green component.
numBlueBitsThe number of bits for the blue component.
numAlphaBitsThe number of bits for the alpha component.

◆ GetNumberOfBackBufferRedBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferRedBits ( ) const
pure virtual

Get the back buffer's bit depth for the red component.

Returns
The bit depth.

◆ GetNumberOfBackBufferGreenBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferGreenBits ( ) const
pure virtual

Get the back buffer's bit depth for the green component.

Returns
The bit depth.

◆ GetNumberOfBackBufferBlueBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferBlueBits ( ) const
pure virtual

Get the back buffer's bit depth for the blue component.

Returns
The bit depth.

◆ GetNumberOfBackBufferAlphaBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferAlphaBits ( ) const
pure virtual

Get the back buffer's bit depth for the alpha component.

Returns
The bit depth.

◆ SetNumberOfBackBufferDepthBits()

virtual void Murl::IPlatformConfiguration::SetNumberOfBackBufferDepthBits ( UInt32  numDepthBits)
pure virtual

Set the back buffer's depth buffer bit depth.

Parameters
numDepthBitsThe number of bits for a single depth buffer fragment.

◆ GetNumberOfBackBufferDepthBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferDepthBits ( ) const
pure virtual

Get the back buffer's depth buffer bit depth.

Returns
The number of bits for a single depth buffer fragment.

◆ SetNumberOfBackBufferStencilBits()

virtual void Murl::IPlatformConfiguration::SetNumberOfBackBufferStencilBits ( UInt32  numStencilBits)
pure virtual

Set the back buffer's stencil buffer bit depth.

Parameters
numStencilBitsThe number of bits for a single stencil buffer fragment.

◆ GetNumberOfBackBufferStencilBits()

virtual UInt32 Murl::IPlatformConfiguration::GetNumberOfBackBufferStencilBits ( ) const
pure virtual

Get the back buffer's stencil buffer bit depth.

Returns
The number of bits for a single stencil buffer fragment.

◆ SetPhysicalScreenSize()

virtual void Murl::IPlatformConfiguration::SetPhysicalScreenSize ( Real  mmSizeX,
Real  mmSizeY 
)
pure virtual

Set the physical screen size.

Parameters
mmSizeXThe screen width in millimeters.
mmSizeYThe screen height in millimeters.

◆ GetPhysicalScreenSizeX()

virtual Real Murl::IPlatformConfiguration::GetPhysicalScreenSizeX ( ) const
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()

virtual Real Murl::IPlatformConfiguration::GetPhysicalScreenSizeY ( ) const
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()

virtual void Murl::IPlatformConfiguration::SetPhysicalPixelSize ( Real  mmSizeX,
Real  mmSizeY 
)
pure virtual

Set the physical pixel size.

Parameters
mmSizeXThe pixel width in millimeters.
mmSizeYThe pixel height in millimeters.

◆ GetPhysicalPixelSizeX()

virtual Real Murl::IPlatformConfiguration::GetPhysicalPixelSizeX ( ) const
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()

virtual Real Murl::IPlatformConfiguration::GetPhysicalPixelSizeY ( ) const
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()

virtual void Murl::IPlatformConfiguration::SetPixelScaleFactor ( Real  sizeXFactor,
Real  sizeYFactor 
)
pure virtual

Set the pixel scale factor.

Parameters
sizeXFactorThe pixel width scale factor.
sizeYFactorThe pixel height scale factor.

◆ GetPixelScaleFactorX()

virtual Real Murl::IPlatformConfiguration::GetPixelScaleFactorX ( ) const
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()

virtual Real Murl::IPlatformConfiguration::GetPixelScaleFactorY ( ) const
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()

virtual Real Murl::IPlatformConfiguration::GetNumberOfPixelsFromSizeX ( Real  sizeValue,
IEnums::LengthMeasure  unit 
) const
pure virtual

Get the number of pixels from a specified width and unit.

Parameters
sizeValueThe width value.
unitThe 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()

virtual Real Murl::IPlatformConfiguration::GetNumberOfPixelsFromSizeY ( Real  sizeValue,
IEnums::LengthMeasure  unit 
) const
pure virtual

Get the number of pixels from a specified height and unit.

Parameters
sizeValueThe height value.
unitThe 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()

virtual Real Murl::IPlatformConfiguration::GetSizeXFromNumberOfPixels ( Real  numberOfPixels,
IEnums::LengthMeasure  unit 
) const
pure virtual

Get the width in a specified unit from a specified number of pixels.

Parameters
numberOfPixelsThe number of pixels value.
unitThe unit enumeration value.
Returns
The width in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

◆ GetSizeYFromNumberOfPixels()

virtual Real Murl::IPlatformConfiguration::GetSizeYFromNumberOfPixels ( Real  numberOfPixels,
IEnums::LengthMeasure  unit 
) const
pure virtual

Get the height in a specified unit from a specified number of pixels.

Parameters
numberOfPixelsThe number of pixels value.
unitThe unit enumeration value.
Returns
The height in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

◆ SetInAppBillingProviderName()

virtual void Murl::IPlatformConfiguration::SetInAppBillingProviderName ( const String name)
pure virtual

Set the name of the In-App Billing provider.

Parameters
nameThe IAB provider name.

◆ GetInAppBillingProviderName()

virtual const String& Murl::IPlatformConfiguration::GetInAppBillingProviderName ( ) const
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()

virtual void Murl::IPlatformConfiguration::SetMultithreadingSupported ( Bool  supported)
pure virtual

Enable/disable multithreading support.

Parameters
supportedIf true, multithreading is supported.

◆ IsMultithreadingSupported()

virtual Bool Murl::IPlatformConfiguration::IsMultithreadingSupported ( ) const
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


Copyright © 2011-2018 Spraylight GmbH.