ScummVM API documentation
Public Member Functions | List of all members
OPGraphicsManager Class Reference
Inheritance diagram for OPGraphicsManager:
SurfaceSdlGraphicsManager SdlGraphicsManager WindowedGraphicsManager Common::EventObserver GraphicsManager PaletteManager Common::NonCopyable

Public Member Functions

 OPGraphicsManager (SdlEventSource *sdlEventSource, SdlWindow *window)
 
bool loadGFXMode () override
 
void unloadGFXMode () override
 
void showSystemMouseCursor (bool visible) override
 
- Public Member Functions inherited from SurfaceSdlGraphicsManager
 SurfaceSdlGraphicsManager (SdlEventSource *sdlEventSource, SdlWindow *window)
 
bool hasFeature (OSystem::Feature f) const override
 
void setFeatureState (OSystem::Feature f, bool enable) override
 
bool getFeatureState (OSystem::Feature f) const override
 
const OSystem::GraphicsMode * getSupportedGraphicsModes () const override
 
int getDefaultGraphicsMode () const override
 
bool setGraphicsMode (int mode, uint flags=OSystem::kGfxModeNoFlags) override
 
int getGraphicsMode () const override
 
uint getDefaultScaler () const override
 
uint getDefaultScaleFactor () const override
 
bool setScaler (uint mode, int factor) override
 
uint getScaler () const override
 
uint getScaleFactor () const override
 
void initSize (uint w, uint h, const Graphics::PixelFormat *format=NULL) override
 
int getScreenChangeID () const override
 
void beginGFXTransaction () override
 
OSystem::TransactionError endGFXTransaction () override
 
int16 getHeight () const override
 
int16 getWidth () const override
 
void copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h) override
 
Graphics::Surface * lockScreen () override
 
void unlockScreen () override
 
void fillScreen (uint32 col) override
 
void fillScreen (const Common::Rect &r, uint32 col) override
 
void updateScreen () override
 
void setFocusRectangle (const Common::Rect &rect) override
 
void clearFocusRectangle () override
 
Graphics::PixelFormat getOverlayFormat () const override
 
void clearOverlay () override
 
void grabOverlay (Graphics::Surface &surface) const override
 
void copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h) override
 
int16 getOverlayHeight () const override
 
int16 getOverlayWidth () const override
 
void setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format, const byte *mask, frac_t scaleX, frac_t scaleY) override
 
void setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format, const byte *mask, frac_t scaleX, frac_t scaleY, bool disableKeyColor)
 
void setCursorPalette (const byte *colors, uint start, uint num) override
 
bool notifyEvent (const Common::Event &event) override
 
void notifyVideoExpose () override
 
void notifyResize (const int width, const int height) override
 
- Public Member Functions inherited from SdlGraphicsManager
 SdlGraphicsManager (SdlEventSource *source, SdlWindow *window)
 
virtual void activateManager ()
 
virtual void deactivateManager ()
 
virtual void notifyVideoExpose ()=0
 
virtual void notifyResize (const int width, const int height)
 
virtual bool notifyMousePosition (Common::Point &mouse)
 
bool showMouse (bool visible) override
 
bool lockMouse (bool lock) override
 
virtual bool saveScreenshot (const Common::Path &filename) const
 
void saveScreenshot () override
 
bool setRotationMode (Common::RotationMode rotation) override
 
bool notifyEvent (const Common::Event &event) override
 
State getState () const
 
bool setState (const State &state)
 
SdlWindow * getWindow () const
 
void initSizeHint (const Graphics::ModeList &modes) override
 
Common::Keymap * getKeymap ()
 
- Public Member Functions inherited from WindowedGraphicsManager
void showOverlay (bool inGUI) override
 
void hideOverlay () override
 
bool isOverlayVisible () const override
 
Common::Rect getSafeOverlayArea (int16 *width, int16 *height) const override
 
void setShakePos (int shakeXOffset, int shakeYOffset) override
 
int getWindowWidth () const
 
int getWindowHeight () const
 
void setIgnoreGameSafeArea (bool ignoreGameSafeArea)
 
- Public Member Functions inherited from GraphicsManager
virtual bool hasFeature (OSystem::Feature f) const =0
 
virtual void setFeatureState (OSystem::Feature f, bool enable)=0
 
virtual bool getFeatureState (OSystem::Feature f) const =0
 
virtual const OSystem::GraphicsMode * getSupportedGraphicsModes () const
 
virtual int getDefaultGraphicsMode () const
 
virtual bool setGraphicsMode (int mode, uint flags=OSystem::kGfxModeNoFlags)
 
virtual int getGraphicsMode () const
 
virtual bool setShader (const Common::Path &fileName)
 
virtual const OSystem::GraphicsMode * getSupportedStretchModes () const
 
virtual int getDefaultStretchMode () const
 
virtual bool setStretchMode (int mode)
 
virtual int getStretchMode () const
 
virtual bool setRotationMode (Common::RotationMode rotation)
 
virtual uint getDefaultScaler () const
 
virtual uint getDefaultScaleFactor () const
 
virtual bool setScaler (uint mode, int factor)
 
virtual uint getScaler () const
 
virtual uint getScaleFactor () const
 
virtual void initSize (uint width, uint height, const Graphics::PixelFormat *format=NULL)=0
 
virtual void initSizeHint (const Graphics::ModeList &modes)
 
virtual int getScreenChangeID () const =0
 
virtual void beginGFXTransaction ()=0
 
virtual OSystem::TransactionError endGFXTransaction ()=0
 
virtual int16 getHeight () const =0
 
virtual int16 getWidth () const =0
 
void setPalette (const byte *colors, uint start, uint num) override=0
 
void grabPalette (byte *colors, uint start, uint num) const override=0
 
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 presentBuffer ()
 
virtual void setShakePos (int shakeXOffset, int shakeYOffset)=0
 
virtual void setFocusRectangle (const Common::Rect &rect)=0
 
virtual void clearFocusRectangle ()=0
 
virtual void showOverlay (bool inGUI)=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) const =0
 
virtual void copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h)=0
 
virtual int16 getOverlayHeight () const =0
 
virtual int16 getOverlayWidth () const =0
 
virtual Common::Rect getSafeOverlayArea (int16 *width, int16 *height) const
 
virtual float getHiDPIScreenFactor () const
 
virtual bool showMouse (bool visible)=0
 
virtual void warpMouse (int x, int y)=0
 
virtual void setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format, const byte *mask, frac_t scaleX, frac_t scaleY)=0
 
virtual void setCursorPalette (const byte *colors, uint start, uint num)=0
 
virtual void displayMessageOnOSD (const Common::U32String &msg)
 
virtual void displayActivityIconOnOSD (const Graphics::Surface *icon)
 
virtual void saveScreenshot ()
 
virtual bool lockMouse (bool lock)
 
- Public Member Functions inherited from PaletteManager
virtual void setPalette (const byte *colors, uint start, uint num)=0
 
void setPalette (const Graphics::Palette &pal, uint start=0)
 
virtual void grabPalette (byte *colors, uint start, uint num) const =0
 
Graphics::Palette grabPalette (uint start, uint num)
 
- Public Member Functions inherited from Common::EventObserver
virtual bool notifyEvent (const Event &event)=0
 
virtual void notifyPoll ()
 

Additional Inherited Members

- Protected Types inherited from SurfaceSdlGraphicsManager
enum  { kTransactionNone = 0 , kTransactionActive = 1 , kTransactionRollback = 2 }
 
enum  { NUM_DIRTY_RECT = 100 , MAX_SCALING = 3 }
 
- Protected Types inherited from SdlGraphicsManager
enum  CustomEventAction {
  kActionToggleFullscreen = 100 , kActionToggleMouseCapture , kActionToggleResizableWindow , kActionSaveScreenshot ,
  kActionToggleAspectRatioCorrection , kActionToggleFilteredScaling , kActionCycleStretchMode , kActionIncreaseScaleFactor ,
  kActionDecreaseScaleFactor , kActionNextScaleFilter , kActionPreviousScaleFilter
}
 
- Protected Member Functions inherited from SurfaceSdlGraphicsManager
void setPalette (const byte *colors, uint start, uint num) override
 
void grabPalette (byte *colors, uint start, uint num) const override
 
virtual void initGraphicsSurface ()
 
Graphics::PixelFormat convertSDLPixelFormat (SDL_PixelFormat *in) const
 
bool gameNeedsAspectRatioCorrection () const override
 
int getGameRenderScale () const override
 
void handleResizeImpl (const int width, const int height) override
 
virtual void setupHardwareSize ()
 
void fixupResolutionForAspectRatio (AspectRatio desiredAspectRatio, int &width, int &height) const
 
virtual void addDirtyRect (int x, int y, int w, int h, bool inOverlay, bool realCoordinates=false)
 
virtual void drawMouse ()
 
virtual void undrawMouse ()
 
virtual void blitCursor ()
 
virtual void internUpdateScreen ()
 
virtual void updateScreen (SDL_Rect *dirtyRectList, int actualDirtyRects)
 
virtual bool loadGFXMode ()
 
virtual void unloadGFXMode ()
 
virtual bool hotswapGFXMode ()
 
virtual void setAspectRatioCorrection (bool enable)
 
void setFilteringMode (bool enable)
 
void setVSync (bool enable)
 
bool saveScreenshot (const Common::Path &filename) const override
 
virtual void setGraphicsModeIntern ()
 
virtual void getDefaultResolution (uint &w, uint &h)
 
bool canSwitchFullscreen () const override
 
- Protected Member Functions inherited from SdlGraphicsManager
Common::Rect getPreferredFullscreenResolution ()
 
bool defaultGraphicsModeConfig () const
 
void getWindowSizeFromSdl (int *width, int *height) const
 
virtual void showSystemMouseCursor (bool visible)
 
void setSystemMousePosition (const int x, const int y) override
 
void notifyActiveAreaChanged () override
 
void handleResizeImpl (const int width, const int height) override
 
virtual bool canSwitchFullscreen () const
 
- Protected Member Functions inherited from WindowedGraphicsManager
virtual bool gameNeedsAspectRatioCorrection () const =0
 
virtual void handleResizeImpl (const int width, const int height)=0
 
Common::Point convertVirtualToWindow (const int x, const int y) const
 
Common::Point convertWindowToVirtual (int x, int y) const
 
frac_t getDesiredGameAspectRatio () const
 
virtual int getGameRenderScale () const
 
virtual Insets getSafeAreaInsets () const
 
void handleResize (const int width, const int height)
 
virtual void recalculateDisplayAreas ()
 
virtual void setSystemMousePosition (const int x, const int y)=0
 
virtual void notifyActiveAreaChanged ()
 
bool showMouse (bool visible) override
 
void warpMouse (int x, int y) override
 
void setMousePosition (int x, int y)
 
- Static Protected Member Functions inherited from SurfaceSdlGraphicsManager
static AspectRatio getDesiredAspectRatio ()
 
- Protected Attributes inherited from SurfaceSdlGraphicsManager
SDL_Surface * _screen
 
Graphics::PixelFormat _screenFormat
 
Graphics::PixelFormat _cursorFormat
 
SDL_Surface * _tmpscreen
 
SDL_Surface * _tmpscreen2
 
SDL_Surface * _overlayscreen
 
bool _useOldSrc
 
Graphics::PixelFormat _overlayFormat
 
bool _isDoubleBuf
 
bool _isHwPalette
 
TransactionDetails _transactionDetails
 
VideoState _videoMode
 
VideoState _oldVideoMode
 
int _transactionMode
 
bool _displayDisabled
 
const PluginList & _scalerPlugins
 
ScalerPluginObject * _scalerPlugin
 
Scaler * _scaler
 
Scaler * _mouseScaler
 
uint _maxExtraPixels
 
uint _extraPixels
 
bool _screenIsLocked
 
Graphics::Surface _framebuffer
 
int _screenChangeCount
 
SDL_Rect _dirtyRectList [2 *NUM_DIRTY_RECT]
 
int _numDirtyRects
 
SDL_Rect _prevDirtyRectList [NUM_DIRTY_RECT]
 
int _numPrevDirtyRects
 
SDL_Rect _mouseLastRect
 
SDL_Rect _mouseNextRect
 
MousePos _mouseCurState
 
uint32 _mouseKeyColor
 
bool _disableMouseKeyColor
 
byte _mappedMouseKeyColor
 
frac_t _cursorScaleX
 
frac_t _cursorScaleY
 
bool _cursorPaletteDisabled
 
SDL_Surface * _mouseOrigSurface
 
SDL_Surface * _mouseSurface
 
int _currentShakeXOffset
 
int _currentShakeYOffset
 
SDL_Color * _currentPalette
 
uint _paletteDirtyStart
 
uint _paletteDirtyEnd
 
SDL_Color * _overlayPalette
 
bool _isInOverlayPalette
 
SDL_Color * _cursorPalette
 
Common::Mutex _graphicsMutex
 
bool _enableFocusRectDebugCode
 
bool _enableFocusRect
 
Common::Rect _focusRect
 
- Protected Attributes inherited from SdlGraphicsManager
SDL_Surface * _hwScreen
 
SdlEventSource * _eventSource
 
SdlWindow * _window
 
- Protected Attributes inherited from WindowedGraphicsManager
int _windowWidth
 
int _windowHeight
 
int _screenAlign
 
Common::RotationMode _rotationMode
 
bool _ignoreGameSafeArea
 
bool _overlayVisible
 
bool _overlayInGUI
 
int _gameScreenShakeXOffset
 
int _gameScreenShakeYOffset
 
Common::Rect _gameDrawRect
 
Common::Rect _overlayDrawRect
 
DisplayArea _activeArea
 
bool _forceRedraw
 
bool _cursorVisible
 
bool _cursorNeedsRedraw
 
bool _cursorLastInActiveArea
 
int _cursorX
 
int _cursorY
 

Member Function Documentation

◆ loadGFXMode()

bool OPGraphicsManager::loadGFXMode ( )
overridevirtual

Reimplemented from SurfaceSdlGraphicsManager.

◆ unloadGFXMode()

void OPGraphicsManager::unloadGFXMode ( )
overridevirtual

Reimplemented from SurfaceSdlGraphicsManager.

◆ showSystemMouseCursor()

void OPGraphicsManager::showSystemMouseCursor ( bool  visible)
overridevirtual

Reimplemented from SdlGraphicsManager.

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