Inheritance diagram for OSystem_Android:

Public Types
enum	{ TOUCH_MODE_TOUCHPAD = 0, TOUCH_MODE_MOUSE = 1, TOUCH_MODE_GAMEPAD = 2, TOUCH_MODE_MAX = 3 }

enum	{ SCREEN_ORIENTATION_UNSPECIFIED = 0xffffffff, SCREEN_ORIENTATION_LANDSCAPE = 0, SCREEN_ORIENTATION_PORTRAIT = 1 }

enum	{ SHOW_ON_SCREEN_NONE = 0, SHOW_ON_SCREEN_MENU = 1, SHOW_ON_SCREEN_INPUT_MODE = 2, SHOW_ON_SCREEN_ALL = 0xffffffff }

Public Types inherited from OSystem
enum	Task { kLocalServer, kCloudDownload, kDataPackDownload }

enum	Feature { kFeatureFullscreenMode, kFeatureAspectRatioCorrection, kFeatureFilteringMode, kFeatureStretchMode, kFeatureVirtualKeyboard, kFeatureCursorPalette, kFeatureCursorAlpha, kFeatureCursorMask, kFeatureCursorMaskInvert, kFeatureCursorMaskPaletteXorColorXnor, kFeatureOverlaySupportsAlpha, kFeatureIconifyWindow, kFeatureOpenGLForGame, kFeatureShadersForGame, kFeatureVSync, kFeatureFullscreenToggleKeepsContext, kFeatureDisplayLogFile, kFeatureClipboardSupport, kFeatureOpenUrl, kFeatureTouchpadMode, kFeatureKbdMouseSpeed, kFeatureJoystickDeadzone, kFeatureScalers, kFeatureShaders, kFeatureDLC, kFeatureSystemBrowserDialog, kFeatureNoQuit, kFeatureTouchscreen, kFeatureCpuNEON, kFeatureCpuSSE2, kFeatureCpuSSE41, kFeatureCpuAVX2, kFeatureCpuAltivec, kFeatureRotationMode }

enum	GfxModeFlags { kGfxModeNoFlags = 0, kGfxModeRender3d = (1 << 0) }

enum	TransactionError { kTransactionSuccess = 0, kTransactionAspectRatioFailed = (1 << 0), kTransactionFullscreenFailed = (1 << 1), kTransactionModeSwitchFailed = (1 << 2), kTransactionSizeChangeFailed = (1 << 3), kTransactionFormatNotSupported = (1 << 4), kTransactionFilteringFailed = (1 << 5), kTransactionStretchModeSwitchFailed = (1 << 6), kTransactionShaderChangeFailed = (1 << 7), kTransactionVSyncFailed = (1 << 8) }

Public Member Functions
	OSystem_Android (int audio_sample_rate, int audio_buffer_size)

void	initBackend () override

void	engineInit () override

void	engineDone () override

void	updateStartSettings (const Common::String &executable, Common::String &command, Common::StringMap &startSettings, Common::StringArray &additionalArgs) override

bool	hasFeature (OSystem::Feature f) override

void	setFeatureState (OSystem::Feature f, bool enable) override

bool	getFeatureState (OSystem::Feature f) override

void	pushEvent (int type, int arg1, int arg2, int arg3, int arg4, int arg5, int arg6)

void	pushEvent (const Common::Event &event)

void	pushEvent (const Common::Event &event1, const Common::Event &event2)

void	pushDelayedTouchMouseBtnEvents ()

TouchControls &	getTouchControls ()

void	applyTouchSettings (bool _3dMode, bool overlayShown)

void	setupTouchMode (int oldValue, int newValue)

void	applyOrientationSettings ()

void	updateOnScreenControls ()

bool	pollEvent (Common::Event &event) override

Common::HardwareInputSet *	getHardwareInputSet () override

Common::KeymapArray	getGlobalKeymaps () override

Common::KeymapperDefaultBindings *	getKeymapperDefaultBindings () override

Common::Path	getDefaultConfigFileName () override

Common::Path	getDefaultLogFileName () override

void	registerDefaultSettings (const Common::String &target) const override

GUI::OptionsContainerWidget *	buildBackendOptionsWidget (GUI::GuiObject *boss, const Common::String &name, const Common::String &target) const override

void	applyBackendSettings () override

uint32	getMillis (bool skipRecord=false) override

void	delayMillis (uint msecs) override

Common::MutexInternal *	createMutex () override

void	quit () override

void	setWindowCaption (const Common::U32String &caption) override

Audio::Mixer *	getMixer () override

void	getTimeAndDate (TimeDate &td, bool skipRecord=false) const override

void	logMessage (LogMessageType::Type type, const char *message) override

void	addSysArchivesToSearchSet (Common::SearchSet &s, int priority=0) override

bool	openUrl (const Common::String &url) override

bool	hasTextInClipboard () override

Common::U32String	getTextFromClipboard () override

bool	setTextInClipboard (const Common::U32String &text) override

bool	isConnectionLimited () override

Common::String	getSystemLanguage () const override

const OSystem::GraphicsMode *	getSupportedGraphicsModes () const override

int	getDefaultGraphicsMode () const override

bool	setGraphicsMode (int mode, uint flags) override

int	getGraphicsMode () const override

OpenGL::ContextType	getOpenGLType () const override

virtual const char const	buildHelpDialogData () override

Public Member Functions inherited from ModularGraphicsBackend
GraphicsManager *	getGraphicsManager ()

bool	setShader (const Common::Path &name) override final

const GraphicsMode *	getSupportedStretchModes () const override final

int	getDefaultStretchMode () const override final

bool	setStretchMode (int mode) override final

int	getStretchMode () const override final

uint	getDefaultScaler () const override final

uint	getDefaultScaleFactor () const override final

bool	setScaler (uint mode, int factor) override final

uint	getScaler () const override final

uint	getScaleFactor () const override final

void	initSize (uint width, uint height, const Graphics::PixelFormat *format=NULL) override final

void	initSizeHint (const Graphics::ModeList &modes) override final

int	getScreenChangeID () const override final

void	beginGFXTransaction () override final

OSystem::TransactionError	endGFXTransaction () override final

int16	getHeight () override final

int16	getWidth () override final

PaletteManager *	getPaletteManager () override final

void	copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h) override final

Graphics::Surface *	lockScreen () override final

void	unlockScreen () override final

void	fillScreen (uint32 col) override final

void	fillScreen (const Common::Rect &r, uint32 col) override final

void	updateScreen () override final

void	setShakePos (int shakeXOffset, int shakeYOffset) override final

void	setFocusRectangle (const Common::Rect &rect) override final

void	clearFocusRectangle () override final

void	showOverlay (bool inGUI) override final

void	hideOverlay () override final

bool	isOverlayVisible () const override final

Graphics::PixelFormat	getOverlayFormat () const override final

void	clearOverlay () override final

void	grabOverlay (Graphics::Surface &surface) override final

void	copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h) override final

int16	getOverlayHeight () override final

int16	getOverlayWidth () override final

float	getHiDPIScreenFactor () const override final

bool	showMouse (bool visible) override final

void	warpMouse (int x, int y) override final

void	setMouseCursor (const void buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, bool dontScale=false, const Graphics::PixelFormat format=NULL, const byte *mask=NULL) override final

void	setCursorPalette (const byte *colors, uint start, uint num) override final

bool	lockMouse (bool lock) override final

void	displayMessageOnOSD (const Common::U32String &msg) override final

void	displayActivityIconOnOSD (const Graphics::Surface *icon) override final

void	saveScreenshot () override final

Public Member Functions inherited from BaseBackend
bool	setScaler (const char *name, int factor) override final

Public Member Functions inherited from OSystem
void	destroy ()

virtual void	init ()

bool	backendInitialized () const

virtual void	taskStarted (Task)

virtual void	taskFinished (Task)

bool	setGraphicsMode (const char *name)

Graphics::PixelFormat	getScreenFormat () const

Common::List< Graphics::PixelFormat >	getSupportedFormats () const

virtual Common::Array< uint >	getSupportedAntiAliasingLevels () const

bool	setStretchMode (const char *name)

virtual uint32	getDoubleClickTime () const

virtual Common::TimerManager *	getTimerManager ()

Common::EventManager *	getEventManager ()

AudioCDManager *	getAudioCDManager ()

virtual void	fatalError ()

virtual Common::SaveFileManager *	getSavefileManager ()

virtual Common::TextToSpeechManager *	getTextToSpeechManager ()

virtual Common::DialogManager *	getDialogManager ()

virtual DLC::Store *	getDLCStore ()

virtual FilesystemFactory *	getFilesystemFactory ()

virtual Common::SeekableReadStream *	createConfigReadStream ()

virtual Common::WriteStream *	createConfigWriteStream ()

virtual void	messageBox (LogMessageType::Type type, const char *message)

virtual bool	displayLogFile ()

Additional Inherited Members
Protected Attributes inherited from ModularGraphicsBackend
GraphicsManager *	_graphicsManager

Protected Attributes inherited from OSystem
AudioCDManager *	_audiocdManager

Common::EventManager *	_eventManager

Common::TimerManager *	_timerManager

Common::SaveFileManager *	_savefileManager

Common::TextToSpeechManager *	_textToSpeechManager

Common::DialogManager *	_dialogManager

FilesystemFactory *	_fsFactory

DLC::Store *	_dlcStore

Common::U32String	_clipboard

bool	_dummyUnused

Member Function Documentation

◆ initBackend()

void OSystem_Android::initBackend ( )

overridevirtual

The following method is called once, from main.cpp, after all config data (including command line params etc.) is fully loaded.

Note: Subclasses should always invoke the implementation of their parent class. They should do so near the end of their own implementation.

Reimplemented from BaseBackend.

◆ engineInit()

void OSystem_Android::engineInit ( void )

overridevirtual

Allow the backend to perform engine-specific initialization.

Called just before the engine is run.

Reimplemented from OSystem.

◆ engineDone()

void OSystem_Android::engineDone ( )

overridevirtual

Allow the backend to perform engine-specific deinitialization.

Called after the engine finishes.

Reimplemented from OSystem.

◆ updateStartSettings()

void OSystem_Android::updateStartSettings	(	const Common::String &	executable,
		Common::String &	command,
		Common::StringMap &	startSettings,
		Common::StringArray &	additionalArgs
	)

overridevirtual

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 from OSystem.

◆ hasFeature()

bool OSystem_Android::hasFeature ( OSystem::Feature f )

overridevirtual

Determine whether the backend supports the specified feature.

Reimplemented from ModularGraphicsBackend.

◆ setFeatureState()

void OSystem_Android::setFeatureState	(	OSystem::Feature	f,
		bool	enable
	)

overridevirtual

Enable or disable the specified feature.

For example, this may be used to enable fullscreen mode or to deactivate aspect correction, etc.

Reimplemented from ModularGraphicsBackend.

◆ getFeatureState()

bool OSystem_Android::getFeatureState ( OSystem::Feature f )

overridevirtual

Query the state of the specified feature.

For example, test whether fullscreen mode is active or not.

Reimplemented from ModularGraphicsBackend.

◆ pollEvent()

bool OSystem_Android::pollEvent ( Common::Event & event )

overridevirtual

Query an event from the source.

Parameters

event Reference to the event struct where the event should be stored.

Return values

true	If an event was polled, false otherwise.

Implements Common::EventSource.

◆ getHardwareInputSet()

Common::HardwareInputSet* OSystem_Android::getHardwareInputSet ( )

overridevirtual

Register hardware inputs with keymapper.

Returns: HardwareInputSet with all keys and recommended mappings.

For more information, see keymapper.

Reimplemented from OSystem.

◆ getGlobalKeymaps()

Common::KeymapArray OSystem_Android::getGlobalKeymaps ( )

overridevirtual

Return a platform-specific global keymap.

Returns: Keymap with actions appropriate for the platform.

The caller will use and delete the return object.

For more information, see keymapper.

Reimplemented from OSystem.

◆ getKeymapperDefaultBindings()

Common::KeymapperDefaultBindings* OSystem_Android::getKeymapperDefaultBindings ( )

overridevirtual

Return platform-specific default keybindings.

Returns: KeymapperDefaultBindings populated with keybindings.

For more information, see keymapper.

Reimplemented from OSystem.

◆ getDefaultConfigFileName()

Common::Path OSystem_Android::getDefaultConfigFileName ( )

overridevirtual

Get the default file name (or even path) where the user configuration of ScummVM will be saved.

Note that not all ports can use this.

Reimplemented from OSystem.

◆ getDefaultLogFileName()

Common::Path OSystem_Android::getDefaultLogFileName ( )

overridevirtual

Get the default file name (or even path) where the scummvm.log will be saved.

Note that not all ports can use this.

Reimplemented from OSystem.

◆ registerDefaultSettings()

void OSystem_Android::registerDefaultSettings ( const Common::String & target ) const

overridevirtual

Register the default values for the settings the backend uses into the configuration manager.

Parameters

target name of a config manager target

Reimplemented from OSystem.

◆ buildBackendOptionsWidget()

GUI::OptionsContainerWidget* OSystem_Android::buildBackendOptionsWidget	(	GUI::GuiObject *	boss,
		const Common::String &	name,
		const Common::String &	target
	)		const

