ScummVM API documentation
AGS3::AGSPlatformDriver Struct Referenceabstract
Inheritance diagram for AGS3::AGSPlatformDriver:
AGS3::AGS::Shared::IOutputHandler

Public Member Functions

virtual void MainInit ()
 
virtual void PreBackendInit ()
 
virtual void PostBackendInit ()
 
virtual void PreBackendExit ()
 
virtual void PostBackendExit ()
 
virtual void Delay (int millis)
 
virtual void DisplayAlert (const char *,...)=0
 
virtual void AttachToParentConsole ()
 
virtual int GetLastSystemError ()
 
virtual void ReadConfiguration (Shared::ConfigTree &)
 
virtual FSLocation GetAllUsersDataDirectory ()
 
virtual FSLocation GetUserSavedgamesDirectory ()
 
virtual FSLocation GetUserConfigDirectory ()
 
virtual FSLocation GetUserGlobalConfigDirectory ()
 
virtual FSLocation GetAppOutputDirectory ()
 
virtual bool IsLocalDirRestricted ()
 
virtual const char * GetIllegalFileChars ()
 
virtual const char * GetDiskWriteAccessTroubleshootingText ()
 
virtual const char * GetGraphicsTroubleshootingText ()
 
virtual uint64_t GetDiskFreeSpaceMB (const Shared::String &path)=0
 
virtual const char * GetNoMouseErrorString ()=0
 
virtual bool IsMouseControlSupported (bool windowed)
 
virtual bool IsBackendResponsibleForMouseScaling ()
 
virtual const char * GetAllegroFailUserHint ()
 
virtual eScriptSystemOSID GetSystemOSID ()=0
 
virtual void GetSystemTime (ScriptDateTime *)
 
virtual void PlayVideo (const char *name, int skip, int flags)
 
virtual void InitialiseAbufAtStartup ()
 
virtual void PostAllegroInit (bool windowed)
 
virtual void PostAllegroExit ()=0
 
virtual const char * GetBackendFailUserHint ()
 
virtual void FinishedUsingGraphicsMode ()
 
virtual SetupReturnValue RunSetup (const Shared::ConfigTree &cfg_in, Shared::ConfigTree &cfg_out)
 
virtual void SetGameWindowIcon ()
 
virtual void WriteStdOut (const char *fmt,...)
 
virtual void WriteStdErr (const char *fmt,...)
 
virtual void DisplayMessageBox (const char *text)=0
 
virtual void YieldCPU ()
 
virtual void DisplaySwitchOut ()
 
virtual void DisplaySwitchIn ()
 
virtual void PauseApplication ()
 
virtual void ResumeApplication ()
 
virtual void GetSystemDisplayModes (std::vector< Engine::DisplayMode > &dms)
 
virtual bool EnterFullscreenMode (const Engine::DisplayMode &dm)
 
virtual bool ExitFullscreenMode ()
 
virtual void AdjustWindowStyleForFullscreen ()
 
virtual void AdjustWindowStyleForWindowed ()
 
virtual int ConvertKeycodeToScanCode (int keyCode)
 
virtual Size ValidateWindowSize (const Size &sz, bool borderless) const
 
virtual int InitializeCDPlayer ()=0
 
virtual int CDPlayerCommand (int cmdd, int datt)=0
 
virtual void ShutdownCDPlayer ()=0
 
virtual Common::String GetCommandArg (size_t arg_index)
 
virtual bool LockMouseToWindow ()
 
virtual void UnlockMouse ()
 
void SetCommandArgs (const char *const argv[], size_t argc)
 
void SetOutputToErr (bool on)
 
void SetGUIMode (bool on)
 
void PrintMessage (const AGS::Shared::DebugMessage &msg) override
 

Static Public Member Functions

static AGSPlatformDriverGetDriver ()
 

Protected Attributes

bool _logToStdErr = false
 
bool _guiMode = false
 
const char *const * _cmdArgs = nullptr
 
size_t _cmdArgCount = 0u
 

The documentation for this struct was generated from the following file: