#include <system.h>
Classes | |
struct | GraphicsMode |
Public Member Functions | |
void | destroy () |
virtual void | init () |
virtual void | initBackend () |
bool | backendInitialized () const |
virtual void | engineInit () |
virtual void | engineDone () |
virtual void | taskStarted (Task) |
virtual void | taskFinished (Task) |
virtual void | updateStartSettings (const Common::String &executable, Common::String &command, Common::StringMap &startSettings, Common::StringArray &additionalArgs) |
virtual bool | hasFeature (Feature f) |
virtual void | setFeatureState (Feature f, bool enable) |
virtual bool | getFeatureState (Feature f) |
virtual const GraphicsMode * | getSupportedGraphicsModes () const |
virtual int | getDefaultGraphicsMode () const |
virtual bool | setGraphicsMode (int mode, uint flags=kGfxModeNoFlags) |
bool | setGraphicsMode (const char *name) |
virtual int | getGraphicsMode () const |
Graphics::PixelFormat | getScreenFormat () const |
Common::List< Graphics::PixelFormat > | getSupportedFormats () const |
virtual Common::Array< uint > | getSupportedAntiAliasingLevels () const |
virtual OpenGL::ContextType | getOpenGLType () const |
virtual bool | setShader (const Common::Path &fileName) |
virtual const GraphicsMode * | getSupportedStretchModes () const |
virtual int | getDefaultStretchMode () const |
virtual bool | setStretchMode (int mode) |
bool | setStretchMode (const char *name) |
virtual int | getStretchMode () const |
virtual uint | getDefaultScaler () const |
virtual uint | getDefaultScaleFactor () const |
virtual bool | setScaler (uint mode, int factor) |
virtual bool | setScaler (const char *name, int factor) |
virtual uint | getScaler () const |
virtual uint | getScaleFactor () const |
virtual void | initSize (uint width, uint height, const Graphics::PixelFormat *format=nullptr)=0 |
virtual void | initSizeHint (const Graphics::ModeList &modes) |
virtual int | getScreenChangeID () const |
virtual void | beginGFXTransaction () |
virtual TransactionError | endGFXTransaction () |
virtual int16 | getHeight ()=0 |
virtual int16 | getWidth ()=0 |
virtual PaletteManager * | getPaletteManager ()=0 |
virtual float | getHiDPIScreenFactor () const |
virtual void | copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h)=0 |
virtual Graphics::Surface * | lockScreen ()=0 |
virtual void | unlockScreen ()=0 |
virtual void | fillScreen (uint32 col)=0 |
virtual void | fillScreen (const Common::Rect &r, uint32 col)=0 |
virtual void | updateScreen ()=0 |
virtual void | setShakePos (int shakeXOffset, int shakeYOffset)=0 |
virtual void | setFocusRectangle (const Common::Rect &rect) |
virtual void | clearFocusRectangle () |
virtual void | saveScreenshot () |
virtual void | showOverlay (bool inGUI=true)=0 |
virtual void | hideOverlay ()=0 |
virtual bool | isOverlayVisible () const =0 |
virtual Graphics::PixelFormat | getOverlayFormat () const =0 |
virtual void | clearOverlay ()=0 |
virtual void | grabOverlay (Graphics::Surface &surface)=0 |
virtual void | copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h)=0 |
virtual int16 | getOverlayHeight ()=0 |
virtual int16 | getOverlayWidth ()=0 |
virtual bool | showMouse (bool visible)=0 |
virtual bool | lockMouse (bool lock) |
virtual void | warpMouse (int x, int y)=0 |
virtual void | setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, bool dontScale=false, const Graphics::PixelFormat *format=nullptr, const byte *mask=nullptr)=0 |
virtual void | setCursorPalette (const byte *colors, uint start, uint num) |
virtual uint32 | getDoubleClickTime () const |
virtual uint32 | getMillis (bool skipRecord=false)=0 |
virtual void | delayMillis (uint msecs)=0 |
virtual void | getTimeAndDate (TimeDate &td, bool skipRecord=false) const =0 |
virtual Common::TimerManager * | getTimerManager () |
Common::EventManager * | getEventManager () |
virtual Common::HardwareInputSet * | getHardwareInputSet () |
virtual Common::KeymapArray | getGlobalKeymaps () |
virtual Common::KeymapperDefaultBindings * | getKeymapperDefaultBindings () |
virtual Common::MutexInternal * | createMutex ()=0 |
virtual Audio::Mixer * | getMixer ()=0 |
AudioCDManager * | getAudioCDManager () |
virtual void | quit ()=0 |
virtual void | fatalError () |
virtual void | setWindowCaption (const Common::U32String &caption) |
virtual void | displayMessageOnOSD (const Common::U32String &msg)=0 |
virtual void | displayActivityIconOnOSD (const Graphics::Surface *icon)=0 |
virtual Common::SaveFileManager * | getSavefileManager () |
virtual Common::TextToSpeechManager * | getTextToSpeechManager () |
virtual Common::DialogManager * | getDialogManager () |
virtual DLC::Store * | getDLCStore () |
virtual FilesystemFactory * | getFilesystemFactory () |
virtual void | addSysArchivesToSearchSet (Common::SearchSet &s, int priority=0) |
virtual Common::SeekableReadStream * | createConfigReadStream () |
virtual Common::WriteStream * | createConfigWriteStream () |
virtual Common::Path | getDefaultConfigFileName () |
virtual Common::Path | getDefaultLogFileName () |
virtual void | registerDefaultSettings (const Common::String &target) const |
virtual GUI::OptionsContainerWidget * | buildBackendOptionsWidget (GUI::GuiObject *boss, const Common::String &name, const Common::String &target) const |
virtual const char *const * | buildHelpDialogData () |
virtual void | applyBackendSettings () |
virtual void | logMessage (LogMessageType::Type type, const char *message)=0 |
virtual void | messageBox (LogMessageType::Type type, const char *message) |
virtual bool | displayLogFile () |
virtual bool | hasTextInClipboard () |
virtual Common::U32String | getTextFromClipboard () |
virtual bool | setTextInClipboard (const Common::U32String &text) |
virtual bool | openUrl (const Common::String &url) |
virtual Common::String | getSystemLanguage () const |
virtual bool | isConnectionLimited () |
Interface for ScummVM backends.
If you want to port ScummVM to a system that is not currently covered by any of our backends, this is the place to start. ScummVM will create an instance of a subclass of this interface and use it to interact with the system.
In particular, a backend provides:
enum OSystem::Task |
Identify a task that ScummVM can perform.
void OSystem::destroy | ( | ) |
Destoy this OSystem instance.
|
inlinevirtual |
Call this method once, after g_system is created.
Reimplemented in OSystem_SDL, OSystem_MacOSX, OSystem_AmigaOS, OSystem_POSIX, OSystem_PSP2, OSystem_Win32, OSystem_KolibriOS, OSystem_SDL_Miyoo, OSystem_MorphOS, OSystem_SDL_Opendingux, OSystem_PS3, OSystem_RISCOS, OSystem_SDL_Sailfish, and OSystem_Switch.
|
virtual |
The following method is called once, from main.cpp, after all config data (including command line params etc.) is fully loaded.
Reimplemented in OSystem_Android, OSystem_DS, OSystem_Wii, OSystem_N64, N3DS::OSystem_3DS, OSystem_iOS7, OSystem_libretro, OSystem_Dreamcast, OSystem_PSP, OSystem_SDL, EventsBaseBackend, OSystem_MacOSX, OSystem_AmigaOS, BaseBackend, OSystem_POSIX, OSystem_PSP2, OSystem_Win32, OSystem_Atari, OSystem_KolibriOS, OSystem_SDL_Miyoo, OSystem_SDL_Opendingux, OSystem_PS3, OSystem_RISCOS, OSystem_SDL_Sailfish, and OSystem_Switch.
|
inline |
Return false if initBackend() has not yet been called and true otherwise.
Some functionalities such as mutexes cannot be used until the backend is initialized.
|
inlinevirtual |
Allow the backend to perform engine-specific initialization.
Called just before the engine is run.
Reimplemented in OSystem_Android, OSystem_Wii, OSystem_DS, OSystem_iOS7, OSystem_libretro, and OSystem_SDL.
|
inlinevirtual |
Allow the backend to perform engine-specific deinitialization.
Called after the engine finishes.
Reimplemented in OSystem_Android, OSystem_Wii, OSystem_DS, OSystem_PSP, OSystem_iOS7, and OSystem_SDL.
|
inlinevirtual |
Allow the backend to be notified when a task is started.
Reimplemented in OSystem_iOS7.
|
inlinevirtual |
Allow the backend to be notified when a task is finished.
Reimplemented in OSystem_iOS7.
|
virtual |
Allow the backend to customize the start settings, such as for example starting automatically a game under certain circumstances.
This function is called after the command line parameters have been parsed, and thus the initial value of command and settings will reflect those.
The default implementation checks if the executable name is "scummvm-auto" or if a file named "scummvm-autorun" sits next to it to enable autorun mode.
Reimplemented in OSystem_Android, OSystem_iOS7, and OSystem_MacOSX.