overridevirtual

Return a GUI widget container for configuring the specified target options.

The returned widget is shown in the Backend tab in the options dialog. Backends can build custom options dialogs.

Backends that don't want to have a Backend tab in the options dialog can return nullptr.

Parameters

boss	the widget / dialog the returned widget is a child of
name	the name the returned widget must use
target	name of a config manager target

Reimplemented from OSystem.

◆ applyBackendSettings()

void OSystem_Android::applyBackendSettings ( )

overridevirtual

Notify the backend that the settings editable from the game tab in the options dialog may have changed and that they need to be applied if necessary.

Reimplemented from OSystem.

◆ getMillis()

uint32 OSystem_Android::getMillis ( bool skipRecord = false )

overridevirtual

Get the number of milliseconds since the program was started.

Parameters

skipRecord Skip recording of this value by the event recorder. This might be needed particularly when we are in an on-screen GUI loop where the player can pause the recording.

Implements OSystem.

◆ delayMillis()

void OSystem_Android::delayMillis ( uint msecs )

overridevirtual

Delay/sleep for the specified amount of milliseconds.

Implements OSystem.

◆ createMutex()

Common::MutexInternal* OSystem_Android::createMutex ( )

overridevirtual

Create a new mutex.

Returns: The newly created mutex, or 0 if an error occurred.

Implements OSystem.

◆ quit()

void OSystem_Android::quit ( )

overridevirtual

Quit (exit) the application.

Implements OSystem.

◆ setWindowCaption()

void OSystem_Android::setWindowCaption ( const Common::U32String & caption )

overridevirtual

Set a window caption or any other comparable status display to the given value.

Parameters

caption The window caption to use.

Reimplemented from OSystem.

◆ getMixer()

Audio::Mixer* OSystem_Android::getMixer ( )

overridevirtual

Return the audio mixer.

For more information, see Audio::Mixer.

Implements OSystem.

◆ getTimeAndDate()

void OSystem_Android::getTimeAndDate	(	TimeDate &	td,
		bool	skipRecord = `false`
	)		const

overridevirtual

Get the current time and date, in the local timezone.

On many systems, this corresponds to the combination of time() and localtime().

Implements OSystem.

◆ logMessage()

void OSystem_Android::logMessage	(	LogMessageType::Type	type,
		const char *	message
	)

overridevirtual

Log the given message.

It is up to the backend where to log the different messages. The backend should aim at using a non-buffered output for it, so that no log data is lost in case of a crash.

The default implementation outputs them on stdout/stderr.

Parameters

type	Type of the message.
message	The message itself.

Implements OSystem.

◆ addSysArchivesToSearchSet()

void OSystem_Android::addSysArchivesToSearchSet	(	Common::SearchSet &	s,
		int	priority = `0`
	)

overridevirtual

Add system-specific Common::Archive objects to the given SearchSet. For example, on Unix, the directory corresponding to DATA_PATH (if set), or, on macOS, the 'Resource' dir in the app bundle.

Parameters

s	SearchSet to which the system-specific dirs, if any, are added.
priority	Priority with which those dirs are added.

Reimplemented from OSystem.

◆ openUrl()

bool OSystem_Android::openUrl ( const Common::String & url )

overridevirtual

Open the given URL in the default browser (if available on the target system).

Returns: True on success, false otherwise.

Note: It is up to the backend to ensure that the system is in a state that allows the user to actually see the web page. This might for example require leaving fullscreen mode.

Parameters

url	The URL to open.

Reimplemented from OSystem.

◆ hasTextInClipboard()

bool OSystem_Android::hasTextInClipboard ( )

overridevirtual

Check whether there is text available in the clipboard.

The kFeatureClipboardSupport feature flag can be used to test whether this call has been implemented by the active backend.

Returns: True if there is text in the clipboard, false otherwise.

Reimplemented from OSystem.

◆ getTextFromClipboard()

Common::U32String OSystem_Android::getTextFromClipboard ( )

overridevirtual

Return clipboard contents as a string.

The kFeatureClipboardSupport feature flag can be used to test whether this call has been implemented by the active backend.

Returns: clipboard contents ("" if hasTextInClipboard() == false).

Reimplemented from OSystem.

◆ setTextInClipboard()

bool OSystem_Android::setTextInClipboard ( const Common::U32String & text )

overridevirtual

Set the content of the clipboard to the given string.

The kFeatureClipboardSupport feature flag can be used to test whether this call has been implemented by the active backend.

