ScummVM API documentation
OSystem

Description

API related to OSystem - the main interface for ScummVM backends.

Modules

 Subsystem modules
 
 Feature flags
 
 Graphics
 
 Overlay
 
 Mouse
 
 Events and Time
 
 Mutex handling
 
 Sound
 
 Audio CD
 
 Miscellaneous
 

Classes

struct  TimeDate
 
class  OSystem
 

Enumerations

enum  LogMessageType::Type { LogMessageType::kInfo, LogMessageType::kError, LogMessageType::kWarning, LogMessageType::kDebug }
 
enum  CursorMaskValue { kCursorMaskTransparent = 0, kCursorMaskOpaque = 1, kCursorMaskInvert = 2, kCursorMaskPaletteXorColorXnor = 3 }
 

Variables

OSystemg_system
 

Enumeration Type Documentation

◆ Type

Enumeration for log message types.

Enumerator
kInfo 

Info logs.

kError 

Error logs.

kWarning 

Warning logs.

kDebug 

Debug logs.

◆ CursorMaskValue

Pixel mask modes for cursor graphics.

Enumerator
kCursorMaskTransparent 

Overlapped pixel is unchanged

kCursorMaskOpaque 

Overlapped pixel is replaced with the cursor pixel.

kCursorMaskInvert 

Fully inverts the overlapped pixel regardless of the cursor color data. Backend must support kFeatureCursorMaskInvert for this mode.

kCursorMaskPaletteXorColorXnor 

Blends with mode (Destination AND Mask) XOR Color in palette modes, or (Destination AND Mask) XOR (NOT Color) in RGB modes, which is equivalent to Classic MacOS behavior for pixel colors other than black and white. Backend must support kFeatureCursorMaskPaletteXorColorXnor for this mode.

Variable Documentation

◆ g_system

OSystem* g_system

The global OSystem instance. Initialized in main().