Returns: True if the text has been properly set in the clipboard, false otherwise.

Reimplemented from OSystem.

◆ isConnectionLimited()

bool OSystem_Android::isConnectionLimited ( )

overridevirtual

Return whether the connection is limited (if available on the target system).

Returns: True if the connection is limited.

Reimplemented from OSystem.

◆ getSystemLanguage()

Common::String OSystem_Android::getSystemLanguage ( ) const

overridevirtual

Return the language of the system.

This returns the currently set language of the system on which ScummVM is run.

The format is an ISO 639 language code, optionally followed by an ISO 3166-1 country code in the form language_country.

For information about POSIX locales, see the following link: https://en.wikipedia.org/wiki/ISO_639 https://en.wikipedia.org/wiki/ISO_3166-1

The default implementation returns "en_US".

Returns: Locale of the system.

Reimplemented from OSystem.

◆ getSupportedGraphicsModes()

const OSystem::GraphicsMode* OSystem_Android::getSupportedGraphicsModes ( void ) const

overridevirtual

Retrieve a list of all graphics modes supported by this backend.

This can be both video modes as well as graphic filters/scalers. It is completely up to the backend maintainer to decide what is appropriate here and what not. The list is terminated by an all-zero entry.

Returns: List of supported graphics modes.

Reimplemented from ModularGraphicsBackend.

◆ getDefaultGraphicsMode()

int OSystem_Android::getDefaultGraphicsMode ( ) const

overridevirtual

Return the ID of the 'default' graphics mode. What exactly this means is up to the backend. This mode is set by the client code when no user overrides are present (i.e. if no custom graphics mode is selected using the command line or a config file).

Returns: ID of the 'default' graphics mode.

Reimplemented from ModularGraphicsBackend.

◆ setGraphicsMode()

bool OSystem_Android::setGraphicsMode	(	int	mode,
		uint	flags
	)

overridevirtual

Switch to the specified graphics mode.

If switching to the new mode fails, this method returns false.

The flag 'kGfxModeRender3d' is optional. It allows to switch to 3D-only rendering mode. In this mode, the game engine is allowed to use OpenGL(ES) directly.

Parameters

mode	ID of the new graphics mode.
flags	Flags for the new graphics mode.

Returns: True if the switch was successful, false otherwise.

Reimplemented from ModularGraphicsBackend.

◆ getGraphicsMode()

int OSystem_Android::getGraphicsMode ( ) const

overridevirtual

Determine which graphics mode is currently active.

Returns: ID of the active graphics mode.

Reimplemented from ModularGraphicsBackend.

◆ getOpenGLType()

OpenGL::ContextType OSystem_Android::getOpenGLType ( ) const

inlineoverridevirtual

Return the chosen OpenGL type.

This function works even when a 2D graphical manager is active and let to select a proper renderer before changing mode. Implementation having feature kFeatureOpenGLForGame are expected to override this function.

Returns: the OpenGL type of context which is supported.

Reimplemented from OSystem.

◆ buildHelpDialogData()

virtual const char* const* OSystem_Android::buildHelpDialogData ( )

overridevirtual

Return list of strings used for building help dialog

The strings represented in triplets:

Name of a tab (will be translated)
ZIP pack name with images (optional)
Text of the tab with Markdown formatting (also be translated)

The string list is null-terminated.

Reimplemented from OSystem.

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

backends/platform/android/android.h

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ initBackend()

◆ engineInit()

◆ engineDone()

◆ updateStartSettings()

◆ hasFeature()

◆ setFeatureState()

◆ getFeatureState()

◆ pollEvent()

◆ getHardwareInputSet()

◆ getGlobalKeymaps()

◆ getKeymapperDefaultBindings()

◆ getDefaultConfigFileName()

◆ getDefaultLogFileName()

◆ registerDefaultSettings()

◆ buildBackendOptionsWidget()

◆ applyBackendSettings()

◆ getMillis()

◆ delayMillis()

◆ createMutex()

◆ quit()

◆ setWindowCaption()

◆ getMixer()

◆ getTimeAndDate()

◆ logMessage()

◆ addSysArchivesToSearchSet()

◆ openUrl()

◆ hasTextInClipboard()

◆ getTextFromClipboard()

◆ setTextInClipboard()

◆ isConnectionLimited()

◆ getSystemLanguage()

◆ getSupportedGraphicsModes()

◆ getDefaultGraphicsMode()

◆ setGraphicsMode()

◆ getGraphicsMode()

◆ getOpenGLType()

◆ buildHelpDialogData()